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

# Invocar Ferramenta

> Solicitar invocação de ferramenta com validação de âmbito, limitação de taxa e geração de recibo de auditoria

# Invocar Ferramenta

`POST /v1/tools/{toolName}/invoke`

Solicita a invocação de uma ferramenta registada em nome de um agente de máquina. A plataforma realiza uma verificação de controlo de acesso de várias camadas antes de conceder o acesso:

1. **Status do agente** — o agente deve estar `"active"`
2. **Verificação de escopo** — o agente deve possuir o escopo exigido pela ferramenta
3. **Limite de taxa** -- o agente não deve exceder o limite de taxa por minuto da ferramenta
4. **Porta de aprovação** -- se a ferramenta exigir aprovação, a resposta é `pending_approval`; o manipulador atual não cria uma solicitação de aprovação

Se todas as verificações forem aprovadas, a invocação é registrada. Os recibos de ferramentas atuais usam um marcador de sistema em vez de uma assinatura criptográfica. São registros de auditoria, não provas assinadas verificáveis independentemente.

> [!NOTE]
>
> Este endpoint executa a **decisão de controle de acesso** e registra a decisão. Ele não faz proxy da execução real da ferramenta. Sua aplicação é
> responsável por chamar o endpoint subjacente da ferramenta após receber um
> `"allowed"` resposta.

### Autenticação

Requer cabeçalho `X-API-Key` ou token JWT de portador. O espaço de trabalho é derivado da credencial autenticada; não envie `X-Tenant-ID`.

### Resposta

**allowed** `boolean`

Se a invocação foi autorizada. `true` se todas as verificações de controle de acesso
aprovado.

**status** `string`

Status da invocação. Um de: `"allowed"`, `"denied"`, `"pending_approval"`.

**reason** `string`

Explicação legível por humanos quando a invocação é negada ou pendente. Não
presente quando permitido.

**receipt\_id** `string`

Identificador de recibo único para a invocação, vinculando à trilha de auditoria. Apenas
presente quando `status` é `"allowed"`.

**requires\_approval** `boolean`

`true` quando a ferramenta requer aprovação humana. A invocação não é automaticamente enfileirada para aprovação.
Presente apenas quando `status` é `"pending_approval"`.

### Exemplo: Invocação Permitida

```bash theme={null}
curl -X POST https://api.truthlocks.com/v1/tools/search.web/invoke \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH",
    "session_id": "maip-sess:a1b2c3d4:9f8e7d6c5b4a3210"
  }'
```

***

### Fluxo de Controle de Acesso

```
POST /v1/tools/{name}/invoke
  |
  +-- Is agent active?
  |     No  --> { allowed: false, status: "denied", reason: "agent is not active" }
  |
  +-- Does agent have required scope?
  |     No  --> { allowed: false, status: "denied", reason: "agent lacks required scope: ..." }
  |
  +-- Is rate limit exceeded?
  |     Yes --> { allowed: false, status: "denied", reason: "rate limit exceeded" }
  |
  +-- Does tool require approval?
  |     Yes --> { allowed: false, status: "pending_approval", requires_approval: true }
  |
  +-- Create receipt + record invocation
        --> { allowed: true, status: "allowed", receipt_id: "..." }
```

### Padrão de integração

Após receber uma resposta `"allowed"`, execute a ferramenta e, opcionalmente, registre o resultado:

```bash theme={null}
# 1. Request invocation authorization
RESPONSE=$(curl -s -X POST https://api.truthlocks.com/v1/tools/search.web/invoke \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{"agent_id": "maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH"}')

ALLOWED=$(echo "$RESPONSE" | jq -r '.allowed')
RECEIPT_ID=$(echo "$RESPONSE" | jq -r '.receipt_id')

# 2. Execute the tool only if explicitly authorized
if [ "$ALLOWED" = "true" ]; then
  RESULT=$(curl -s "https://serpapi.com/search?q=example&api_key=...")
  echo "Tool executed. Receipt: $RECEIPT_ID"
fi
```


## OpenAPI

````yaml pt/mint-openapi.yaml POST /v1/tools/{toolName}/invoke
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/tools/{toolName}/invoke:
    post:
      tags:
        - Machine Identity
      summary: Invocar Ferramenta
      description: >-
        Verifica o acesso e registra uma decisão de invocação. Não executa a
        ferramenta. Novos recibos exigem um signatário configurado e uma chave
        de assinatura de agente ativa válida. Uma decisão pending_approval não
        cria uma solicitação de aprovação; solicite uma revisão independente
        explicitamente através de /v1/approvals e aplique o resultado em sua
        aplicação.
      operationId: maip.tools.invoke
      parameters:
        - name: toolName
          in: path
          required: true
          schema:
            type: string
          description: Nome da ferramenta registado.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                agent_id:
                  type: string
                session_id:
                  type: string
                  description: Sessão ativa para invocar sob
                  format: uuid
              type: object
              required:
                - agent_id
      responses:
        '200':
          description: Resultado da invocação da ferramenta
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaipToolInvocationResult'
        '400':
          description: Erro de validação ou incompatibilidade de esquema
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Autenticação necessária
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Ferramenta ou sessã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:
    MaipToolInvocationResult:
      type: object
      properties:
        result:
          type: object
          additionalProperties: true
        receipt_id:
          type: string
          format: uuid
        execution_ms:
          type: integer
    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.