Add an OpenAPI specification by URL

Submit an OpenAPI specification URL for documentation processing.

1 min read

post/v2/add/openapi

Request example

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

Response

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

post/v2/add/openapi

Authorization

Authorizationstringheaderrequired#

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

Body

application/json

openApiUrlstringrequired#

URL pointing to an OpenAPI specification (JSON or YAML)

Responses

application/json

Library submitted successfully for processing

libraryNamestringrequired#

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). See Library ID format.

messagestringrequired#

Human-readable success message

Add from other Git providers Upload an OpenAPI specification file