runCopilotScheduledJobNow

Requires permission catalog:copilot:chat.

Queues an immediate run of one of the caller's own scheduled copilot tasks, even when it is paused, and returns it marked as queued. Limited to 10 requests a minute. Needs the catalog copilot feature on the plan and permission to chat with the copilot.

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

mutation RunCopilotScheduledJobNow($id: ID!) {
  runCopilotScheduledJobNow(id: $id) {
    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": "mutation RunCopilotScheduledJobNow($id: ID!) {\n  runCopilotScheduledJobNow(id: $id) {\n    id\n    name\n    status\n    createdAt\n    cron\n    lastError\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "runCopilotScheduledJobNow": {
      "id": "id",
      "name": "string",
      "status": "ACTIVE",
      "createdAt": 0,
      "cron": "string",
      "lastError": "string"
    }
  }
}

runCopilotScheduledJobNow(
  id: ID!
): CopilotScheduledJobType!

Arguments

runCopilotScheduledJobNow.id ● ID! non-null scalar

The ID of the scheduled task.

Type

CopilotScheduledJobType object

A prompt the copilot runs on a schedule.