Introdução

A documentação da API da Zaia fornece todas as informações necessárias para integrar e trabalhar com a plataforma Zaia, uma ferramenta no-code para criação de agentes de IA. Este documento detalha os endpoints disponíveis, métodos de autorização e exemplos de uso.

Autorização

Antes de chamar qualquer API, você precisa de uma chave de API. Certifique-se de ter sua chave de API disponível seguindo os passos descritos na seção "Criando uma Chave de API".

Basta passar a chave de API nos cabeçalhos da requisição, como nos exemplos abaixo:

curl --location 'https://api.zaia.app/<endpoint path>' \
--header 'Authorization: Bearer <your api key here>'

Criando uma Chave de API

Para obter sua chave de API para o agente desejado, siga os passos:

1. Acesse platform.zaia.app

2. Selecione a opção "Gerenciar API Keys"

3. Na página "Gerenciar API keys", clique em "Gerar nova chave"

4. Copie sua chave

5. Agora que você tem sua chave de API, pode consultar a seção "Autorização" para ver como usá-la

Referência da API

Os endpoints são agrupados de acordo com a entidade/ação principal. Por exemplo: /v1.1/api/agent/retrieve, onde agent é a entidade e retrieve é a ação.

Seguindo esta regra, você poderá encontrar qualquer recurso por aqui.

Outro ponto importante a mencionar: a URL base é https://api.zaia.app.

⚠️ Certifique-se de prefixar os endpoints com ela.