Primeiros passos

Sua primeira integracao com a API BuildShip em 6 passos — leva 5 minutos.

Copiar como .md

1. Criar conta no BuildShip

Acesse app.buildship.com.br e crie sua conta.

2. Verificar conta B2B

No dashboard, va em API B2B e preencha os dados da empresa: CNPJ, razao social, contato. A verificacao leva ate 48h e e necessaria pra criar API keys.

3. Criar API Key

Apos aprovacao, em API B2B → API Keys, clique em Nova chave.

A chave completa e mostrada apenas UMA VEZ. Guarde em local seguro (.env, vault, secrets manager).

Formato da chave: bld_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

4. Testar a chave

curl https://api.buildship.com.br/api/v1/health \
  -H "X-API-Key: bld_sua_chave_aqui"

Esperado:

{ "status": "ok", "version": "1.0.0" }

5. Primeira chamada — chat simples

curl -X POST https://api.buildship.com.br/api/v1/chat \
  -H "X-API-Key: bld_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Resuma este texto em 3 bullets: ...",
    "endUserId": "user-123"
  }'

Resposta:

{
  "sessionId": "session_abc123",
  "status": "started",
  "callbackUrl": null
}

6. Buscar resultado

Como a IA processa em background, voce tem 2 opcoes:

Opcao A — Polling (simples, mas custa requests):

curl https://api.buildship.com.br/api/v1/sessions/session_abc123 \
  -H "X-API-Key: bld_sua_chave"

Opcao B — Webhooks (recomendado):

Configure um webhook no painel apontando pro seu servidor. A IA chama assim que terminar:

POST https://seu-servidor.com/buildship/callback
{
  "type": "completion",
  "sessionId": "session_abc123",
  "output": "1. Bullet 1\n2. Bullet 2\n3. Bullet 3",
  "status": "completed"
}

Configurar webhooks →

Proximos passos

• Autenticacao em detalhes — formas de passar a API key
• Templates — prompts reutilizaveis com variaveis
• Endpoints completos — referencia de todos endpoints
• Exemplos Node.js e Python — codigo pronto pra copiar