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

# Registrar Ferramenta

> Registrar uma ferramenta no registro de ferramentas MAIP com requisitos de escopo, classificação de risco e limites de taxa

# Registrar Ferramenta

`POST /v1/tools`

Regista uma nova ferramenta no registo de ferramentas MAIP do inquilino. As ferramentas representam capacidades externas (APIs, funções, serviços) que os agentes de máquina podem invocar. Cada ferramenta está associada a um âmbito obrigatório, nível de risco e porta de aprovação opcional.

A plataforma eleva automaticamente o nível de risco para `"high"` se o nome da ferramenta ou o escopo necessário contiver verbos de ação perigosos (write, delete, send, execute, deploy, destroy, drop, truncate).

> [!NOTE]
>
> Os nomes das ferramentas devem ser únicos por locatário. A tentativa de registrar uma ferramenta com um
> nome que já existe retorna `409 Conflict`.

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

**id** `string`

UUID da ferramenta recém-registrada.

**tenant\_id** `string`

UUID do locatário proprietário.

**name** `string`

Nome da ferramenta legível por máquina.

**display\_name** `string`

Nome da ferramenta legível por humanos.

**description** `string`

Descrição da ferramenta.

**scope\_required** `string`

Escopo necessário para invocação.

**risk\_level** `string`

Classificação de risco efetiva (pode ser elevada automaticamente).

**requires\_approval** `boolean`

Se a aprovação humana é necessária.

**rate\_limit\_per\_minute** `integer`

Limite de taxa por agente.

**category** `string`

Categoria da ferramenta.

**status** `string`

Status da ferramenta. Sempre `"active"` na criação.

**metadata** `object`

Metadados da ferramenta.

**created\_at** `string`

Carimbo de data/hora de criação ISO 8601.

**updated\_at** `string`

Carimbo de data/hora da última atualização ISO 8601.

### Exemplo

```bash theme={null}
curl -X POST https://api.truthlocks.com/v1/tools \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "search.web",
    "display_name": "Web Search",
    "description": "Performs web searches via SerpAPI and returns structured results",
    "scope_required": "tool:search.web",
    "risk_level": "low",
    "rate_limit_per_minute": 30,
    "category": "search",
    "metadata": {
      "endpoint_url": "https://serpapi.com/search",
      "auth_type": "api_key",
      "max_results": 10
    }
  }'
```

***

### Elevação Automática do Nível de Risco

A plataforma verifica nomes de ferramentas e requisitos de escopo em busca de verbos de ação perigosos. Se detectado, o nível de risco é automaticamente elevado:

| Verbo Detectado | Elevação Automática |
| - | - |
| `write`, `delete`, `send` | Elevado para `"high"` |
| `execute`, `deploy`, `destroy` | Elevado para `"high"` |
| `drop`, `truncate` | Elevado para `"high"` |

Ferramentas com nível de risco `"critical"` sempre exigem aprovação humana, independentemente da configuração `requires_approval`.


## OpenAPI

````yaml pt/mint-openapi.yaml POST /v1/tools
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:
    post:
      tags:
        - Machine Identity
      summary: Registrar Ferramenta
      description: >-
        Regista uma ferramenta invocável que os agentes podem chamar. O esquema
        da ferramenta define os argumentos de entrada esperados usando o JSON
        Schema.
      operationId: maip.tools.register
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                category:
                  type: string
                description:
                  type: string
                  description: Descrição da ferramenta legível por humanos
                display_name:
                  type: string
                metadata: {}
                name:
                  type: string
                  description: Nome da ferramenta exclusivo
                rate_limit_per_minute:
                  type: integer
                requires_approval:
                  type: boolean
                risk_level:
                  type: string
                scope_required:
                  type: string
              type: object
              required:
                - name
                - display_name
                - scope_required
      responses:
        '201':
          description: Ferramenta registrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaipTool'
        '400':
          description: Erro de validação
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Autenticação necessária
          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:
    MaipTool:
      type: object
      properties:
        tool_id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type: string
        schema:
          type: object
          additionalProperties: true
        agent_id:
          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.