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

Substituir um documento​

PUT
/api/v1/lens/{workspaceId}/research/{researchId}/document/{id}

Substitui o documento inteiro: type, fileName, contentType e base64 são obrigatórios, e o que não vier no corpo é apagado. Não é um PATCH.

É por aqui que se corrige o tipo que o agente errou, ou se amarra o documento a um envolvido pelo researchEntityId. O metadata é gravado como veio — para preservar o que os OCRs leram, releia o documento e reenvie o metadata inteiro com a sua chave a mais.

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"
id*

O id do documento.

Type
string
Required
Example"b41c9f27-8d3e-4a16-9c5b-2e7f80a1d3c4"
Format
"uuid"

Request Body​

application/json
JSON
{
  
"researchEntityId": "string",
  
"type": "BOLETIM_OCORRENCIA",
  
"fileName": "string",
  
"contentType": "string",
  
"base64": "string",
  
"metadata": {
  
  
"additionalProperties": "string"
  
}
}

Responses​

O documento depois da troca.

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
Body

Samples​

Powered by VitePress OpenAPI