> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter o documento OpenAPI das ações

> Leia a descrição pública OpenAPI 3.1 de todas as ações do cliente e seus esquemas de entrada.

Leia a descrição pública OpenAPI 3.1 de todas as ações do cliente e seus esquemas de entrada.

```http theme={null}
GET https://api.voicecheap.ai/v1/openapi.json
```

## Autenticação

Nenhuma. Esta rota não autentica uma conta nem concede acesso a qualquer ação.

## Exemplos de requisição

Siga a codificação e a autenticação documentadas para esta rota. O formato de resposta e as regras de idempotência da API de ações se aplicam apenas às chamadas de ações.

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET 'https://api.voicecheap.ai/v1/openapi.json'
  ```

  ```javascript JavaScript theme={null}
  const input = {};
  const response = await fetch('https://api.voicecheap.ai/v1/openapi.json', {
    method: 'GET',
    headers: {},
    redirect: 'manual',
  });
  console.log(response.status, await response.text());
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.request(
      "GET",
      "https://api.voicecheap.ai/v1/openapi.json",
      headers={},
      timeout=120,
      allow_redirects=False,
  )
  print(response.status_code, response.text)
  ```
</RequestExample>

## Resposta

Trecho representativo dos metadados. A resposta completa também contém caminhos para todas as ações registradas, incluindo seu esquema de requisição JSON, escopos obrigatórios, cabeçalho de idempotência de alteração e resultados HTTP documentados.

```json HTTP 200 theme={null}
{
  "openapi": "3.1.0",
  "info": {
    "title": "VoiceCheap API",
    "version": "1.0.0",
    "description": "Public customer actions shared with the VoiceCheap MCP. Existing multipart v1 routes remain documented separately."
  },
  "servers": [
    {
      "url": "https://api.voicecheap.ai/v1"
    }
  ],
  "security": [
    {
      "ApiKey": []
    },
    {
      "BearerApiKey": []
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      },
      "BearerApiKey": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "VoiceCheap API key"
      }
    }
  }
}
```

## Notas da operação

* O servers\[0].url retornado inclui /v1. Os caminhos das ações no documento começam com /actions/, portanto não adicione /v1 uma segunda vez.
* Este é o catálogo completo de ações, sem filtros. Use GET /v1/actions autenticado para descobrir o que uma credencial específica tem permissão para usar.
* O documento OpenAPI em tempo de execução cobre apenas o despacho de ações; não inclui rotas OAuth, /mcp, a própria descoberta nem as rotas multipart existentes.
* Esta leitura não consome uma chamada mensal de integração nem o contador de taxa de integração da conta. As proteções HTTP públicas do serviço continuam se aplicando.
* Os exemplos usam origens de produção. Leia os metadados do ambiente selecionado para evitar misturar produção e desenvolvimento.


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