Skip to main content
POST
Parse an OpenAPI spec by URL

Authorizations

Authorization
string
header
required

API key generated from Personal Settings. See Authentication.

Body

application/json
openApiUrl
string<uri>
required

URL of a JSON or YAML OpenAPI specification

projectTitle
string

Display name for the project

description
string

Short description shown in the library list

force
boolean
default:false

Re-parse even if already indexed

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