API ReferenceSpecs

Generate spec from collection

View as MarkdownOpen in Claude
Generates an OpenAPI 2.0, 3.0, or 3.1 specification for the given collection. The response contains a polling link to the task status.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

collectionUidstringRequiredformat: "uid"
The collection's unique ID.
elementTypeenumRequired

The spec value.

Allowed values:

Request

This endpoint expects an object.
namestringRequired
The API specification's name.
typeenumOptional
The specification's type.
Allowed values:
formatenumOptional
The format of the API specification.
Allowed values:

Response

Successful Response
taskIdstringOptional
The created task ID. You can use this ID to track the status of the task.
urlstringOptional
The URL to get or poll the status of a generated spec task.

Errors

403
Forbidden Error
404
Not Found Error
423
Locked Error
500
Internal Server Error