Pular para o conteúdo
GET

/v1/knowledge/attachments/{batchId}/files/{attachmentId}/content

Baixar uma imagem do lote (agente autorizado, uma única vez)

Somente token de serviço com knowledge:attachments (exclusiva da Lívia). Nenhuma pessoa, nem o administrador da clínica ou a equipe da plataforma, baixa a imagem por aqui.

Cada imagem sai uma vez: a segunda tentativa responde 409 attachment_already_downloaded. Entregue, a imagem é apagada do armazenamento. Lote vencido → 410 attachment_expired; lote encerrado → 409 attachment_batch_closed; imagem já apagada → 410 attachment_unavailable.

A integridade é conferida pelo sha256 antes de enviar (X-Content-SHA256). O download fica na auditoria (quem, quando, qual lote e hash), sem conteúdo.

Permissão:knowledge: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}$

  • attachmentIdstringObrigatório

    Padrão (regex): ^kaf[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>/files/<attachmentId>/content", {  method: "GET",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "X-Agent-Key": "<agent_key>",  },})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

200OK — Bytes da imagem (WEBP sem metadados).

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.

409

Conflict — Conflito de estado (duplicidade, transição inválida, conflito de agenda).

410

— Erro

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).

502

Bad Gateway — Um serviço externo da plataforma falhou.

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