Skip to main content

OpenAPI Specification

The Portal API is defined by an OpenAPI (Swagger) specification in JSON format. You can download the raw spec to generate HTTP client libraries, use it with API tools, or provide it to an LLM.

Download​

The file is a standard Swagger 2.0 JSON document. Endpoints are grouped by resource tag.

Download OpenAPI Spec

Use with client generators​

OpenAPI Generator generates typed HTTP clients from the specification. The following example generates a Python client:

curl -O https://docs.aur.lu/portal-api-spec.json && \
npx @openapitools/openapi-generator-cli generate \
  -i portal-api-spec.json \
  -g python \
  -o ./aurora-portal-client

Use with an LLM​

Upload or paste the spec file into your preferred LLM and ask it to write code against the API. The specification describes the available endpoints and their documented request and response schemas. Review generated code before using it in production.

Use with API tools​

Tools like Postman, Insomnia, and Bruno can import the spec URL directly:

https://docs.aur.lu/portal-api-spec.json