Reports API

Gerencie laudos radiologicos com suporte a HTML, metadados DICOM e integracao com PACS.

Base URL

https://copilot.laudos.ai/api/v1

Endpoints

Metodo	Endpoint	Descricao
`GET`	`/reports`	Listar laudos
`GET`	`/reports/:id`	Obter laudo
`POST`	`/reports`	Criar laudo
`PUT`	`/reports/:id`	Atualizar laudo
`DELETE`	`/reports/:id`	Excluir laudo

Listar Laudos

GET

Retorna uma lista paginada de laudos do usuario autenticado.

Query Parameters

Parametro	Tipo	Padrao	Descricao
`limit`	integer	20	Maximo de resultados (1-100)
`offset`	integer	0	Pular N resultados
`sort`	string	`desc`	Ordenacao: `asc` ou `desc`
`exam_type`	string	-	Filtrar por tipo: `CT`, `MR`, `US`, `XR`, `MG`
`modality`	string	-	Filtrar por modalidade DICOM
`search`	string	-	Busca por titulo ou conteudo
`status`	string	-	Filtrar por status: `draft`, `final`, `corrected`
`created_after`	string	-	Data ISO 8601 (ex: `2024-01-01`)
`created_before`	string	-	Data ISO 8601

Exemplo

curl -X GET "https://copilot.laudos.ai/api/v1/reports?limit=10&exam_type=CT&sort=desc" \
  -H "Authorization: Bearer sk_live_xxx"

Resposta

{
  "data": [
    {
      "id": "rpt_abc123def456",
      "title": "TC de Torax",
      "content": "<h1>LAUDO RADIOLOGICO</h1><p>...</p>",
      "exam_type": "CT",
      "modality": "CT",
      "status": "final",
      "accession_number": "ACC12345",
      "patient_id": "PAT001",
      "patient_name": "Silva, Joao",
      "study_date": "2024-01-15T10:30:00Z",
      "created_at": "2024-01-15T14:22:00Z",
      "updated_at": "2024-01-15T14:45:00Z",
      "word_count": 245,
      "character_count": 1580
    }
  ],
  "meta": {
    "total": 156,
    "limit": 10,
    "offset": 0,
    "has_more": true
  }
}

Obter Laudo

GET

Retorna um laudo especifico pelo ID.

Path Parameters

Parametro	Tipo	Descricao
`id`	string	ID do laudo (formato: `rpt_xxx` ou UUID)

Exemplo

curl -X GET "https://copilot.laudos.ai/api/v1/reports/rpt_abc123def456" \
  -H "Authorization: Bearer sk_live_xxx"

Resposta

{
  "data": {
    "id": "rpt_abc123def456",
    "title": "TC de Torax",
    "content": "<h1>LAUDO RADIOLOGICO</h1><h2>TC DE TORAX</h2><p><strong>Tecnica:</strong> Tomografia computadorizada helicoidal do torax, sem administracao de meio de contraste endovenoso.</p><p><strong>Achados:</strong> Parenquima pulmonar com atenuacao normal. Nao ha nodulos ou massas pulmonares. Arvore bronquica de calibre normal.</p><p><strong>Impressao:</strong> Exame dentro dos limites da normalidade.</p>",
    "content_plain": "LAUDO RADIOLOGICO\n\nTC DE TORAX\n\nTecnica: Tomografia computadorizada helicoidal...",
    "exam_type": "CT",
    "modality": "CT",
    "status": "final",
    "accession_number": "ACC12345",
    "study_instance_uid": "1.2.840.113619.2.55.3.604688119.969.1234567890.123",
    "patient_id": "PAT001",
    "patient_name": "Silva, Joao",
    "patient_dob": "1958-03-15",
    "patient_gender": "M",
    "study_date": "2024-01-15T10:30:00Z",
    "study_description": "TC de Torax sem contraste",
    "referring_physician": "Dr. Carlos Lima",
    "reporting_radiologist": "Dra. Maria Santos",
    "institution": "Hospital Central",
    "critical_findings": [],
    "created_at": "2024-01-15T14:22:00Z",
    "updated_at": "2024-01-15T14:45:00Z",
    "word_count": 245,
    "character_count": 1580
  }
}

Criar Laudo

POST

Cria um novo laudo radiologico.

Body Parameters

Campo	Tipo	Obrigatorio	Descricao
`title`	string	Sim	Titulo do laudo
`content`	string	Sim	Conteudo HTML do laudo
`exam_type`	string	Nao	Tipo: `CT`, `MR`, `US`, `XR`, `MG`, `NM`, `PT`
`modality`	string	Nao	Modalidade DICOM
`status`	string	Nao	Status: `draft`, `final`, `corrected`
`accession_number`	string	Nao	Numero de acesso
`study_instance_uid`	string	Nao	Study Instance UID
`patient_id`	string	Nao	ID do paciente
`patient_name`	string	Nao	Nome (Sobrenome, Nome)
`patient_dob`	string	Nao	Data nascimento (YYYY-MM-DD)
`patient_gender`	string	Nao	Genero: `M`, `F`, `O`
`study_date`	string	Nao	Data do estudo (ISO 8601)
`study_description`	string	Nao	Descricao do estudo
`referring_physician`	string	Nao	Medico solicitante
`reporting_radiologist`	string	Nao	Radiologista
`institution`	string	Nao	Instituicao

Exemplo

curl -X POST "https://copilot.laudos.ai/api/v1/reports" \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "TC de Torax",
    "content": "<h1>LAUDO RADIOLOGICO</h1><p>Exame normal.</p>",
    "exam_type": "CT",
    "modality": "CT",
    "status": "final",
    "accession_number": "ACC12345",
    "patient_id": "PAT001",
    "patient_name": "Silva, Joao",
    "patient_dob": "1958-03-15",
    "patient_gender": "M",
    "reporting_radiologist": "Dra. Maria Santos"
  }'

Resposta

{
  "data": {
    "id": "rpt_xyz789ghi012",
    "title": "TC de Torax",
    "content": "<h1>LAUDO RADIOLOGICO</h1><p>Exame normal.</p>",
    "exam_type": "CT",
    "status": "final",
    "created_at": "2024-01-15T14:22:00Z",
    "updated_at": "2024-01-15T14:22:00Z"
  }
}

Atualizar Laudo

PUT

Atualiza campos de um laudo existente. Apenas os campos enviados serao atualizados.

Path Parameters

Parametro	Tipo	Descricao
`id`	string	ID do laudo

Body Parameters

Todos os campos sao opcionais. Apenas os campos enviados serao atualizados.

Exemplo

curl -X PUT "https://copilot.laudos.ai/api/v1/reports/rpt_abc123def456" \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "TC de Torax - Corrigido",
    "status": "corrected",
    "content": "<h1>LAUDO RADIOLOGICO</h1><p>Exame corrigido.</p>"
  }'

Resposta

{
  "data": {
    "id": "rpt_abc123def456",
    "title": "TC de Torax - Corrigido",
    "status": "corrected",
    "updated_at": "2024-01-15T15:30:00Z"
  }
}

Excluir Laudo

DELETE

Exclui permanentemente um laudo.

Esta acao e irreversivel. Laudos ja enviados ao PACS nao podem ser excluidos.

Exemplo

curl -X DELETE "https://copilot.laudos.ai/api/v1/reports/rpt_abc123def456" \
  -H "Authorization: Bearer sk_live_xxx"

Resposta

{
  "data": {
    "id": "rpt_abc123def456",
    "deleted": true
  }
}

Objeto Report

Campos Completos

Campo	Tipo	Descricao
`id`	string	Identificador unico (formato: `rpt_xxx`)
`title`	string	Titulo do laudo
`content`	string	Conteudo HTML completo
`content_plain`	string	Conteudo em texto puro
`exam_type`	string	Tipo de exame (CT, MR, US, etc.)
`modality`	string	Modalidade DICOM
`status`	string	Status do laudo
`accession_number`	string	Numero de acesso HL7/DICOM
`study_instance_uid`	string	Study Instance UID DICOM
`patient_id`	string	ID do paciente
`patient_name`	string	Nome (formato: Sobrenome, Nome)
`patient_dob`	string	Data de nascimento (YYYY-MM-DD)
`patient_gender`	string	Genero: M, F, O
`study_date`	string	Data/hora do estudo (ISO 8601)
`study_description`	string	Descricao do estudo
`referring_physician`	string	Medico solicitante
`reporting_radiologist`	string	Radiologista responsavel
`institution`	string	Nome da instituicao
`critical_findings`	array	Lista de achados criticos
`word_count`	integer	Contagem de palavras
`character_count`	integer	Contagem de caracteres
`created_at`	string	Data de criacao (ISO 8601)
`updated_at`	string	Data de atualizacao (ISO 8601)

Status do Laudo

Valor	Descricao
`draft`	Rascunho, nao finalizado
`final`	Laudo final, pronto para envio ao PACS
`corrected`	Laudo corrigido apos envio inicial

Tipos de Exame Suportados

Codigo	Descricao
`CT`	Tomografia Computadorizada
`MR`	Ressonancia Magnetica
`US`	Ultrassonografia
`XR`	Radiografia Simples
`MG`	Mamografia
`NM`	Medicina Nuclear
`PT`	PET-CT
`CR`	Radiografia Computadorizada
`DX`	Radiografia Digital
`RF`	Fluoroscopia

Tratamento de Erros

Codigos de Erro

Codigo HTTP	Tipo	Descricao
`400`	`bad_request`	Requisicao malformada
`401`	`unauthorized`	API Key invalida ou ausente
`403`	`forbidden`	Sem permissao para este recurso
`404`	`not_found`	Laudo nao encontrado
`409`	`conflict`	Conflito (laudo ja enviado ao PACS)
`422`	`validation_error`	Erro de validacao nos campos
`429`	`rate_limited`	Limite de requisicoes excedido
`500`	`internal_error`	Erro interno do servidor

Exemplo de Resposta de Erro

{
  "error": {
    "code": "validation_error",
    "message": "O campo 'title' e obrigatorio",
    "details": {
      "field": "title",
      "reason": "required"
    }
  }
}

Tratamento em Codigo

import { LaudosAI, LaudosAIError } from '@laudosai/sdk';

try {
  const { data } = await client.reports.get('invalid-id');
} catch (error) {
  if (error instanceof LaudosAIError) {
    console.error(`Erro ${error.code}: ${error.message}`);

    if (error.isNotFoundError()) {
      console.log('Laudo nao encontrado');
    }
    if (error.isValidationError()) {
      console.log('Campos invalidos:', error.details);
    }
    if (error.isRateLimitError()) {
      console.log('Aguarde antes de tentar novamente');
    }
  }
}

Início

API Reference

Integrações

Reports API

Reports API

Base URL

Endpoints

Listar Laudos

Query Parameters

Exemplo

Resposta

Obter Laudo

Path Parameters

Exemplo

Resposta

Criar Laudo

Body Parameters

Exemplo

Resposta

Atualizar Laudo

Path Parameters

Body Parameters

Exemplo

Resposta

Excluir Laudo

Exemplo

Resposta

Objeto Report

Campos Completos

Status do Laudo

Tipos de Exame Suportados

Tratamento de Erros

Codigos de Erro

Exemplo de Resposta de Erro

Tratamento em Codigo

Início

API Reference

Integrações

​Reports API

​Base URL

​Endpoints

​Listar Laudos

​Query Parameters

​Exemplo

​Resposta

​Obter Laudo

​Path Parameters

​Exemplo

​Resposta

​Criar Laudo

​Body Parameters

​Exemplo

​Resposta

​Atualizar Laudo

​Path Parameters

​Body Parameters

​Exemplo

​Resposta

​Excluir Laudo

​Exemplo

​Resposta

​Objeto Report

​Campos Completos

​Status do Laudo

​Tipos de Exame Suportados

​Tratamento de Erros

​Codigos de Erro

​Exemplo de Resposta de Erro

​Tratamento em Codigo

Reports API

Base URL

Endpoints

Listar Laudos

Query Parameters

Exemplo

Resposta

Obter Laudo

Path Parameters

Exemplo

Resposta

Criar Laudo

Body Parameters

Exemplo

Resposta

Atualizar Laudo

Path Parameters

Body Parameters

Exemplo

Resposta

Excluir Laudo

Exemplo

Resposta

Objeto Report

Campos Completos

Status do Laudo

Tipos de Exame Suportados

Tratamento de Erros

Codigos de Erro

Exemplo de Resposta de Erro

Tratamento em Codigo