Developers

Aparência

Vai integrar a API REST da Zarv com ajuda de IA? Copie a instrução que aponta o modelo para esta documentação.
Ver a instrução
Você vai integrar a API REST da Zarv. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/api/id-v3/createEnrichment
- Autenticação Bearer JWT e hosts: https://developers.zarv.com/setup
- Índice das APIs: https://developers.zarv.com/api
- Índice da documentação em markdown: https://developers.zarv.com/llms.txt
- Documentação completa em um arquivo: https://developers.zarv.com/llms-full.txt

Os specs OpenAPI publicados são a fonte da verdade para rotas e schemas — use o spec da API que você escolher antes de escrever qualquer request.

Antes de escrever qualquer código, leia a página desta integração. Siga exatamente os nomes de campos, endpoints, callbacks e formatos que estiverem documentados — não invente parâmetros nem endpoints, e não deduza comportamento a partir de outras APIs que você conhece. Se algo de que você precisa não estiver na documentação, diga que não está em vez de supor.

Minha tarefa: [ex.: escolher a API certa e fazer a primeira chamada autenticada]

Criar um enriquecimento​

POST
/api/v3/enrichments

Valida a requisição, resolve o perfil (do seu workspace ou um perfil global da Zarv), planeja os módulos, confere o contrato do workspace e cria o enriquecimento. Depois, a requisição espera até 25 segundos por um status terminal:

  • terminou a tempo: 200 com o corpo completo e os dados de todos os módulos em data;
  • não terminou: 202 com {id, status}; se houver callback, ele é entregue quando o enriquecimento terminar;
  • mesma Idempotency-Key e mesmo corpo (a chave não expira): 200 com o corpo do GET quando o enriquecimento já terminou, 202 com {id, status} enquanto ainda roda (um callback enviado junto é rearmado);
  • mesma Idempotency-Key com corpo diferente: 422 idempotency_key_reused.

O processamento continua mesmo que o cliente feche a conexão. Uma resposta não terminal traz Retry-After: consulte GET /api/v3/enrichments/{id} depois desse intervalo, ou espere o callback.

Authorizations​

bearerAuth

Token de acesso obtido em POST /api/v1/authentication. Veja Autenticação.

Type
HTTP (bearer)

Parameters​

Header Parameters

Idempotency-Key

Chave de idempotência, até 255 caracteres (ex.: um UUID). A chave não expira: a mesma chave com o mesmo corpo sempre devolve o mesmo enriquecimento, sem nova cobrança. Para uma consulta nova, use uma chave nova.

Type
string
Max Length
255

Request Body​

application/json
JSON
{
  
"callback": {
  
  
"headers": {
  
  
  
"additionalProperties": "string"
  
  
},
  
  
"url": "string"
  
},
  
"document": "12.abc.345/01de-35",
  
"metadata": {
  
  
"additionalProperties": "string"
  
},
  
"options": {
  
  
"deadline": "2h",
  
  
"modules": {
  
  
  
"additionalProperties": {
  
  
  
}
  
  
}
  
},
  
"profileId": "string"
}

Responses​

Terminou dentro da espera síncrona, ou replay idempotente de um enriquecimento já terminado.

application/json
JSON
{
  
"completedAt": "string",
  
"createdAt": "string",
  
"data": {
  
  
"additionalProperties": "string"
  
},
  
"deadline": "string",
  
"document": "string",
  
"entity": "string",
  
"failureReason": "string",
  
"id": "enr_0199a0b2-7c1e-7d4a-9f0e-3b1c2d4e5f60",
  
"metadata": {
  
  
"additionalProperties": "string"
  
},
  
"modules": {
  
  
"additionalProperties": {
  
  
  
"dataset": "string",
  
  
  
"nextAttemptAt": "string",
  
  
  
"status": "string"
  
  
}
  
},
  
"nextRetryAt": "string",
  
"outcome": "subject_not_found",
  
"profile": {
  
  
"id": "string",
  
  
"kind": "string",
  
  
"name": "string"
  
},
  
"recoveryRound": 0,
  
"status": "string"
}

Playground​

Authorization
Headers
Body

Samples​

Powered by VitePress OpenAPI