Transform collection to OpenAPI

View as Markdown

Transforms an existing Postman Collection into a stringified OpenAPI definition.

Note:

This does not create an API.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

collectionIdstringRequired
The collection's ID.

Query parameters

formatenumOptionalDefaults to json
Return the OpenAPI definition in the given format.
Allowed values:

Response

Successful Response
outputstring
The collection's transformed output, in a stringified OpenAPI JSON or YAML format.

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error