For the complete documentation index, see llms.txt. This page is also available as Markdown.

Job Management

Operations for tracking and managing generation jobs

Get job status

get

Retrieves detailed information about a specific job including status and progress

Authorizations
AuthorizationstringRequired

JWT token for user session authentication.

Query parameters
jobIdstring · uuidRequired

ID of the job to retrieve

Responses
200

Job status retrieved successfully

application/json

Represents a content generation job with comprehensive tracking information

idstring · uuidRequired

The unique identifier for the job

Example: 987fcdeb-51a2-43d7-8f9e-123456789abc
user_idstring · uuidRequired

The ID of the user who owns the job

project_idstring · uuidRequired

The ID of the project associated with the job

statusstring · enumRequired

The current status of the job

Possible values:
progressnumber · float · max: 100Optional

The completion progress of the job (0 to 100)

Example: 75.5
progress_stagestringOptional

A textual description of the current processing stage

Example: generating_work
percent_completenumber · float · max: 100Optional

Percentage completion of the job

titlestring · nullableOptional

The title of the job/project

is_byokbooleanOptional

Whether the job uses Bring Your Own Key (user's API key)

Default: false
reasoning_modelstring · nullableOptional

The AI model used for reasoning tasks

Example: google/gemini-2.5-flash-001
writing_modelstring · nullableOptional

The AI model used for writing tasks

Example: google/gemini-2.5-flash-001
function_modelstring · nullableOptional

The AI model used for function calling

Example: google/gemini-2.5-flash-001
error_messagestring · nullableOptional

Error message if the job failed

is_starredbooleanOptional

Whether the job is starred by the user

Default: false
created_atstring · date-timeRequired

Timestamp when the job was created

updated_atstring · date-timeRequired

Timestamp when the job was last updated

get/getJobStatus

Cancel a running job

post

Cancels a job that is currently in progress or queued

Authorizations
AuthorizationstringRequired

JWT token for user session authentication.

Body
jobIdstring · uuidRequired

ID of the job to cancel

Responses
200

Job cancelled successfully

application/json
messagestringOptionalExample: Job cancelled successfully
post/cancelJob

Last updated