Exportar Relatório (Síncrono)

curl --location 'https://gyra-core.gyramais.com.br/report/export-sync/69a207bcdd0197828df9155a?format=pdf' \
--header 'Authorization: Bearer abc123'

curl --request GET \
  --url 'https://gyra-core.gyramais.com.br/report/export-sync/69a207bcdd0197828df9155a?type=REPORT&sectionOrder=LOCATION&sectionOrder=SUMMARY&sectionOrder=PEFIN' \
  --header 'Authorization: Bearer abc123'

fetch("https://gyra-core.gyramais.com.br/report/export-sync/69a207bcdd0197828df9155a?format=pdf", {
  method: "GET",
  headers: {
    "Authorization": "Bearer abc123",
  },
})
  .then(res => res.json())
  .then(console.log)

import requests

url = "https://gyra-core.gyramais.com.br/report/export-sync/69a207bcdd0197828df9155a"
headers = {"Authorization": "Bearer abc123"}
params = {"format": "pdf"}

response = requests.get(url, headers=headers, params=params)
print(response.json())

{
  "id": "69a207bcdd0197828df9155a",
  "url": "https://toolbox.gyramais.com.br/export/report/69a207bcdd0197828df9155a.pdf",
  "format": "pdf",
  "expiresAt": "2026-03-06T21:08:11.938Z"
}

{
  "code": 400,
  "message": "format must be one of the following values: pdf, excel, both"
}

{
  "code": 401,
  "message": "Token de acesso inválido."
}

{
  "code": 404,
  "message": "Report not found"
}

Quando usar

Use este endpoint para gerar e receber o arquivo de export (PDF, XLS ou ambos) de um relatório na mesma requisição. A chamada bloqueia até o arquivo estar pronto e retorna direto a URL para download. Para volumes grandes ou quando preferir não bloquear, use GET /report/export/{id} com webhook REPORT_EXPORTED.

Autenticação

Bearer JWT no header Authorization.

Parâmetros

Nome	Local	Tipo	Obrigatório	Descrição
`id`	`path`	`string`	`sim`	ID do relatório a exportar.
`format`	`query`	`string`	`não`	Formato do arquivo: `pdf`, `excel` ou `both`. Padrão: `pdf`.
`type`	`query`	`string`	`não`	Tipo de export: `REPORT` (completo) ou `REPORT_MINIFIED` (resumido). Padrão: `REPORT`.
`sectionOrder`	`query`	`string[]`	`não`	Lista ordenada de seções a serem incluídas no PDF. Cada seção é informada repetindo o parâmetro (ex.: `sectionOrder=LOCATION&sectionOrder=SUMMARY&sectionOrder=PEFIN`). Define quais seções aparecem e em que ordem. Se omitido, o relatório é exportado no layout default do sistema. Para a lista completa de seções suportadas, consulte o serviço `gyra-core`.

O parâmetro sectionOrder é opcional. Quando não enviado, o relatório é exportado no formato padrão do sistema. Quando enviado, o PDF contém apenas as seções listadas, exatamente na ordem informada.

curl --location 'https://gyra-core.gyramais.com.br/report/export-sync/69a207bcdd0197828df9155a?format=pdf' \
--header 'Authorization: Bearer abc123'

curl --request GET \
  --url 'https://gyra-core.gyramais.com.br/report/export-sync/69a207bcdd0197828df9155a?type=REPORT&sectionOrder=LOCATION&sectionOrder=SUMMARY&sectionOrder=PEFIN' \
  --header 'Authorization: Bearer abc123'

fetch("https://gyra-core.gyramais.com.br/report/export-sync/69a207bcdd0197828df9155a?format=pdf", {
  method: "GET",
  headers: {
    "Authorization": "Bearer abc123",
  },
})
  .then(res => res.json())
  .then(console.log)

import requests

url = "https://gyra-core.gyramais.com.br/report/export-sync/69a207bcdd0197828df9155a"
headers = {"Authorization": "Bearer abc123"}
params = {"format": "pdf"}

response = requests.get(url, headers=headers, params=params)
print(response.json())

O link retornado tem validade de 7 dias. Para geração em lote ou relatórios muito grandes, prefira a versão assíncrona (GET /report/export/{id}) para não segurar a conexão HTTP.

{
  "id": "69a207bcdd0197828df9155a",
  "url": "https://toolbox.gyramais.com.br/export/report/69a207bcdd0197828df9155a.pdf",
  "format": "pdf",
  "expiresAt": "2026-03-06T21:08:11.938Z"
}

{
  "code": 400,
  "message": "format must be one of the following values: pdf, excel, both"
}

{
  "code": 401,
  "message": "Token de acesso inválido."
}

{
  "code": 404,
  "message": "Report not found"
}

Exportar Relatório (Assíncrono)Consultar políticas de decisão

Primeiros Passos

Conceitos Fundamentais

Guia do Toolbox

Fontes de Dados

Guias

Casos de Uso

MCP Server

Referência da API

Dicionário de Dados

Integrações

Referência

Exportar Relatório (Síncrono)

Quando usar

Autenticação

Parâmetros

​Quando usar

​Autenticação

​Parâmetros

Quando usar

Autenticação

Parâmetros