---
title: "Generate OpenAPI v3 document"
method: GET
path: "/help/openapi"
tags: ["Help"]
---

# Generate OpenAPI v3 document

`GET /help/openapi`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/help/openapi`
- Auth: none declared

Generates an OpenAPI v3.1.0 document for Itential Platform.

## Query parameters

- `url` string

## Response `200`

An OpenAPI v3 document containing all IAP routes

- HelpGetOpenApiResponse200

## Other responses

- `500`: Error response from API

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)