> For the complete documentation index, see [llms.txt](https://shinkalabs.gitbook.io/hub/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://shinkalabs.gitbook.io/hub/andromeda/api-reference/openapi.md).

# OpenAPI explorer

The canonical machine-readable description of the API is the OpenAPI 3.1 document:

<https://api.andromedainfra.pro/openapi.json>

It is generated from the same route catalogue that serves the live API, so it never drifts from what the endpoints actually accept. When this documentation and the spec disagree, the spec wins.

## Use it interactively

* **In GitBook.** This page can host GitBook's native OpenAPI block, which renders every operation with a "try it" panel. To wire it, add the spec URL as an OpenAPI source in the GitBook organisation settings and embed it here.
* **In Swagger UI / Redoc / Stoplight.** Point any OpenAPI viewer at the URL above.
* **In Postman / Insomnia.** Import the URL to get a ready-made request collection. A curated Postman collection also ships with the project; see [Postman collection](/hub/andromeda/sdks-and-tooling/postman.md).

## Generate a client

Run an OpenAPI generator against the spec to get a typed client in your language. See [OpenAPI codegen](/hub/andromeda/sdks-and-tooling/codegen.md). For a typed TypeScript client tailored to a specific deployed policy, see [Typed TypeScript client](/hub/andromeda/sdks-and-tooling/ts-client.md).

## What is in it

Every operation, with parameters, request and response schemas, status codes, and which scope it requires. Public operations (`/capabilities`, `/openapi.json`, `/v1/pricing`) are marked as needing no authentication; everything else expects `X-Api-Key`.

## What is not in it

Internal and operational endpoints are not part of the public spec. The spec covers the customer-facing surface only.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://shinkalabs.gitbook.io/hub/andromeda/api-reference/openapi.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.