# OpenAPI and collections

Download the API's OpenAPI 3.1 contract, or the same requests ready to run in Postman, Insomnia or Bruno.

Source: https://docs.orbits.africa/api/postman-openapi

The reference is generated from the API's OpenAPI contract, and so are these downloads. They hold every endpoint an API token can call, and change when the API does.

| File | For |
| --- | --- |
| [orbits-api.yaml](https://docs.orbits.africa/openapi/orbits-api.yaml) | The OpenAPI 3.1 contract, YAML. For code generators, linters, mock servers and AI agents. |
| [orbits-api.json](https://docs.orbits.africa/openapi/orbits-api.json) | The same contract as JSON. |
| [orbits-api.postman_collection.json](https://docs.orbits.africa/postman/orbits-api.postman_collection.json) | A Postman collection (v2.1): one folder per reference page, each request with its example body. |
| [orbits-api.insomnia.json](https://docs.orbits.africa/insomnia/orbits-api.insomnia.json) | An Insomnia export of the same requests. |
| [orbits-api.bruno.zip](https://docs.orbits.africa/bruno/orbits-api.bruno.zip) | A Bruno collection: unzip it and open the folder in Bruno. |

Operations that are planned and not served yet have "(planned)" at the end of their summary in the contract.

## Postman

1. In Postman, choose **Import** and drop in `orbits-api.postman_collection.json`.
2. Open the collection's **Variables** and set `apiKey` to an API token from **Team › Settings › API tokens**. Put it in **Current value**, which stays on your machine, not **Initial value**, which is shared.
3. Send **Teams and account › Current user** to check the token.

The collection sends the token as a bearer token on every request, and a new `Idempotency-Key` on the `POST`s that take one. Slugs and ids in the example URLs (`my-team`, `my-app`, `dpl_…`) are placeholders: replace them with your own.

## Insomnia

Import `orbits-api.insomnia.json` (**Import** › **From file**), then set `apiKey` in the collection's base environment.

## Bruno

Unzip `orbits-api.bruno.zip` and open the `orbits-api` folder as a collection. Choose the **Production** environment and set its secret `apiKey`.

## Generating a client

Most OpenAPI generators read the contract as it is. Before you generate your own, look at the [official SDKs](https://docs.orbits.africa/sdks): they are built from the same contract and add retries, idempotency keys, pagination and waiting for deployments.
