SnozeDevelopers
API referenceAi Jobs

Pause a background AI job

Stops the job from starting new parts; a part already running stops within a few seconds and goes back to the queue without being charged again. Only a queued or running job can be paused. Requires a Clerk session for the job's owner with the `ai:write` permission. Send an `Idempotency-Key` header to make retries safe.

POST
/v1/workspaces/{workspaceId}/agent/jobs/{jobId}/pause

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Path Parameters

workspaceId*string
jobId*string

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.snoze.dev/v1/workspaces/string/agent/jobs/string/pause'
Example Response
{  "data": {    "id": "string",    "workspaceId": "string",    "chatId": "string",    "kind": "records",    "status": "queued",    "statusReason": "person",    "title": "string",    "estimateMicrousd": 0,    "ceilingMicrousd": 0,    "spentMicrousd": 0,    "waivedMicrousd": 0,    "totalUnits": 0,    "doneUnits": 0,    "failedUnits": 0,    "rowsWritten": 0,    "summary": {      "unitsDone": 0,      "unitsFailed": 0,      "unitsCancelled": 0,      "rowsWritten": 0,      "rowsSkipped": 0,      "spentMicrousd": 0,      "waivedMicrousd": 0,      "durationMs": 0    },    "lastError": "string",    "createdAt": "string",    "updatedAt": "string",    "startedAt": "string",    "finishedAt": "string"  }}