---
title: "overlane api openapi"
description: "Read the OpenAPI 3.1 document the API serves"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# overlane api openapi

{/* Generated by apps/docs/scripts/generate.mjs (CLI pages from the command registry in packages/cli). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

Fetches the OpenAPI document generated from the API route tables and the contracts. By default prints its version and counts; with --full the JSON result carries the whole document. The same document is committed at docs/api/openapi.json and the TypeScript SDK is generated from it.

## Usage

```sh
overlane api openapi [--service URL] [--full]
```

## Flags

| Flag | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `--service` | string | no |  | The service address (default: OVERLANE_SERVICE_URL, then the project's binding, then the hosted service) |
| `--full` | boolean | no |  | Include the whole document in the JSON result |

## Examples

```sh
overlane api openapi
overlane api openapi --full --json
```

## Behavior

- Effect: `read` (changes nothing).
- Needs credentials: yes. Uses the network: yes.
- Supports `--dry-run`: no. Accepts `--force`: no.
- Machine-readable description: `overlane schema api openapi`.

## Result

With `--json` (the default when stdout is not a terminal) the command prints this JSON Schema's shape on stdout.

```json
{
  "type": "object",
  "properties": {
    "version": {
      "type": "string"
    },
    "operations": {
      "type": "number"
    },
    "schemas": {
      "type": "number"
    },
    "document": {}
  },
  "required": [
    "version",
    "operations",
    "schemas"
  ],
  "additionalProperties": false
}
```

See [exit codes](/cli/#exit-codes) for the status the process returns.

Source: https://docs.overlane.app/cli/api-openapi/index.mdx