> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Orchestration
> Retrieve the full execution result of an orchestration, including step-level details and cost tracking.
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
API key with `orchestrations:read` scope. Alternatively, pass a Bearer JWT
token in the `Authorization` header.
Tenant identifier for multi-tenant isolation.
### Path Parameters
Orchestration identifier (`maip-orch:ULID`).
### Response
Orchestration identifier.
The agent that executed the orchestration.
The workflow definition identifier, if applicable.
Current status: `running`, `completed`, `failed`, or `timeout`.
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
Final orchestration output. Present only when status is `completed`.
Total accumulated cost of all LLM inferences and tool calls in US cents.
Transparency-log receipt anchoring the completed orchestration. Present only
when status is `completed`.
ISO 8601 timestamp when execution began.
ISO 8601 timestamp when execution finished. Present only for terminal states.
Error details if status is `failed`. Contains `code` and `message`.
## OpenAPI
````yaml mint-openapi.yaml GET /v1/orchestrate/executions/{orchestrationId}
openapi: 3.0.3
info:
title: Truthlocks API
description: >
Truthlocks is a universal verification infrastructure for documents,
credentials, and digital assets.
This specification defines the canonical API for interacting with Truthlocks
services.
## Base URLs
- **Production**: `https://api.truthlocks.com`
- **Sandbox**: `https://sandbox-api.truthlocks.com`
## Authentication
- **API Keys**: Use `X-API-Key` header for machine-to-machine operations
- **Bearer Tokens**: Use `Authorization: Bearer ` for user-initiated
operations
## Tenant Identity
In production, tenant identity is derived from the authenticated context
(API key or JWT).
The `X-Tenant-ID` header is ignored in production to prevent spoofing.
version: 1.0.0
contact:
name: Truthlocks Support
url: https://truthlocks.com/support
email: support@truthlocks.com
servers:
- url: https://api.truthlocks.com
description: Production API
- url: https://sandbox-api.truthlocks.com
description: Sandbox Environment
security:
- APIKey: []
tags:
- name: Authentication
description: API key and token management
- name: Issuers
description: Issuer registration and trust management
- name: Keys
description: Cryptographic key management for issuers
- name: Attestations
description: Attestation lifecycle (mint, revoke, supersede)
- name: Verification
description: Attestation verification and proof bundles
- name: Governance
description: Issuer governance workflows (admin only)
- name: Identity
description: Organization, user, and role management
- name: Audit
description: Audit event queries
- name: Platform
description: Platform administration (super admin only)
- name: Platform Review
description: Staff review workflows for issuer applications
- name: Tenant Console
description: Tenant profile and lifecycle endpoints
- name: Health
description: Service health and readiness endpoints
- name: Risk
description: Risk signal ingestion and fraud detection
- name: Risk Enforcement
description: Risk enforcement actions — block, challenge, quarantine, and configuration
- name: Billing
description: Billing, subscription, and addon management
- name: Machine Identity
description: >-
Machine Agent Identity Protocol (MAIP) — agent registration, sessions,
trust, witness, compliance, orchestration, and observability
externalDocs:
description: Transparency read-only API (separate service spec)
url: >-
https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
/v1/orchestrate/executions/{orchestrationId}:
get:
tags:
- Machine Identity
summary: Get Orchestration
description: >-
Returns the full orchestration record including steps, results, and
receipts.
operationId: maip.orchestrations.get
parameters:
- name: orchestrationId
in: path
required: true
schema:
type: string
format: uuid
description: Orchestration identifier
responses:
'200':
description: Orchestration details
content:
application/json:
schema:
$ref: '#/components/schemas/MaipOrchestration'
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'404':
description: Orchestration not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'429':
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
security:
- APIKey: []
components:
schemas:
MaipOrchestration:
type: object
properties:
orchestration_id:
type: string
format: uuid
workflow_id:
type: string
format: uuid
agents:
type: array
items:
type: string
format: uuid
parameters:
type: object
additionalProperties: true
status:
type: string
enum:
- pending
- running
- completed
- failed
- cancelled
steps:
type: array
items:
type: object
properties:
step_id:
type: string
agent_id:
type: string
format: uuid
action:
type: string
status:
type: string
result:
type: object
additionalProperties: true
started_at:
type: string
format: date-time
completed_at:
type: string
format: date-time
results:
type: object
additionalProperties: true
receipts:
type: array
items:
type: string
format: uuid
created_at:
type: string
format: date-time
ErrorEnvelope:
type: object
required:
- code
- message
- http_status
properties:
code:
type: string
description: Machine-readable error code
enum:
- AUTH_REQUIRED
- AUTH_INVALID
- PERMISSION_DENIED
- TENANT_IDENTITY_UNVERIFIED
- NOT_FOUND
- VALIDATION_ERROR
- CONFLICT
- PAYLOAD_TOO_LARGE
- RATE_LIMIT_EXCEEDED
- QUOTA_EXCEEDED
- SERVICE_UNAVAILABLE
- INTERNAL_ERROR
message:
type: string
description: Human-readable error message
http_status:
type: integer
description: HTTP status code
retry_after_ms:
type: integer
description: Milliseconds to wait before retrying (for rate limits)
details:
type: object
description: Additional error context
example:
code: AUTH_REQUIRED
message: Authentication required
http_status: 401
securitySchemes:
APIKey:
type: apiKey
in: header
name: X-API-Key
description: API key for machine-to-machine authentication
````