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/lens/requestResearchAnalysis
- 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]

Pedir a análise do caso​

POST
/api/v1/lens/{workspaceId}/research/{researchId}/analyze

Põe a análise do caso na fila e responde 202 na hora. Não tem corpo.

Um worker dentro da API enriquece o segurado e o terceiro (ZarvID e Asset) e roda as nove dimensões sobre o caso montado — os documentos, as leituras e os envolvidos. Cada dimensão grava o resultado dela assim que termina, então uma análise parcial já é legível. Isso leva minutos: nada disso cabe no tempo de uma requisição HTTP.

O andamento e o resultado saem no GET do caso, em analysis. O caso vai para a raia Analisando no pedido, e para Analisado ou Análise falhou no fim.

Uma análise por vez. Pedir outra com uma em andamento é 409. Pedir com o envio dos documentos rodando também é 409: a análise lê o caso que o envio ainda está gravando. Pedir uma análise num caso já analisado é permitido — ela substitui a anterior, e cada dimensão sobrescreve o campo dela.

Authorizations​

BearerAuth

Token Bearer JWT obtido em POST /api/v1/authentication. O workspace do token precisa ser o mesmo do caminho.

Type
HTTP (bearer)

Parameters​

Path Parameters

workspaceId*

O workspace dono do caso. Tem de ser o workspace do token.

Type
string
Required
Example"3f1a2b4c-5d6e-4f70-8a91-b2c3d4e5f607"
Format
"uuid"
researchId*

O id do caso.

Type
string
Required
Example"7d2f8e10-4c3b-4a5d-9e8f-1a2b3c4d5e6f"
Format
"uuid"

Responses​

A análise entrou na fila.

application/json
JSON
{
  
"researchId": "string",
  
"status": "QUEUED"
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI