Upload an OpenAPI specification file

Upload an OpenAPI specification file (JSON or YAML) for documentation processing. Requires a team project. File size limit is 10MB.

1 min read

post/v2/add/openapi-upload

Request example

curl --request POST \
  --url https://context7.com/api/v2/add/openapi-upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'openapiFile=<file>' \
  --form 'libraryTitle=<string>' \
  --form 'description=<string>' \
  --form 'force=true'

Response

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

post/v2/add/openapi-upload

Authorization

Authorizationstringheaderrequired#

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

Body

multipart/form-data

openapiFilefilerequired#

The OpenAPI specification file (.json, .yaml, or .yml)

libraryTitlestring#

Custom title for the library

descriptionstring#

Description of the library

forceenum<string>#

Set to 'true' to force reprocessing

Options:true

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 an OpenAPI specification by URL Add an llms.txt file