> ## 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.

# Obter Orquestração

> Recupere o resultado completo da execução de uma orquestração, incluindo detalhes em nível de etapa e rastreamento de custos.

Retorna o estado de execução completo de uma orquestração, incluindo seu status atual, cada etapa executada, a saída final, custo acumulado e o recibo do log de transparência uma vez concluído.

Sonde este endpoint para acompanhar o progresso da orquestração. Para atualizações em tempo real, configure um webhook para eventos `orchestration.completed` e `orchestration.failed`.

### Resposta

**id** `string`

Identificador de orquestração.

**agent\_id** `string`

O agente que executou a orquestração.

**workflow\_id** `string`

O identificador da definição do fluxo de trabalho, se aplicável.

**status** `string`

Status atual: `running`, `completed`, `failed`, ou `timeout`.

**steps** `array`

Array ordenado de etapas de execução. Cada etapa contém: - `step_number`
(inteiro) -- Índice sequencial da etapa (base 1) - `action` (string) -- Ação
executado (por exemplo, `llm_inference`, `tool_call`, `decision`, `guardrail_check`) -
`result` (string) -- Resumo do resultado da etapa - `duration_ms` (inteiro) -- Etapa
tempo de execução em milissegundos

**output** `object`

Saída final da orquestração. Presente apenas quando o status é `completed`.

**total\_cost\_cents** `number`

Custo total acumulado de todas as inferências LLM e chamadas de ferramentas em centavos de dólar americano.

**receipt\_id** `string`

Recibo do log de transparência ancorando a orquestração concluída. Presente apenas
quando o status é `completed`.

**started\_at** `string`

Carimbo de data/hora ISO 8601 quando a execução começou.

**completed\_at** `string`

Carimbo de data/hora ISO 8601 quando a execução terminou. Presente apenas para estados terminais.

**error** `object`

Detalhes do erro se o status for `failed`. Contém `code` e `message`.


## OpenAPI

````yaml pt/mint-openapi.yaml GET /v1/orchestrate/executions/{orchestrationId}
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >-
    Truthlocks é uma infraestrutura de verificação universal para documentos,
    credenciais e ativos digitais.

    Esta especificação define a API canônica para interagir com os serviços
    Truthlocks.


    ## URLs Base

    - **Produção**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Autenticação

    - **Chaves de API**: Use o cabeçalho `X-API-Key` para operações máquina a
    máquina

    - **Tokens de Portador**: Use `Authorization: Bearer <jwt>` para operações
    iniciadas pelo usuário


    ## Identidade do Inquilino

    Em produção, a identidade do inquilino é derivada do contexto autenticado
    (chave de API ou JWT).

    O cabeçalho `X-Tenant-ID` é ignorado em produção para evitar falsificação.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: API de Produção
  - url: https://sandbox-api.truthlocks.com
    description: Ambiente Sandbox
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gerenciamento de chaves e tokens de API
  - name: Issuers
    description: Registro do emissor e gerenciamento de confiança
  - name: Keys
    description: Gerenciamento de chaves criptográficas para emissores
  - name: Attestations
    description: Ciclo de vida da atestação (cunhar, revogar, substituir)
  - name: Verification
    description: Verificação de atestado e pacotes de prova
  - name: Governance
    description: Fluxos de trabalho de governança do emissor (somente administrador)
  - name: Identity
    description: Gerenciamento de organização, usuário e função
  - name: Audit
    description: Consultas de eventos de auditoria
  - name: Tenant Console
    description: Endpoints de perfil e ciclo de vida do locatário
  - name: Health
    description: Endpoints de saúde e prontidão do serviço
  - name: Risk
    description: Ingestão de sinal de risco e detecção de fraude
  - name: Risk Enforcement
    description: Ações de aplicação de risco — bloqueio, desafio, quarentena e configuração
  - name: Billing
    description: Gerenciamento de faturamento, assinatura e complementos
  - name: Machine Identity
    description: >-
      Protocolo de Identidade de Agente de Máquina (MAIP) — registro de agente,
      sessões, confiança, testemunha, conformidade, orquestração e
      observabilidade
externalDocs:
  description: API somente leitura de transparência (especificação de serviço separada)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/orchestrate/executions/{orchestrationId}:
    get:
      tags:
        - Machine Identity
      summary: Obter Orquestração
      description: >-
        Retorna o registro completo da orquestração, incluindo etapas,
        resultados e recibos.
      operationId: maip.orchestrations.get
      parameters:
        - name: orchestrationId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Identificador de orquestração
      responses:
        '200':
          description: Detalhes da orquestração
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaipOrchestration'
        '401':
          description: Autenticação necessária
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Orquestração não encontrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Limite de taxa excedido
          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: Código de erro legível por máquina
          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: Mensagem de erro legível por humanos
        http_status:
          type: integer
          description: Código de status HTTP
        retry_after_ms:
          type: integer
          description: >-
            Milissegundos para aguardar antes de tentar novamente (para limites
            de taxa)
        details:
          type: object
          description: Contexto de erro adicional
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave de API para autenticação máquina a máquina
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT para operações iniciadas pelo usuário

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.