Add Library

Add an OpenAPI specification by URL

Changed on

Submit an OpenAPI specification URL for documentation processing.

post/v2/add/openapi

Request

  • Base URL
    https://context7.com/api
  • URL
    https://context7.com/api/v2/add/openapi
  • Auth
    HTTP bearer

Request body

openApiUrlstring uri required

URL pointing to an OpenAPI specification (JSON or YAML)

Response

Library submitted successfully for processing

libraryNamestring 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.

versionstring

Only for websites: the version the URL was added as, when it is a version of an existing library. Request it as <libraryName>/<version>.

messagestring required

Human-readable success message

Changes