Skip to main content
POST
/
v2
/
add
/
openapi
Add an OpenAPI specification by URL
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"
}
'
{
  "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

Library submitted successfully for processing

Response after successfully submitting a library

​
libraryName
string
required

The library identifier assigned — the URL path of the library on context7.com. /owner/repo for GitHub repositories, or /<source>/<id> for other sources (e.g., /vercel/next.js, /websites/uploadcare_com). See Library ID format.

​
message
string
required

Human-readable success message