Voltar à documentação

Revisar conversas

Gerencie e revise suas conversas através da API

por Arkangel AI Team•1 min de leitura

Aprenda a listar, consultar e gerenciar suas conversas com a API Arkangel AI.

Listar Conversas

Endpoint

GET https://api.arkangelai.com/v1/conversations

Exemplo

curl https://api.arkangelai.com/v1/conversations \
  -H "Authorization: Bearer sua_chave_api"

Parâmetros de Consulta

Parâmetro Tipo Descrição
limit number Número máximo de resultados (máx: 100)
offset number Número de resultados a pular
start_date string Data de início (ISO 8601)
end_date string Data de fim (ISO 8601)

Resposta

{
  "conversations": [
    {
      "id": "conv_abc123",
      "title": "Consulta sobre diabetes",
      "message_count": 5,
      "created_at": "2026-01-19T10:00:00Z",
      "updated_at": "2026-01-19T10:30:00Z"
    }
  ],
  "total": 42,
  "has_more": true
}

Obter uma Conversa

curl https://api.arkangelai.com/v1/conversations/conv_abc123 \
  -H "Authorization: Bearer sua_chave_api"

Resposta

{
  "id": "conv_abc123",
  "title": "Consulta sobre diabetes",
  "messages": [
    {
      "id": "msg_001",
      "role": "user",
      "content": "O que é diabetes tipo 2?",
      "created_at": "2026-01-19T10:00:00Z"
    },
    {
      "id": "msg_002",
      "role": "assistant",
      "content": "O diabetes tipo 2 é uma condição crônica...",
      "sources": [...],
      "created_at": "2026-01-19T10:00:05Z"
    }
  ],
  "created_at": "2026-01-19T10:00:00Z",
  "updated_at": "2026-01-19T10:30:00Z"
}

Pesquisar Conversas

curl "https://api.arkangelai.com/v1/conversations/search?q=diabetes" \
  -H "Authorization: Bearer sua_chave_api"

Parâmetros de Pesquisa

Parâmetro Tipo Descrição
q string Termo de pesquisa
limit number Número máximo de resultados

Atualizar uma Conversa

Você pode atualizar o título de uma conversa:

curl -X PATCH https://api.arkangelai.com/v1/conversations/conv_abc123 \
  -H "Authorization: Bearer sua_chave_api" \
  -H "Content-Type: application/json" \
  -d '{"title": "Consulta diabetes - Paciente A"}'

Excluir uma Conversa

curl -X DELETE https://api.arkangelai.com/v1/conversations/conv_abc123 \
  -H "Authorization: Bearer sua_chave_api"

Nota: Esta ação é irreversível. Todas as mensagens da conversa serão excluídas.

Exportar Conversa

Exporte uma conversa em diferentes formatos:

curl "https://api.arkangelai.com/v1/conversations/conv_abc123/export?format=pdf" \
  -H "Authorization: Bearer sua_chave_api" \
  -o conversa.pdf

Formatos Disponíveis

Formato Descrição
json Dados estruturados
pdf Documento PDF
txt Texto simples

Exemplo Completo

// Listar conversas recentes
async function getRecentConversations() {
  const response = await fetch(
    'https://api.arkangelai.com/v1/conversations?limit=10',
    {
      headers: {
        'Authorization': 'Bearer sua_chave_api'
      }
    }
  );

  const data = await response.json();
  return data.conversations;
}

// Obter detalhes de uma conversa
async function getConversation(conversationId) {
  const response = await fetch(
    `https://api.arkangelai.com/v1/conversations/${conversationId}`,
    {
      headers: {
        'Authorization': 'Bearer sua_chave_api'
      }
    }
  );

  return response.json();
}

Próximos Passos