Pular para o conteúdo
GET

/v1/knowledge/attachments/{batchId}

Situação de um lote de imagens

Só metadados (ids, hashes, tipo, tamanho e estados) — nunca a imagem. Pessoa da clínica com knowledge:write ou o agente autorizado (knowledge:attachments).

Qualquer uma:knowledge:writeknowledge:attachments

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar

Authorization: Bearer <TOKEN>X-Clinic-Id: <clinic_id>

Parâmetros

Parâmetros de caminho

  • batchIdstringObrigatório

    Padrão (regex): ^[a-f0-9]{32}$

Cabeçalhos

  • X-Clinic-IdstringOpcional

    Clínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex): ^[A-Za-z0-9._-]{1,64}$

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/knowledge/attachments/<batchId>", {  method: "GET",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",  },})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

200OK — Sucesso.
JSON
{  "data": {    "batchId": "<batchId>",    "source": "knowledge-attachment:0123456789abcdef0123456789abcdef",    "status": "uploading",    "attachmentCount": 1,    "createdAt": "2026-09-18T14:00:00.000Z",    "expiresAt": "2026-09-18T14:00:00.000Z",    "closedAt": "2026-09-18T14:00:00.000Z",    "reasonCode": "<reasonCode>",    "draftCount": 1,    "attachments": [      {        "id": "<id>",        "position": 1,        "sha256": "<sha256>",        "mimeType": "image/webp",        "sizeBytes": 1,        "downloaded": true,        "available": true      }    ]  }}

Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.

Códigos de erro

Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

404

Not Found — Recurso não encontrado na clínica ativa.

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

Service Unavailable — Banco de dados indisponível ou não configurado.

Limites

Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites