Skip to main content
posthttps://your-instance.example.com/api/parse-openapi-upload
Request example
Response
posthttps://your-instance.example.com/api/parse-openapi-upload

Authorization

Authorizationstringheaderrequired#
API key generated from Personal Settings. See Authentication.

Body

multipart/form-data
openapiFilefilerequired#
A .json or .yaml OpenAPI specification file

Responses

application/json
Parse job accepted and queued
messagestringrequired#

Example:"Parse queued"

projectstringrequired#
Project identifier assigned to this library (e.g. /your-org/your-repo)

Example:"/your-org/your-repo"

queueIdintegerrequired#
Numeric ID for this parse job

Example:5

positioninteger#
Position in the queue. null if the job started immediately

Example:1