Pular para o conteúdo
POST

/v1/knowledge/attachments

Enviar imagens (prints) para virar rascunho de conhecimento

multipart/form-data com 1 a 12 imagens no campo files (JPEG, PNG ou WEBP, até 2 MB cada). O tipo é conferido pela assinatura dos bytes, não pela extensão.

Quem: só uma pessoa com vínculo na clínica e knowledge:write. Agentes e equipe da plataforma recebem 403.

Privacidade: a imagem é guardada só para o processamento, regravada sem metadados, em armazenamento privado. Só o agente autorizado a baixa, uma única vez, e ela é apagada em seguida; o que sobrar some ao encerrar o lote ou no vencimento (expiresAt). O nome do arquivo não é guardado. Não envie prints com dados que a clínica não queira processar.

Resultado: os itens gerados nascem como rascunho pendente e não valem para os agentes antes da aprovação de uma pessoa da clínica.

Idempotência: Idempotency-Key obrigatória, por clínica. Primeira vez → 201; mesma chave com as mesmas imagens → 200 com Idempotent-Replayed: true; mesma chave com outras imagens → 409 idempotency_key_reused; envio ainda em gravação → 409 upload_in_progress.

Envio desligado no ambiente → 503 knowledge_attachments_disabled. Muitos lotes ainda abertos na clínica → 429 too_many_open_batches.

Permissão:knowledge:writeDispara:knowledge.attachment.received

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

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}$

  • Idempotency-KeystringOpcional

    Obrigatório. ASCII visível, sem espaços. · Entre 8 e 255 caracteres · Padrão (regex): ^[\x21-\x7E]+$

Corpo da requisição

Envio de arquivo em multipart/form-data, um arquivo por requisição (até 2 MB). O campo do arquivo aparece no exemplo cURL.

Exemplo de requisição

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

const form = new FormData()form.append("file", arquivo) // File ou Blob​const res = await fetch("https://myclinc.leadpoint.com.br/v1/knowledge/attachments", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",  },  body: form,})​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      }    ]  },  "meta": {    "idempotent": true,    "webhooks": [      {        "event": "<event>",        "status": "sent"      }    ]  }}
201Created — 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      }    ]  },  "meta": {    "idempotent": true,    "webhooks": [      {        "event": "<event>",        "status": "sent"      }    ]  }}

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

409

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

413

Payload Too Large — Erro

415

Unsupported Media Type — 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).

503

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

Limites

Esta operação tem limite próprio: 6 requisições / 60 s por token. Sobre limites