Jobs

Get a job

Poll this endpoint to check the status of an async operation.

get/workspaces/{workspace_id}/jobs/{job_id}

Request

  • Base URL: https://api.compelling.ai/v1
  • URL: https://api.compelling.ai/v1/workspaces/{workspace_id}/jobs/{job_id}
  • Auth: HTTP bearer

Response

OK

job_idstring
status'pending' | 'running' | 'complete' | 'failed'
type'contact_generation' | 'account_insight_answers' | 'contact_insight_answers' | 'workflow_run'
list_idstring
errorstring nullable

Error message if status is failed.

resultobject nullable

Summary or result data when status is complete.

created_atstring date-time
updated_atstring date-time

Example response

{
  "job_id": "job_01HX",
  "status": "running",
  "type": "contact_generation",
  "list_id": "lst_01HX"
}

Changes

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