---
title: "OpenAPI"
description: "Fetch the MachineMail OpenAPI 3.1 document as JSON from GET /v0/openapi.json, with no authentication, to generate clients or load the API into your tools."
canonical: "https://machinemail.dev/docs/reference/api/openapi"
---

# OpenAPI

> Fetch the MachineMail OpenAPI 3.1 document as JSON from GET /v0/openapi.json, with no authentication, to generate clients or load the API into your tools.

Source: https://machinemail.dev/docs/reference/api/openapi

| Method | Path               | Summary                                       |
| ------ | ------------------ | --------------------------------------------- |
| `GET`  | `/v0/openapi.json` | [Get OpenAPI Document](#get-openapi-document) |

## Get OpenAPI Document

```http
GET /v0/openapi.json
```

This OpenAPI 3.1 document, as JSON. No authentication.

**Authentication:** None.

#### Response

**200** The OpenAPI document (`application/json`)

Type: `Record<string, unknown>`

#### Errors

| Status | Meaning                  |
| ------ | ------------------------ |
| `500`  | Unexpected server error. |

#### Example

```bash title="Request"
curl "https://api.machinemail.dev/v0/openapi.json"
```

```json title="Response 200"
{
  "key": "value"
}
```