Skip to main content
GET
/
v1
/
ai
/
jobs
/
{jobId}
Get AI job status
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/ai/jobs/{jobId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "state": "QUEUED",
  "prompt": "What are the top 5 products by revenue?",
  "conversationId": "660e8400-e29b-41d4-a716-446655440001",
  "modelId": "770e8400-e29b-41d4-a716-446655440002",
  "branchId": null,
  "organizationId": "880e8400-e29b-41d4-a716-446655440003",
  "userId": "990e8400-e29b-41d4-a716-446655440004",
  "topicName": null,
  "omniChatUrl": "https://my-org.omni.co/chat/660e8400-e29b-41d4-a716-446655440001",
  "createdAt": "2025-01-15T10:00:00.000Z",
  "updatedAt": "2025-01-15T10:00:00.000Z"
}

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 status retrieved successfully

​
id
string<uuid>

The unique identifier for this job.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
state
enum<string>

Current state of the job. Terminal states are COMPLETE, FAILED, and CANCELLED. Poll until the job reaches a terminal state.

Available options:
CANCELLED,
COMPLETE,
DELIVERING,
EXECUTING,
FAILED,
QUEUED
Example:

"QUEUED"

​
prompt
string

The natural language prompt that was submitted.

Example:

"What are the top 5 products by revenue?"

​
conversationId
string<uuid>

The conversation this job is associated with. Use this to submit follow-up jobs in the same conversation thread.

Example:

"660e8400-e29b-41d4-a716-446655440001"

​
modelId
string<uuid> | null

The shared model ID used for query generation.

Example:

"770e8400-e29b-41d4-a716-446655440002"

​
branchId
string<uuid> | null

Branch ID used for model context, or null if querying the main shared model.

​
organizationId
string<uuid>

The organization that owns this job.

Example:

"880e8400-e29b-41d4-a716-446655440003"

​
userId
string<uuid>

The user ID who created (or is associated with) this job.

Example:

"990e8400-e29b-41d4-a716-446655440004"

​
topicName
string | null

Topic name used to scope query generation, or null if the AI selected the topic automatically.

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://blobsrus.omni.co/chat/660e8400-e29b-41d4-a716-446655440001"

​
progress
object

Only present in EXECUTING state. Real-time progress information. Null if no progress has been reported yet. Updated in real-time as the AI works through iterations.

​
resultSummary
string

Only present in COMPLETE state. Markdown-formatted summary of the job result. For the full result with query details and data, use the Stream AI job results endpoint.

Example:

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

​
error
object

Only present in FAILED state. Error details explaining why the job failed.

​
createdAt
string<date-time>

When the job was submitted.

Example:

"2025-01-15T10:00:00.000Z"

​
executionStartedAt
string<date-time>

When execution began. Present once the job transitions from QUEUED to EXECUTING. May be absent on jobs that failed or were cancelled before execution started.

Example:

"2025-01-15T10:00:05.000Z"

​
completedAt
string<date-time>

Present in COMPLETE and FAILED states. When the job finished (successfully or with error).

Example:

"2025-01-15T10:01:30.000Z"

​
cancelledAt
string<date-time>

When the job was cancelled.

Example:

"2025-01-15T10:00:12.000Z"

​
cancelledBy
string<uuid>

Only present in CANCELLED state. User ID of who cancelled the job.

Example:

"990e8400-e29b-41d4-a716-446655440004"

​
updatedAt
string<date-time>

When the job record was last modified.

Example:

"2025-01-15T10:00:05.000Z"