Skip to main content
GET
/
v1
/
ai
/
jobs
/
{jobId}
/
result
Stream AI job results
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/ai/jobs/{jobId}/result \
  --header 'Authorization: Bearer <token>'
{
  "actions": [
    {
      "type": "generate_query",
      "message": "I'll generate a query to find the top 5 products by total revenue.",
      "timestamp": "2025-01-15T10:00:10.000Z",
      "result": {
        "queryName": "Top 5 Products by Revenue",
        "status": "success",
        "query": {},
        "csvResult": "Name,Total Revenue\nRay-Ban Sunglasses,\"678,994.41\"\nLevi's 501 Jeans,\"475,072.00\"",
        "csvResultWasTruncated": false,
        "hasResults": true,
        "totalRowCount": 5
      }
    }
  ],
  "message": "### Top 5 Products by Revenue\n\n1. **Sunglasses** - $678,994\n2. **Jeans** - $475,072",
  "resultSummary": "### Top 5 Products by Revenue\n\n1. **Sunglasses** - $678,994\n2. **Jeans** - $475,072",
  "topic": "order_items",
  "omniChatUrl": "https://my-org.omni.co/chat/660e8400-e29b-41d4-a716-446655440001"
}

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

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

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
jobId
string<uuid>
required

The unique identifier of the AI job

Response

Job results retrieved successfully

​
actions
object[]

Ordered list of actions the AI took during execution. Each action represents a step such as generating a query, executing it, or synthesizing a final answer.

​
message
string

The AI's final response message in Markdown format. This is the complete answer to the original prompt, incorporating data from all executed queries.

Example:

"### Top 5 Products by Revenue\n\n1. **Sunglasses** - $678,994\n2. **Jeans** - $475,072"

​
resultSummary
string

Summary of the job result. Typically matches the final message content.

Example:

"### Top 5 Products by Revenue\n\n1. **Sunglasses** - $678,994\n2. **Jeans** - $475,072"

​
topic
string

The topic name used for query generation.

Example:

"order_items"

​
omniChatUrl
string<uri>

URL to view this conversation in the Omni chat interface. Opens the chat session where the job actions and results are visible.

Example:

"https://my-org.omni.co/chat/660e8400-e29b-41d4-a716-446655440001"