Skip to main content
POST
/
agents
/
name
/
{agent_name}
/
rpc
Handle Agent RPC by Name
curl --request POST \
  --url https://api.example.com/agents/name/{agent_name}/rpc \
  --header 'Content-Type: application/json' \
  --data '
{
  "params": {
    "name": "<string>",
    "params": {},
    "task_metadata": {}
  },
  "jsonrpc": "2.0",
  "id": 123
}
'
{
  "result": [
    {
      "task_id": "<string>",
      "content": {
        "content": "<string>",
        "type": "text",
        "style": "static",
        "format": "plain",
        "attachments": [
          {
            "file_id": "<string>",
            "name": "<string>",
            "size": 123,
            "type": "<string>"
          }
        ]
      },
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "jsonrpc": "2.0",
  "error": null,
  "id": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
agent_name
string
required

Body

application/json
​
method
enum<string>
required
Available options:
event/send,
task/create,
message/send,
task/cancel
​
params
CreateTaskRequest · object
required

The parameters for the agent RPC request

​
jsonrpc
string
default:2.0
Allowed value: "2.0"
​
id

Response

Successful Response

​
result
TaskMessage · object
required

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

​
jsonrpc
string
default:2.0
Allowed value: "2.0"
​
error
unknown
​
id