Add a GitHub repository

Submit a GitHub repository for documentation processing. Supports private repos via a gitToken or by connecting your GitHub account at https://context7.com/add-library.

POST /v2/add/repo/github

Add a GitHub repository

cURL

curl --request POST \
  --url https://context7.com/api/v2/add/repo/github \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "docsRepoUrl": "https://github.com/vercel/next.js"
}
'

import requests

url = "https://context7.com/api/v2/add/repo/github"

payload = { "docsRepoUrl": "https://github.com/vercel/next.js" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({docsRepoUrl: 'https://github.com/vercel/next.js'})
};

fetch('https://context7.com/api/v2/add/repo/github', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://context7.com/api/v2/add/repo/github",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'docsRepoUrl' => 'https://github.com/vercel/next.js'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://context7.com/api/v2/add/repo/github"

	payload := strings.NewReader("{\n  \"docsRepoUrl\": \"https://github.com/vercel/next.js\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://context7.com/api/v2/add/repo/github")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"docsRepoUrl\": \"https://github.com/vercel/next.js\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://context7.com/api/v2/add/repo/github")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"docsRepoUrl\": \"https://github.com/vercel/next.js\"\n}"

response = http.request(request)
puts response.read_body

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

Request body for adding a Git repository

docsRepoUrl · string<uri> · required

The repository URL

gitToken · string

Personal access token for private repositories. If not provided, the token from your OAuth connection at https://context7.com/add-library is used.

private · boolean

Whether the repository is private

skipVersionFiltering · boolean

Skip filtering out version-specific documentation pages

generateDocs · boolean

Generate documentation from the repository source code. Applies to private repository submissions.

Response

200

application/json

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