GET /openapi.json · cnpj.ia.br

Documento OpenAPI 3.1. Sem autenticação. Cache público de 1 hora. Permanece disponível na janela de manutenção da base.

Créditos

chamada · 0 créditos

Respostas

200 OK

Documento OpenAPI 3.1.

Header	Tipo	Descrição
`X-Request-Id`	`string`	Identificador da requisição para suporte.
`X-Client-Request-Id`	`string`	Eco do X-Request-Id enviado pelo cliente quando casa ^[A-Za-z0-9_-]{8,64}$. Ausente se o cliente não enviou ou o valor é inválido. Nunca usado como identificador interno.
`Cache-Control`	`string`	Cache público de 1 hora.

{
  "openapi": "3.1.0",
  "info": {
    "title": "cnpj.ia.br API",
    "version": "1.0.0-draft.4"
  }
}

404 Não encontrado

API desligada (CNPJIA_API_ENABLED diferente de on).

Header	Tipo	Descrição
`X-Request-Id`	`string`	Identificador da requisição para suporte.
`X-Client-Request-Id`	`string`	Eco do X-Request-Id enviado pelo cliente quando casa ^[A-Za-z0-9_-]{8,64}$. Ausente se o cliente não enviou ou o valor é inválido. Nunca usado como identificador interno.

{
  "error": {
    "code": "not_found",
    "message": "Recurso não encontrado.",
    "request_id": "req_01J8ZK3Q9X",
    "retryable": false,
    "docs_url": "https://cnpj.ia.br/docs/erros-e-retentativas#not_found"
  }
}

500 Erro interno

Erro não previsto ao ler o documento. retryable: true; esta operação não consome créditos.

Header	Tipo	Descrição
`X-Request-Id`	`string`	Identificador da requisição para suporte.
`X-Client-Request-Id`	`string`	Eco do X-Request-Id enviado pelo cliente quando casa ^[A-Za-z0-9_-]{8,64}$. Ausente se o cliente não enviou ou o valor é inválido. Nunca usado como identificador interno.

{
  "error": {
    "code": "internal_error",
    "message": "Erro interno. Tente novamente; se persistir, fale com o suporte.",
    "request_id": "req_01J8ZK3Q9X",
    "retryable": true,
    "docs_url": "https://cnpj.ia.br/docs/erros-e-retentativas#internal_error"
  }
}

Exemplo

curl -s "https://api.cnpj.ia.br/openapi.json"