> ## 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.
## Submitting Feedback
If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:
POST https://docs.omni.co/feedback
```json
{
"path": "/api/ai/stream-ai-job-results",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# Stream AI job results
> Retrieve the full result of a completed AI job, including all actions taken by the AI (queries generated, data retrieved) and the final summarized answer.
Results are only available for jobs in `COMPLETE` state and are retained for 14 days after completion. The response is streamed directly from storage.
## OpenAPI
````yaml /api/openapi.yaml get /v1/ai/jobs/{jobId}/result
openapi: 3.1.0
info:
title: Omni API
description: >
The Omni REST API provides programmatic access to your Omni instance for
managing users, documents, queries, schedules, and more.
version: 1.0.0
contact:
name: Omni Support
url: https://docs.omni.co
servers:
- url: https://{instance}.omniapp.co/api
description: Production
variables:
instance:
default: blobsrus
description: Your production Omni instance subdomain
- url: https://{instance}.playground.exploreomni.dev/api
description: Playground
variables:
instance:
default: blobsrus
description: Your playground Omni instance subdomain
security:
- bearerAuth: []
- orgApiKey: []
tags:
- name: AI
description: AI-powered query generation
- name: API Tokens
description: >-
Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
grants)
- name: Connections
description: Manage database connections
- name: Connection environments
description: Manage connection environments database connections
- name: Content
description: Unified content retrieval (documents and folders)
- name: Content migration
description: Export and import dashboards
- name: Content validator
description: Validate content against models and perform find/replace operations
- name: Dashboard downloads
description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
- name: Dashboard filters and controls
description: Read and update dashboard filter and control default values
- name: dbt
description: Manage dbt configuration for connections
- name: Documents
description: Create, retrieve, and manage documents
- name: Document favorites
description: Favorite and unfavorite documents
- name: Document labels
description: Apply and manage labels on documents
- name: Document permissions
description: Manage document-level access
- name: Labels
description: >
Manage labels in an organization. Labels can be applied to documents and
folders to help organize and categorize content.
**Label types:**
- **Basic labels**: Can be created and managed by any user
- **Verified labels**: Indicate curated or officially sanctioned content.
Admin-only.
- **Homepage labels**: Appear on the organization homepage. Admin-only.
- name: Folders
description: Create and organize content folders
- name: Folder permissions
description: Manage folder-level access
- name: Jobs
description: Check status of asynchronous jobs
- name: Models
description: Create and manage data models
- name: Model branches
description: Manage model branches and merge changes
- name: Model git configuration
description: Manage git configuration for shared models
- name: Queries
description: Execute workbook queries
- name: Schedules
description: Create and manage scheduled tasks
- name: Schedule recipients
description: Manage schedule recipients
- name: Schema refresh schedules
description: Manage automated schema refresh schedules for connections
- name: Topics
description: Retrieve topic information from models
- name: Uploads
description: Manage file uploads
- name: Users
description: Manage users
- name: User attributes
description: Manage user attribute definitions
- name: User groups
description: Manage user groups
- name: User model roles
description: Manage model and connection role assignments for users
- name: User group model roles
description: Manage model and connection role assignments for user groups
- name: Uploads
description: Manage CSV and spreadsheet uploads
paths:
/v1/ai/jobs/{jobId}/result:
get:
tags:
- AI
summary: Stream AI job results
description: >
Retrieve the full result of a completed AI job, including all actions
taken by the AI (queries generated, data retrieved) and the final
summarized answer.
Results are only available for jobs in `COMPLETE` state and are retained
for 14 days after completion. The response is streamed directly from
storage.
operationId: getAIJobResult
parameters:
- name: jobId
in: path
required: true
schema:
type: string
format: uuid
description: The unique identifier of the AI job
responses:
'200':
description: Job results retrieved successfully
content:
application/json:
schema:
type: object
properties:
actions:
type: array
description: >-
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.
items:
type: object
required:
- message
- timestamp
- type
properties:
type:
type: string
description: >-
The type of action. Common types include
`generate_query` (query generation and execution)
and `summarize` (final answer synthesis).
example: generate_query
message:
type: string
description: >-
The AI's explanation of what it is doing in this
step, written in natural language.
example: >-
I'll generate a query to find the top 5 products by
total revenue.
timestamp:
type: string
description: ISO 8601 timestamp when this action occurred.
example: '2025-01-15T10:00:10.000Z'
result:
type: object
description: >-
Query result data. Only present for `generate_query`
action types.
required:
- csvResult
- csvResultWasTruncated
- hasResults
- query
- queryName
- status
- totalRowCount
properties:
queryName:
type: string
description: >-
Human-readable name describing what this query
retrieves.
example: Top 5 Products by Revenue
status:
type: string
enum:
- success
- error
description: Whether the query executed successfully.
example: success
query:
type: object
description: >-
The semantic query definition that was executed.
This can be used with the [Run query
endpoint](/api/queries/run-query) to re-run the
query.
csvResult:
type: string
description: Query results formatted as CSV text.
example: |-
Name,Total Revenue
Ray-Ban Sunglasses,"678,994.41"
Levi's 501 Jeans,"475,072.00"
csvResultWasTruncated:
type: boolean
description: >-
Whether the CSV data was truncated due to size
limits. If `true`, the full result set may
contain additional rows not included in
`csvResult`.
example: false
hasResults:
type: boolean
description: Whether the query returned any data rows.
example: true
totalRowCount:
type: integer
description: Total number of rows returned by the query.
example: 5
message:
type: string
description: >-
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
1. **Sunglasses** - $678,994
2. **Jeans** - $475,072
resultSummary:
type: string
description: >-
Summary of the job result. Typically matches the final
message content.
example: |-
### Top 5 Products by Revenue
1. **Sunglasses** - $678,994
2. **Jeans** - $475,072
topic:
type: string
description: The topic name used for query generation.
example: order_items
omniChatUrl:
type: string
format: uri
description: >-
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
'400':
description: |
Bad Request
Possible error messages:
- `Invalid job ID`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: |
Unauthorized
Possible error messages:
- `Missing or invalid API key`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: |
Job not found or results not available
Possible error messages:
- `Job not found`
- `Job results not yet available`
- `Result is no longer available`. Results are retained for 14 days.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
security:
- bearerAuth: []
components:
schemas:
Error:
type: object
properties:
error:
type: string
description: HTTP response code for the error
example:
message:
type: string
description: Detailed error description
example:
responses:
TooManyRequests:
description: Too Many Requests - Rate limit exceeded (60 requests/minute)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
InternalServerError:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >
Can be either an [Organization API
Key](/api/authentication#organization-api-keys) or [Personal Access
Token (PAT)](/api/authentication#personal-access-tokens-pat).
Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
orgApiKey:
type: http
scheme: bearer
bearerFormat: JWT
description: >
Requires an [Organization API
Key](/api/authentication#organization-api-keys). Personal Access Tokens
(PATs) are not supported for this endpoint.
Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`
````