Sadiq

Retrieve Deep Research Job

Returns a background deep research job. result holds the report once status is completed; incomplete means a content filter stopped it.<br/><br/>With stream=true, returns the job's events as Server-Sent Events, each with an id:. data: [DONE] ends the job; if a response ends without it, reconnect with starting_after=<last id> to resume. Jobs are kept for 24 hours after they end.<br/><br/>This endpoint requires additional authorization and is not allowed by default. Please contact <a href='mailto:support@fanar.qa'>support@fanar.qa</a>.

get/v1/sadiq/deep-research/{job_id}

Request

  • Base URL: https://api.fanar.qa (the document declares no server; this is the origin it was published from)
  • URL: https://api.fanar.qa/v1/sadiq/deep-research/{job_id}
  • Auth: HTTP bearer

Path parameters

job_idstring required

Query parameters

streamboolean

Return the job's events as Server-Sent Events instead of the job object.

starting_afterstring nullable

With stream=true: resume after this event id (the last id: you received).

Headers

Last-Event-IDstring nullable

The standard SSE resume header; starting_after takes precedence.

Response

The job (JSON), or with stream=true its events (SSE).

idstring required

The job id. Also returned as the X-Id header on create.

object'job'
type'deep_research' required
status'queued' | 'in_progress' | 'completed' | 'failed' | 'cancelled' | 'incomplete' required

OpenAI's background-response vocabulary, verbatim.

progress_pctinteger

Research progress, 0-100. It can reach 100 while the last sentences are still being checked; only status says the job is done.

attemptinteger

How many times this job has been started. Above 1 means it was restarted after a server failure, and its events replayed from the start.

created_atinteger required
started_atinteger nullable
completed_atinteger nullable
updated_atinteger required

When the job was last updated. A running job is updated every few seconds.

cancel_source'owner' | 'admin'

Changes

No recorded changes to this operation across all 1 revision of this API.