Skip to main content
POST

Authorizations

Authorization
string
header
required

Organization API key passed as a Bearer token. This is the scheme used by the public SDK surface.

Query Parameters

worksheet_id
string

Worksheet ID. Required if organization_id is not provided.

organization_id
string<uuid>

Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint.

Body

application/json

Serializer for creating worksheet queries.

query
string
required
Minimum string length: 1
worksheet_id
string<uuid> | null

Worksheet ID to associate with the query

use_admin
boolean
default:false

Whether to use admin privileges

Response

Query object

id
string<uuid>
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
finished_at
string<date-time> | null
required
read-only
query
string
required
query_task_id
string | null
required
read-only
query_task_status
string | null
required
read-only
error
string | null
required
read-only
ai_summary
string | null
required
read-only
worksheet
object
organization
object

Simple organization serializer for nested use.

creator
object | null