Introducing the .apiorbit Format — A Smarter Way to Export and Share Your API Collections

API Orbit now has its own native file format for collections — the .apiorbit format.

It’s a lightweight, structured, and future-proof way to save, share, and restore your API collections across iPhone, iPad, and Mac.

This new format is designed specifically for API Orbit, ensuring that every detail of your collection is preserved exactly as you configured it — from headers and parameters to cache policies, SSL settings, and even GraphQL queries.

Why we created the .apiorbit format

Postman and OpenAPI are excellent standards, but they’re built for interoperability, not for mobile-first API testing.

API Orbit handles far more advanced features that those formats don’t fully support — like request caching, multipart uploads, local SSL overrides, dynamic authentication, and GraphQL queries.

The .apiorbit format was created to capture all of these details without loss, while keeping the data readable and easy to exchange.

What makes the .apiorbit format different

The .apiorbit file is a pure JSON document. It includes a clear schema, version information, and export timestamp. It stores only user-defined data — no internal database identifiers or redundant metadata. That makes it perfect for iCloud synchronization, manual backups, or sharing collections between devices.

Example structure:

JSON
{
  "format": "APIOrbitCollection",
  "version": "1.0",
  "exportedAt": "2025-10-08T14:17:39Z",
  "collection": {
    "title": "Audio API",
    "about": "Requests used for audio processing endpoints",
    "auth": {
      "type": "bearerToken",
      "bearerToken": "abc123",
      "username": "",
      "password": "",
      "apiKeyKey": "",
      "apiKeyValue": "",
      "apiKeyPlacement": "header"
    },
    "cachePolicy": "useProtocolCachePolicy",
    "variables": [],
    "requests": [...]
  }
}

Request Structure in .apiorbit

Each request within a collection is represented as a flat JSON object that includes all configuration details. This makes it easy to export, inspect, or re-import without losing any part of the setup.

Example request:

JSON
{
  "title": "Upload Audio File",
  "method": "post",
  "url": "https://api.example.com/upload",
  "headers": [
    { "key": "Content-Type", "value": "multipart/form-data" },
    { "key": "Authorization", "value": "Bearer {{token}}" }
  ],
  "parameters": [
    { "key": "quality", "value": "high" }
  ],
  "bodyType": "multipart",
  "bodyUploadFilename": null,
  "bodyJson": "",
  "bodyText": "",
  "bodyParameters": [],
  "multipartBodyParameters": [
    { "key": "metadata", "value": "{\"title\":\"Track 01\"}" }
  ],
  "multipartFiles": [
    { "key": "file", "value": "" }
  ],
  "graphQLQuery": "",
  "graphQLVariables": [],
  "followRedirects": false,
  "allowUnsecuredSSL": false,
  "auth": {
    "type": "bearerToken",
    "bearerToken": "{{token}}",
    "username": "",
    "password": "",
    "apiKeyKey": "",
    "apiKeyValue": "",
    "apiKeyPlacement": "header"
  },
  "cachePolicy": "useProtocolCachePolicy"
}

Exporting Collections

Exporting a collection is straightforward. Open a collection, tap Share or Export, and API Orbit generates a .apiorbit file that you can save, send, or keep in iCloud Drive.

Each exported file is a complete, self-contained snapshot of your collection — ideal for backups or collaboration.

Importing Collections

There are two simple ways to import a collection:

Tap the Import button inside API Orbit and select an .apiorbit file.
Open a .apiorbit file directly from the Files app or any other app.

API Orbit will launch automatically and import the collection instantly.

There’s no configuration or manual steps — the app reads the file and restores your collection as it was.

Compatibility

The .apiorbit format is supported on all platforms — iOS, iPadOS, macOS, and visionOS starting from version 26.0.4.

Importing from Postman, Swagger, and OpenAPI continues to work as before, but .apiorbit provides a faster, native, and more complete way to transfer your data.

With the .apiorbit format, your collections are portable, precise, and future-ready — exactly how modern API development should be.

1 thought on “Introducing the .apiorbit Format — A Smarter Way to Export and Share Your API Collections”

  1. Pingback: API Orbit 26.0.4 is out! - API Orbit - Rest & GraphQL Client

Leave a Comment

Scroll to Top