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/listResearchDocuments
- 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]

Listar os documentos do caso​

GET
/api/v1/lens/{workspaceId}/research/{researchId}/document

Lista os documentos já gravados no caso, num array.

Use ?content=false sempre que não precisar do arquivo: a listagem leve devolve os mesmos itens sem o base64. Com 40 documentos de até 10 MB, a diferença entre as duas é de centenas de megabytes.

O que os agentes leram de cada arquivo fica no metadata, na chave do agente.

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"

Query Parameters

content

false devolve a listagem leve, sem o base64 de cada documento. Qualquer outro valor (ou a ausência) devolve o arquivo.

Type
string
Valid values
"false"
Example"false"

Responses​

Os documentos do caso.

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"researchId": "string",
  
  
"researchEntityId": "",
  
  
"type": "BOLETIM_OCORRENCIA",
  
  
"fileName": "bo.pdf",
  
  
"contentType": "application/pdf",
  
  
"base64": "string",
  
  
"metadata": {
  
  
  
"additionalProperties": "string"
  
  
},
  
  
"createdAt": "string",
  
  
"updatedAt": "string"
  
}
]

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI