API Reference
Get an agent run
Returns the run status and the AG-UI events stored so far. status is running, finished, error, or cancelled. See Agents.
GET
/
v1
/
agent
/
{agent_id}
/
runs
/
{run_id}
Get an agent run
curl --request GET \
--url https://api.synapsai.cloud/v1/agent/{agent_id}/runs/{run_id}import requests
url = "https://api.synapsai.cloud/v1/agent/{agent_id}/runs/{run_id}"
response = requests.get(url)
print(response.text){
"id": "<string>",
"object": "agent.run",
"agent_id": "<string>",
"thread_id": "<string>",
"status": "running",
"events": [
{
"seq": 123,
"type": "<string>"
}
],
"error_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z"
}Response
Agent run
Available options:
agent.run Available options:
running, finished, error, cancelled Show child attributes
Show child attributes
⌘I
Get an agent run
curl --request GET \
--url https://api.synapsai.cloud/v1/agent/{agent_id}/runs/{run_id}import requests
url = "https://api.synapsai.cloud/v1/agent/{agent_id}/runs/{run_id}"
response = requests.get(url)
print(response.text){
"id": "<string>",
"object": "agent.run",
"agent_id": "<string>",
"thread_id": "<string>",
"status": "running",
"events": [
{
"seq": 123,
"type": "<string>"
}
],
"error_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z"
}