copilotJob

Requires permission catalog:copilot:chat.

Poll a parse/apply/images job.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query CopilotJob($jobId: ID!) {
  copilotJob(jobId: $jobId) {
    status
    error
    jobId
    kind
    progress
    report
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CopilotJob($jobId: ID!) {\n  copilotJob(jobId: $jobId) {\n    status\n    error\n    jobId\n    kind\n    progress\n    report\n  }\n}",
  "variables": {
    "jobId": "id"
  }
}
EOF

Variables:

{
  "jobId": "id"
}

Response:

{
  "data": {
    "copilotJob": {
      "status": "COMPLETED",
      "error": "string",
      "jobId": "id",
      "kind": "APPLY",
      "progress": {},
      "report": {}
    }
  }
}

copilotJob(
  jobId: ID!
): CopilotJob!

Arguments

copilotJob.jobId ● ID! non-null scalar

The ID of the Copilot job.

Type

CopilotJob object

A background job started by the copilot.