Get an Omni agent run
curl --request GET \
--url https://omnicommerce.sg/api/v1/agents/general/runs/{runId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://omnicommerce.sg/api/v1/agents/general/runs/{runId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/v1/agents/general/runs/{runId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"run_id": "<string>",
"thread_id": "<string>",
"status": "queued",
"messages": [
{
"type": "human",
"role": "user",
"content": "<string>",
"id": "<string>",
"name": "<string>",
"tool_calls": [
{
"name": "<string>",
"args": "<unknown>",
"id": "<string>"
}
],
"tool_call_id": "<string>"
}
],
"structured_output": {},
"approvals": [
{
"interrupt_instance_id": "<string>",
"tool_name": "<string>",
"tool_args": "<unknown>",
"message": "<string>"
}
],
"error": "<string>"
}Agents
Get an Omni agent run
Read a queued, running, completed, paused, or failed Omni agent run. Requires agents:invoke.
GET
/
api
/
v1
/
agents
/
general
/
runs
/
{runId}
Get an Omni agent run
curl --request GET \
--url https://omnicommerce.sg/api/v1/agents/general/runs/{runId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://omnicommerce.sg/api/v1/agents/general/runs/{runId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/v1/agents/general/runs/{runId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"run_id": "<string>",
"thread_id": "<string>",
"status": "queued",
"messages": [
{
"type": "human",
"role": "user",
"content": "<string>",
"id": "<string>",
"name": "<string>",
"tool_calls": [
{
"name": "<string>",
"args": "<unknown>",
"id": "<string>"
}
],
"tool_call_id": "<string>"
}
],
"structured_output": {},
"approvals": [
{
"interrupt_instance_id": "<string>",
"tool_name": "<string>",
"tool_args": "<unknown>",
"message": "<string>"
}
],
"error": "<string>"
}Authorizations
Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.
Path Parameters
Query Parameters
Required for session auth. Optional for API keys, which already belong to one organization.
Maximum string length:
120Response
The agent run.
Available options:
queued, running, completed, awaiting_approval, failed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes