---
title: "Get the OpenAPI description"
description: "Returns an OpenAPI 3.1 description of this API."
url: https://beacon-arodoni.vercel.app/api-reference/get-open-api
---

# Get the OpenAPI description

`GET /openapi.json`

Base URL: `https://example.com/api/v1`

Returns an OpenAPI 3.1 description of this API.

## Responses

### 200

An OpenAPI 3.1 document

Content type: `application/json`

```json
{}
```

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://example.com/api/v1/openapi.json'
```

### JavaScript

```javascript
const response = await fetch("https://example.com/api/v1/openapi.json", {
  method: "GET",
});

console.log(await response.json());
```

### Python

```python
import requests

response = requests.request(
    "GET",
    "https://example.com/api/v1/openapi.json",
)

print(response.json())
```