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.
Returns sagas, states, systems and scripting languages an agent can utilize.
Id of agent to view
OK
Id of the agent
Authorization information is missing or invalid.
User does not have the required role for access.
Server failed to process request due to internal errors.
Feature is not implemented by the server.
GET /api/request/{channel}/GetAIAgent HTTP/1.1
Host: gateway_server
Accept: */*
{
"id": "text",
"data": {
"name": "text",
"description": "text",
"states": [],
"systems": [],
"sagas": [],
"prompts": []
}
}Makes a request to a specific AI agent with a message or prompt inputs.
Id of the agent to call
translatorId of the ongoing chat with agent
123Message/request to send to agent, required if prompt is not used
Please translate the following sentence...Id of the agent prompt to be used, required if message is not used
multi_translateInput parameters which are used by the selected prompt
{"text":"Hello world","source":"enUS","targets":["frFR","ptPT"],"instructions":"Please keep it short"}OK
Response text generated by the agent
Id of the chat created/ongoing
Details of input, output and reasoning tokens used
List of tool call candidates that require user's approval before execution
Authorization information is missing or invalid.
User does not have the required role for access.
Server failed to process request due to internal errors.
Feature is not implemented by the server.
POST /api/request/{channel}/CallAIAgent HTTP/1.1
Host: gateway_server
Content-Type: application/json
Accept: */*
Content-Length: 598
{
"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": {
"toolCandidates": [
{
"toolCall": {
"id": "text"
},
"status": "APPROVED",
"deniedReason": "text"
}
],
"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",
"tokenUsage": {},
"toolCandidates": []
}Makes the same request to a list of AI agents and collects responses from all.
Message/request to send to agent, required if prompt is not used
Please translate the following sentence...Id of the agent prompt to be used, required if message is not used
multi_translateInput parameters which are used by the selected prompt
{"text":"Hello world","source":"enUS","targets":["frFR","ptPT"],"instructions":"Please keep it short"}OK
Authorization information is missing or invalid.
User does not have the required role for access.
Server failed to process request due to internal errors.
Feature is not implemented by the server.
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": []
}Makes a request to a specific AI agent to summarize current messages in a given chat.
Id of the agent to call
translatorId of the ongoing chat with agent
123OK
Response summary generated by the agent
Id of the chat created/ongoing
Authorization information is missing or invalid.
User does not have the required role for access.
Server failed to process request due to internal errors.
Feature is not implemented by the server.
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"
}Submits a positive or negative feedback for an AI response.
Id of the rated chat
123Id of the agent message to rate
123User rating (typically -1 for negative, 1 for positive)
1OK
Authorization information is missing or invalid.
User does not have the required role for access.
Server failed to process request due to internal errors.
Feature is not implemented by the server.
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
}{}Last updated