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.

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.

Baixar a especificação OpenAPI

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

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.