Skip to content

Operations

List the Operation Runs of the instance, newest first

Section titled “List the Operation Runs of the instance, newest first”

GET /api/v1/operations/runs

Operation
operations.list_runs
Accepts
sessionCookie, sessionToken, accessToken
Scope
governance:read
Rights
audit.view
Effect
reading
Rate class
read

Parameters

  • limit integer in query, optional, default 50, minimum 1, maximum 200
  • cursor string in query, optional, minLength 1
  • operation string in query, optional, minLength 1
  • status OperationRunStatus in query, optional
  • actor string in query, optional, minLength 1
  • origin "agent" | "user" | "cli" | "mcp" | "app" | "workflow" | "schedule" in query, optional
  • workspaceId string in query, optional, minLength 1
  • since Timestamp in query, optional

Answers

  • 200 One page of the list

    application/json: object

    • items array of OperationRun required
    • nextCursor string optional
  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Read one Operation Run: your own, or any with the right to view the audit log

Section titled “Read one Operation Run: your own, or any with the right to view the audit log”

GET /api/v1/operations/runs/{runId}

Operation
operations.get_run
Accepts
sessionCookie, sessionToken, accessToken
Scope
governance:read
Effect
reading
Rate class
read

Parameters

  • runId string in path, required

Answers

  • 200 The result

    application/json: OperationRun

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.