Skip to main content
GET
/
v1
/
orchestrations
/
{orchestrationId}
Get Orchestration
curl --request GET \
  --url https://api.truthlocks.com/v1/orchestrations/{orchestrationId} \
  --header 'X-API-Key: <api-key>'
{
  "orchestration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agents": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "parameters": {},
  "status": "pending",
  "steps": [
    {
      "step_id": "<string>",
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "action": "<string>",
      "status": "<string>",
      "result": {},
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "results": {},
  "receipts": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "created_at": "2023-11-07T05:31:56Z"
}
Returns the complete execution state of an orchestration, including its current status, every step executed, the final output, accumulated cost, and the transparency-log receipt once completed. Poll this endpoint to track orchestration progress. For real-time updates, configure a webhook for orchestration.completed and orchestration.failed events.

​
Authentication

​
X-API-Key
string
required
API key with orchestrations:read scope. Alternatively, pass a Bearer JWT token in the Authorization header.
​
X-Tenant-ID
string
required
Tenant identifier for multi-tenant isolation.

​
Path Parameters

​
id
string
required
Orchestration identifier (maip-orch:ULID).

​
Response

​
id
string
Orchestration identifier.
​
agent_id
string
The agent that executed the orchestration.
​
workflow_id
string
The workflow definition identifier, if applicable.
​
status
string
Current status: running, completed, failed, or timeout.
​
steps
array
Ordered array of execution steps. Each step contains: - step_number (integer) — Sequential step index (1-based) - action (string) — Action performed (e.g. llm_inference, tool_call, decision, guardrail_check) - result (string) — Step outcome summary - duration_ms (integer) — Step execution time in milliseconds
​
output
object
Final orchestration output. Present only when status is completed.
​
total_cost_cents
number
Total accumulated cost of all LLM inferences and tool calls in US cents.
​
receipt_id
string
Transparency-log receipt anchoring the completed orchestration. Present only when status is completed.
​
started_at
string
ISO 8601 timestamp when execution began.
​
completed_at
string
ISO 8601 timestamp when execution finished. Present only for terminal states.
​
error
object
Error details if status is failed. Contains code and message.

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Path Parameters

​
orchestrationId
string<uuid>
required

Orchestration identifier

Response

Orchestration details

​
orchestration_id
string<uuid>
​
workflow_id
string<uuid>
​
agents
string<uuid>[]
​
parameters
object
​
status
enum<string>
Available options:
pending,
running,
completed,
failed,
cancelled
​
steps
object[]
​
results
object
​
receipts
string<uuid>[]
​
created_at
string<date-time>