Quickstart

Este walkthrough leva você de uma API key nova até um round-trip de chat funcionando em cinco minutos.

0. Pré-requisitos

Um workspace com pelo menos um agente publicado (use o Studio para criar um se você não tiver nenhum).
Uma API key de workspace (veja Autenticação).

Exporte a key uma vez para os snippets ficarem copy-paste:

export GENNIA_API_KEY="gsk_sua_key_aqui"

1. Verificar a key

O endpoint health valida a key e retorna o workspace ao qual ela está vinculada.

curl "https://api.gennia.ai/public/api/v1/health" \
  -H "X-Api-Key: $GENNIA_API_KEY"

Resposta

{
  "status": "ok",
  "workspacePublicId": "9c3a4d22-1a8d-4b3f-9b1e-7a0f0c4f3e21",
  "apiKeyPublicId": "7f2b1c44-6e90-4d2a-83b5-c1f2d3a4b5c6"
}

Uma resposta diferente de ok — ou qualquer 401 — significa pare. Revise Autenticação antes de continuar.

2. Listar seus agentes

curl "https://api.gennia.ai/public/api/v1/agents" \
  -H "X-Api-Key: $GENNIA_API_KEY"

A resposta é paginada. Guarde o publicId de um agente com status: "published" — você vai precisar a seguir.

Resposta (resumida)

{
  "items": [
    {
      "publicId": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
      "name": "Bot de Suporte",
      "status": "published",
      "description": "Responde dúvidas sobre cobrança e acesso à conta."
    }
  ],
  "page": 1,
  "limit": 20,
  "total": 1,
  "totalPages": 1
}

3. Enviar uma mensagem

curl "https://api.gennia.ai/public/api/v1/agents/$AGENT_ID/messages" \
  -H "X-Api-Key: $GENNIA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Oi, pode resumir o status da minha conta?",
    "externalUserId": "user_42"
  }'

O endpoint bloqueia até o agente terminar (ou timeoutSeconds estourar — default é 60s). A resposta contém o texto da reply, o ID da conversa, o uso de tokens e o custo.

Resposta (resumida)

{
  "conversationId": "9c3a4d22-1a8d-4b3f-9b1e-7a0f0c4f3e21",
  "messages": [
    {
      "role": "assistant",
      "content": "Sua conta está ativa e você tem 4.500 créditos restantes…"
    }
  ],
  "usage": {
    "inputTokens": 245,
    "outputTokens": 89,
    "totalCost": 0.0023
  }
}

4. Continuar a conversa

Passe de volta o conversationId do passo 3 para manter o mesmo thread:

curl "https://api.gennia.ai/public/api/v1/agents/$AGENT_ID/messages" \
  -H "X-Api-Key: $GENNIA_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{
    \"content\": \"E sobre a próxima renovação?\",
    \"conversationId\": \"$CONVERSATION_ID\"
  }"

5. Respostas em streaming

Para UIs interativas, use o endpoint SSE em vez do bloqueante. Mesmo body shape; resposta é text/event-stream.

curl -N "https://api.gennia.ai/public/api/v1/agents/$AGENT_ID/messages/stream" \
  -H "X-Api-Key: $GENNIA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"content": "Me conta uma história longa"}'

Você recebe uma stream de eventos: conversation-id, vários text-delta, e por fim debug-info com uso de tokens e custo.

Próximos passos

Convenções

Paginação, formato de erros, headers comuns.

Referência completa

Cada endpoint com try-it-out e schemas. Navegue em “Endpoints” no menu lateral.

Começando

Convenções

Agents

Threads

Hub

0. Pré-requisitos

1. Verificar a key

2. Listar seus agentes

3. Enviar uma mensagem

4. Continuar a conversa

5. Respostas em streaming

Próximos passos

Convenções

Referência completa

​0. Pré-requisitos

​1. Verificar a key

​2. Listar seus agentes

​3. Enviar uma mensagem

​4. Continuar a conversa

​5. Respostas em streaming

​Próximos passos

Convenções

Referência completa

0. Pré-requisitos

1. Verificar a key

2. Listar seus agentes

3. Enviar uma mensagem

4. Continuar a conversa

5. Respostas em streaming

Próximos passos