copilotScheduledJobs

Requires permission catalog:copilot:chat.

The caller's own scheduled copilot jobs. Org + user scoped.

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 CopilotScheduledJobs {
  copilotScheduledJobs {
    id
    name
    status
    createdAt
    cron
    lastError
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CopilotScheduledJobs {\n  copilotScheduledJobs {\n    id\n    name\n    status\n    createdAt\n    cron\n    lastError\n  }\n}"
}
EOF

Response:

{
  "data": {
    "copilotScheduledJobs": [
      {
        "id": "id",
        "name": "string",
        "status": "ACTIVE",
        "createdAt": 0,
        "cron": "string",
        "lastError": "string"
      }
    ]
  }
}

copilotScheduledJobs: [CopilotScheduledJobType!]!

Type

CopilotScheduledJobType object

A prompt the copilot runs on a schedule.