Documentation menu

Operation Invocations

2 operations.

MethodEndpointDescription
GET/api/v1/operation-invocationsList operation invocations
GET/api/v1/operation-invocations/{invocationId}/resultGet an operation invocation result

List operation invocations

GET /api/v1/operation-invocations

List operation invocation status and metadata. Failed executions include a safe diagnostic code, message, retryability, and definition field when known. SQL and input values are never included.

Parameters

query

NameTypeRequiredDescription
projectIdstringoptionalFilters results to the specified Project. Applies to List operation invocations.
environmentIdstringoptionalSelects the active Project environment coordinate. Applies to List operation invocations.
agentIdstringoptionalSelects the Project Agent by its stable identifier. Applies to List operation invocations.
status"queued" | "running" | "success" | "domain-failure" | "infra-failure" | "awaiting-approval" | "approval-rejected" | "skipped" | "denied" | "expired"optionalFilters results to the requested status. Applies to List operation invocations.
requestKeystringoptionalCorrelates operation invocations with the originating request. Applies to List operation invocations.
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List operation invocations.
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List operation invocations.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — operationInvocations: array<object> (required); pagination: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)

Get an operation invocation result

GET /api/v1/operation-invocations/{invocationId}/result

Read the committed Command result for the invocation using the issuing principal and optional actor personalization; this endpoint never dispatches work. Invocation history is projected asynchronously from the runtime, so an invocation becomes readable here shortly after it commits and returns 404 until then.

Parameters

path

NameTypeRequiredDescription
invocationIdstringrequiredIdentifies the operation invocation whose committed result is being read. Applies to Get an operation invocation result.

query

NameTypeRequiredDescription
actorUserIdstringoptionalSelects the external actor whose personalized Workflow authorization is being checked. Applies to Get an operation invocation result.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)