AI Agent APIs

All AI agents configured on Rierino are automatically accessible as APIs and can be incorporated into any app for visual interaction

All runners which include GenAI base runner and have GenAI models assigned to them can service the following common APIs for describing and interacting with agents.

Gets detailed view of AI agent capabilities

get

Returns sagas, states, systems and scripting languages an agent can utilize.

Query parameters

idstringOptional

Id of agent to view

Responses

200

OK

application/json

idstringOptional

Id of the agent

401

Authorization information is missing or invalid.

403

User does not have the required role for access.

500

Server failed to process request due to internal errors.

501

Feature is not implemented by the server.

get

/api/request/{channel}/GetAIAgent

HTTPcURLJavaScriptPython

GET /api/request/{channel}/GetAIAgent HTTP/1.1
Host: gateway_server
Accept: */*

{
  "id": "text",
  "data": {
    "name": "text",
    "description": "text",
    "states": [],
    "systems": [],
    "sagas": [],
    "prompts": []
  }
}

Calls an AI agent

post

Makes a request to a specific AI agent with a message or prompt inputs.

Body

application/json

agentstringOptional

Id of the agent to call

Example: translator

chatstringOptional

Id of the ongoing chat with agent

Example: 123

messagestringOptional

Message/request to send to agent, required if prompt is not used

Example: Please translate the following sentence...

promptstringOptional

Id of the agent prompt to be used, required if message is not used

Example: multi_translate

inputobjectOptional

Input parameters which are used by the selected prompt

Example: {"text":"Hello world","source":"enUS","targets":["frFR","ptPT"],"instructions":"Please keep it short"}

Responses

200

OK

application/json

responsestringOptional

Response text generated by the agent

chatstringOptional

Id of the chat created/ongoing

401

Authorization information is missing or invalid.

403

User does not have the required role for access.

500

Server failed to process request due to internal errors.

501

Feature is not implemented by the server.

post

/api/request/{channel}/CallAIAgent

HTTPcURLJavaScriptPython

POST /api/request/{channel}/CallAIAgent HTTP/1.1
Host: gateway_server
Content-Type: application/json
Accept: */*
Content-Length: 510

{
  "agent": "translator",
  "chat": "123",
  "message": "Please translate the following sentence...",
  "prompt": "multi_translate",
  "input": {
    "text": "Hello world",
    "source": "enUS",
    "targets": [
      "frFR",
      "ptPT"
    ],
    "instructions": "Please keep it short"
  },
  "request": {
    "responseFormat": {
      "type": "TEXT",
      "jsonSchema": "text",
      "schemaName": "text",
      "strict": true
    },
    "model": "gpt-4.1",
    "temperature": 0.7,
    "topP": 0.9,
    "maxTokens": 1024,
    "maxCompletionTokens": 2048,
    "frequencyPenalty": 0.2,
    "presencePenalty": 0.1,
    "stopSequences": [
      "\nUser:",
      "END"
    ],
    "seed": 12345
  }
}

{
  "response": "text",
  "chat": "text"
}

Calls a 'panel' of AI agents

post

Makes the same request to a list of AI agents and collects responses from all.

Body

application/json

messagestringOptional

Message/request to send to agent, required if prompt is not used

Example: Please translate the following sentence...

promptstringOptional

Id of the agent prompt to be used, required if message is not used

Example: multi_translate

inputobjectOptional

Input parameters which are used by the selected prompt

Example: {"text":"Hello world","source":"enUS","targets":["frFR","ptPT"],"instructions":"Please keep it short"}

Responses

200

OK

application/json

401

Authorization information is missing or invalid.

403

User does not have the required role for access.

500

Server failed to process request due to internal errors.

501

Feature is not implemented by the server.

post

/api/request/{channel}/CallAIPanel

HTTPcURLJavaScriptPython

POST /api/request/{channel}/CallAIPanel HTTP/1.1
Host: gateway_server
Content-Type: application/json
Accept: */*
Content-Length: 245

{
  "panel": [
    {
      "agent": "text",
      "weight": 1,
      "chat": "123"
    }
  ],
  "message": "Please translate the following sentence...",
  "prompt": "multi_translate",
  "input": {
    "text": "Hello world",
    "source": "enUS",
    "targets": [
      "frFR",
      "ptPT"
    ],
    "instructions": "Please keep it short"
  }
}

{
  "list": []
}

Summarizes an AI chat

post

Makes a request to a specific AI agent to summarize current messages in a given chat.

Body

application/json

agentstringOptional

Id of the agent to call

Example: translator

chatstringOptional

Id of the ongoing chat with agent

Example: 123

Responses

200

OK

application/json

responsestringOptional

Response summary generated by the agent

chatstringOptional

Id of the chat created/ongoing

401

Authorization information is missing or invalid.

403

User does not have the required role for access.

500

Server failed to process request due to internal errors.

501

Feature is not implemented by the server.

post

/api/request/{channel}/SummarizeAIChat

HTTPcURLJavaScriptPython

POST /api/request/{channel}/SummarizeAIChat HTTP/1.1
Host: gateway_server
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "agent": "translator",
  "chat": "123"
}

{
  "response": "text",
  "chat": "text"
}

Rates a message from AI agent

post

Submits a positive or negative feedback for an AI response.

Body

application/json

chatstringOptional

Id of the rated chat

Example: 123

responseIdstringOptional

Id of the agent message to rate

Example: 123

ratingnumberOptional

User rating (typically -1 for negative, 1 for positive)

Example: 1

Responses

200

OK

application/json

objectOptional

401

Authorization information is missing or invalid.

403

User does not have the required role for access.

500

Server failed to process request due to internal errors.

501

Feature is not implemented by the server.

post

/api/request/{channel}/RateAIMessage

HTTPcURLJavaScriptPython

POST /api/request/{channel}/RateAIMessage HTTP/1.1
Host: gateway_server
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "chat": "123",
  "responseId": "123",
  "rating": 1
}

{}