# Introdução à API

Integre com a API Zild usando o contrato OpenAPI atual, autenticação por API Key e exemplos completos de requisição e resposta.

Source: https://zild.ai/pt-BR/docs/api-reference/introduction

## Visão geral do contrato

Esta página é gerada a partir do OpenAPI vv1. A especificação é a fonte de verdade para rotas, campos, obrigatoriedade e contratos de resposta.



<table class="api-params"><thead><tr><th>Item</th><th>Valor</th></tr></thead><tbody><tr><td>OpenAPI</td><td><code>3.0.4</code></td></tr><tr><td>Versão da API</td><td><code>v1</code></td></tr><tr><td>Operações</td><td>124</td></tr><tr><td>Rotas</td><td>72</td></tr><tr><td>Schemas</td><td>102</td></tr></tbody></table>

[Baixar a especificação OpenAPI](/openapi.json)

## Base URL



```
https://api.zild.ai
```

Os caminhos exibidos nas páginas de endpoint são relativos a essa origem e preservam exatamente maiúsculas, minúsculas e segmentos definidos no OpenAPI.

## Autenticação

Envie sua chave de API de usuário no header X-API-Key.



```
X-API-Key: YOUR_USER_API_KEY
```

Mantenha a chave fora do navegador, de repositórios, logs e materiais compartilhados. O tenant e as permissões efetivas são os mesmos do usuário que gerou a chave.

## Formatos de requisição

- Use `application/json` nos endpoints JSON.
- Use `multipart/form-data` quando a operação combina arquivos e campos.
- Datas seguem os formatos `date` e `date-time` indicados em cada schema.
- Parâmetros de query são opcionais, exceto quando a coluna Obrigatório indica Sim.

## Áreas da API



<table class="api-params"><thead><tr><th>Área</th><th>Operações</th></tr></thead><tbody><tr><td>CRM</td><td>11</td></tr><tr><td>Agentes</td><td>40</td></tr><tr><td>Voz</td><td>8</td></tr><tr><td>Insight</td><td>12</td></tr><tr><td>Assist</td><td>8</td></tr><tr><td>Conversas</td><td>9</td></tr><tr><td>Documentos</td><td>6</td></tr><tr><td>Flow</td><td>24</td></tr><tr><td>Consumo da assinatura</td><td>1</td></tr><tr><td>Webhooks</td><td>5</td></tr></tbody></table>



## Como ler a referência

Cada operação documenta parâmetros, content type, campos do corpo, exemplo em cURL, códigos de resposta, exemplo de resposta e todos os modelos alcançáveis pelo contrato. Campos sem marcação de obrigatoriedade no Swagger aparecem como opcionais; nullable, enums, limites e valores padrão são mostrados separadamente.