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/listProfiles
- 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 perfis​

GET
/api/v3/profiles

Os perfis ativos do seu workspace, de todos os tipos. O campo profile.kind diz o tipo de cada um: um enriquecimento só roda perfis enrichment. Use ?kind=enrichment para listar só os que servem em POST /api/v3/enrichments. Cada item tem o mesmo formato de GET /api/v3/profiles/{id}: o perfil, a entidade que ele atende e o dataset de cada módulo. A lista não é paginada.

Authorizations​

bearerAuth

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

Type
HTTP (bearer)

Parameters​

Query Parameters

kind

Só perfis deste tipo: enrichment ou verification. Sem o parâmetro, lista todos.

Type
string
Valid values
"enrichment""verification"

Responses​

Os perfis do workspace.

application/json
JSON
{
  
"items": [
  
  
{
  
  
  
"entity": "string",
  
  
  
"modules": {
  
  
  
  
"additionalProperties": {
  
  
  
  
  
"dataset": "string"
  
  
  
  
}
  
  
  
},
  
  
  
"profile": {
  
  
  
  
"id": "string",
  
  
  
  
"kind": "string",
  
  
  
  
"name": "string"
  
  
  
}
  
  
}
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI