Arquivos · Referência

Documentos IA

Documentos gerados pela IA (notificações, cartas, relatórios).

Permissão: documentos_iaAções: ler2 campo(s) LGPDglobal (sem carteira)

GET/v1/documentos_iaListar GET/v1/documentos_ia/{id}Detalhar

O objeto documentos ia

Campo	Tipo	Descrição
`id`	inteiro	Identificador	ordenar
`doc_type`	texto	doc type	filtro
`ref_type`	texto	ref type	filtro
`ref_id`	inteiro	ref id	filtro
`title`	texto	title
`content_text`	texto	content text	LGPD
`sent_to`	texto	sent to	LGPD
`sent_at`	data-hora	sent at
`status`	texto (enum)	Situação `draft` `sent` `signed` `archived`	filtro
`generated_by_user_id`	inteiro	generated by user id
`created_at`	data-hora	Criado em	ordenar

Exemplo do objeto200 OK

{
    "id": 1024,
    "doc_type": "texto",
    "ref_type": "texto",
    "ref_id": 512,
    "title": "Acordo de multas",
    "content_text": "texto",
    "sent_to": "texto",
    "sent_at": "2026-10-08T14:30:00-03:00",
    "status": "draft",
    "generated_by_user_id": 512,
    "created_at": "2026-10-08T14:30:00-03:00"
}

GET Listar

Retorna os registros paginados, do mais recente para o mais antigo (padrão). Requer Ler.

Parâmetros de consulta

Parâmetro	Tipo	Descrição
`pagina`	inteiro	Página (padrão 1)
`por_pagina`	inteiro	1 a 200 (padrão 50)
`ordenar`	texto	Aceita: `id`, `created_at` — prefixo `-` para decrescente
`campos`	texto	Lista de campos do objeto, separados por vírgula
`doc_type`	texto	doc type — valor exato ou lista separada por vírgula
`ref_type`	texto	ref type — valor exato ou lista separada por vírgula
`ref_id`	inteiro	ref id — valor exato ou lista separada por vírgula
`status`	texto (enum)	Situação — valor exato ou lista separada por vírgula `draft` `sent` `signed` `archived`
`criado_desde` / `criado_ate`	data	Período de criação
`atualizado_desde`	data-hora	Criados ou alterados desde (considera a data de criação)

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/documentos_ia?por_pagina=20" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/documentos_ia?por_pagina=20');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/documentos_ia?por_pagina=20', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/documentos_ia?por_pagina=20",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": [
        {
            "id": 1024,
            "doc_type": "texto",
            "ref_type": "texto",
            "ref_id": 512,
            "title": "Acordo de multas",
            "content_text": "texto",
            "sent_to": "texto",
            "sent_at": "2026-10-08T14:30:00-03:00"
        }
    ],
    "meta": {
        "total": 1,
        "pagina": 1,
        "por_pagina": 20,
        "paginas": 1
    },
    "request_id": "req_0f1e2d3c4b5a69788796"
}

GET Detalhar

Retorna um registro pelo id. Requer Ler.

Erro	Quando
`404 nao_encontrado`	Não existe ou está fora das carteiras da chave
`403 permissao_negada`	Sem Ler no módulo (ou numa relação pedida)

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/documentos_ia/1024" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/documentos_ia/1024');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/documentos_ia/1024', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/documentos_ia/1024",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "doc_type": "texto",
        "ref_type": "texto",
        "ref_id": 512,
        "title": "Acordo de multas",
        "content_text": "texto",
        "sent_to": "texto",
        "sent_at": "2026-10-08T14:30:00-03:00"
    },
    "request_id": "req_1d2c3b4a5f6e7d8c9b0a"
}