Pular para o conteúdo principal

Chaves de API

As chaves de API permitem autenticar requisições programáticas à API da Iara Data.

Criando uma Chave de API

  1. Acesse ConfiguraçõesGerenciar Chaves de API
  2. Clique em Criar Chave
  3. Dê um nome (ex: "Pipeline de Produção")
  4. Opcionalmente defina escopos para restringir o acesso (ex: ingest:write, kpi:read)
  5. Clique em Criar

Captura de tela do modal de criação de chave de API com campos de nome e escopos

atenção

Copie sua chave imediatamente! A chave completa é exibida apenas uma vez. Após fechar o diálogo, você verá apenas uma versão truncada.

Gerenciando Chaves

Captura de tela da tabela de chaves de API mostrando chave (truncada), nome, escopos, último uso e botões de ação

ColunaDescrição
ChaveChave truncada com botão de copiar
NomeRótulo legível
EscoposLista de permissões separadas por vírgula
Último UsoTimestamp relativo (ex: "2 horas atrás")
Criada emQuando a chave foi criada

Ações

AçãoDescrição
CopiarCopiar a chave truncada para a área de transferência
RotacionarGerar um novo valor de chave (a chave antiga para de funcionar imediatamente)
ExcluirRemover permanentemente a chave

Escopos Disponíveis

EscopoAcesso
ingest:writeFazer upload de dados, criar/gerenciar pipelines
ingest:readLer datasets e histórico de ingestão
curupira:queryUsar o chat de IA
kpi:readLer valores de KPI e dashboards
kpi:writeCriar/modificar KPIs e dashboards
analyze:invokeExecutar análises e investigações
billing:readVisualizar informações de cobrança e uso
users:manageConvidar/gerenciar membros da equipe
audit:readVisualizar logs de auditoria
keys:readListar chaves de API
keys:writeCriar/rotacionar/excluir chaves de API
webhooks:readListar webhooks
webhooks:writeCriar/modificar/excluir webhooks

Exemplo de Uso

# Buscar seus datasets
curl https://lake.iaradata.com/api/v1/datasets \
-H "Authorization: Bearer sk_live_abc123..."
# Fazer uma pergunta à IA
curl -X POST https://lake.iaradata.com/api/v1/curupira/ask \
-H "Authorization: Bearer sk_live_abc123..." \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"question": "What was total revenue last month?",
"mode": "agentic",
"execute": true
}'