Skip to main content
POST

Authorizations

Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Headers

Idempotency-Key
string
required
Required string length: 1 - 200
X-UI-Organization-ID
string | null

Choose an organization you belong to for scoped reads, writes, and billing. Users can belong to multiple organizations. Platform administrators may select any organization in this app.

Maximum string length: 128

Path Parameters

session_id
string<uuid>
required

Body

application/json
prompt
string
required
Minimum string length: 1
type
enum<string>
required
Available options:
report,
powerpoint,
highlights
name
string | null
Required string length: 1 - 200
template_id
string<uuid> | null
include_synthetic
boolean
default:false

Response

Successful Response

job_id
string
required
status
enum<string>
required
Available options:
pending,
running,
succeeded,
failed
completed
boolean
required

True when work has finished successfully

session_id
string<uuid>
required
poll_url
string
required
result_url
string | null

Fetch the created resource after success

total_count
integer | null

Requested participant count for a batch

error
string | null

A safe failure summary; internal details are never returned

result
HubJobResult · object | null