Add an OpenAPI specification by URL

Submit an OpenAPI specification URL for documentation processing.

POST /v2/add/openapi

Add an OpenAPI specification by URL

cURL

curl --request POST \
  --url https://context7.com/api/v2/add/openapi \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "openApiUrl": "https://api.example.com/openapi.json"
}
'

200

Example

{
  "libraryName": "/owner/repo",
  "message": "Repository submitted successfully"
}

Authorizations

Authorization · string · header · required

Get your API key at context7.com/dashboard. Treat your API key like a password and store it securely.

Body

application/json

openApiUrl · string<uri> · required

URL pointing to an OpenAPI specification (JSON or YAML)

Response

200

application/json

Library submitted successfully for processing

Response after successfully submitting a library

libraryName · string · required

The library identifier assigned (e.g., /owner/repo)

message · string · required

Human-readable success message