API BuildShip

Integre agentes de IA na sua aplicacao com uma API REST simples e direta.

Copiar como .md

## O que voce pode fazer A API do BuildShip permite integrar o poder da nossa plataforma de agentes de IA em qualquer aplicacao — backend, mobile, automacoes, scripts. Basta uma chave de API. **Casos de uso comuns:** - Processar arquivos com IA (PDFs, audios, imagens, planilhas) - Conversas multi-turn com sessoes persistentes - Templates de prompt reutilizaveis com variaveis - Webhooks pra receber resultados em tempo real - Geracao de imagens e videos - Extracao de dados estruturados ## Base URL ``` https://api.buildship.com.br/api/v1 ``` ## Recursos principais | Recurso | Descricao | |---|---| | **Process** | Envia arquivo + prompt, recebe processamento da IA | | **Process Batch** | Vários arquivos numa única chamada | | **Chat** | Conversa multi-turn com sessao persistente | | **B2B Send** | Endpoint hibrido (arquivo + prompt + sessao numa chamada) | | **Templates** | Prompts reutilizaveis com variaveis (`{{var}}`) | | **Sessions** | Listar/buscar conversas (`/api/v1/chat/sessions`) | | **Webhooks** | Receber resultados via callback HTTP assinado | | **Multi-tenancy** | Isolamento por `endUserId` em qualquer chamada | ## Autenticacao rapida ```bash curl https://api.buildship.com.br/api/v1/health \ -H "X-API-Key: bld_sua_chave_aqui" ``` Resposta: ```json { "status": "ok", "version": "1.0.0" } ``` ## Limitacoes - **Tamanho max de arquivo**: 500 MB - **Sessao expira**: 2h sem atividade - **Rate limit**: depende do plano (ver [Rate Limiting](/docs/api/errors)) ## Pre-requisitos 1. Conta no BuildShip 2. Verificacao B2B aprovada (ate 48h) 3. API Key gerada no painel [Comecar agora →](/docs/api/quickstart) ## Atendimento a clientes finais Se voce vai usar a API pra responder clientes finais (suporte, geracao de resposta no admin, briefing tecnico de problemas), leia o guia de seguranca: template de `apiBasePrompt` pronto, protecao contra prompt injection, isolamento por `endUserId` e checklist pre-producao. [Seguranca pra clientes finais →](/docs/api/safety)