Sadiq

Cancel Deep Research Job

Cancels a background deep research job and returns it. Cancellation is asynchronous: poll until cancelled. A job that already ended is returned unchanged. Quota is not refunded.<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>.

post/v1/sadiq/deep-research/{job_id}/cancel

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}/cancel
  • Auth: HTTP bearer

Path parameters

job_idstring required

Response

The job as it stands after the cancel.

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.