Cancel a running job

POST

/jobs/{jobId}/cancel

curl --request POST \
  --url https://firma.company-gpt.com/companygpt/rag/api/jobs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel \
  --header 'Authorization: Bearer <token>'

• CompanyGPT instance

Signals the worker to stop a running job and marks it as cancelled. Only valid while the job is ‘running’.

Authorizations

• BearerAuth

Parameters

Path Parameters

jobId

required

string format: uuid

Job UUID

Responses

200

Cancellation signalled

Media typeapplication/json

Generic status acknowledgement returned by several action endpoints

object

status

required

string

Example^generated

{
  "status": "example"
}

400

Invalid job ID

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

404

Job not found

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

409

Job is not running

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}