Skip to main content
POST
/
parse-openapi-upload
Upload an OpenAPI spec file
curl --request POST \
  --url https://your-instance.example.com/api/parse-openapi-upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form openapiFile='@example-file'
{
  "message": "Parse queued",
  "project": "/your-org/your-repo",
  "queueId": 5,
  "position": 1
}

Authorizations

​
Authorization
string
header
required

API key generated from Personal Settings. See Authentication.

Body

multipart/form-data
​
openapiFile
file
required

A .json or .yaml OpenAPI specification file

Response

Parse job accepted and queued

​
message
string
required
Example:

"Parse queued"

​
project
string
required

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

Example:

"/your-org/your-repo"

​
queueId
integer
required

Numeric ID for this parse job

Example:

5

​
position
integer | null

Position in the queue. null if the job started immediately

Example:

1