curl --request POST \
--url https://context7.com/api/v2/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"context7JsonUrl": "<string>"
}
'import requests
url = "https://context7.com/api/v2/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim"
payload = { "context7JsonUrl": "<string>" }
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({context7JsonUrl: '<string>'})
};
fetch('https://context7.com/api/v2/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim', 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/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim",
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([
'context7JsonUrl' => '<string>'
]),
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/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim"
payload := strings.NewReader("{\n \"context7JsonUrl\": \"<string>\"\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/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"context7JsonUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://context7.com/api/v2/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim")
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 \"context7JsonUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"libraryName": "<string>",
"ownership": {
"id": "<string>",
"libraryName": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"error": "invalid_request",
"message": "URL mismatch The url in context7.json must be \"https://context7.com/acme/docs\""
}{
"error": "invalid_api_key",
"message": "Invalid API key. Please check your API key. API keys should start with 'ctx7sk' prefix."
}{
"error": "forbidden",
"message": "The public_key in context7.json does not match your team's public key"
}{
"error": "library_not_found",
"message": "Library not found."
}{
"error": "conflict",
"message": "This library is already claimed by another teamspace"
}{
"error": "internal_error",
"message": "An error occurred while processing your request"
}Verify a claim
Read the published context7.json. When its url and public_key match, the library becomes owned by this teamspace. Libraries on shared hosting platforms cannot be claimed automatically.
curl --request POST \
--url https://context7.com/api/v2/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"context7JsonUrl": "<string>"
}
'import requests
url = "https://context7.com/api/v2/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim"
payload = { "context7JsonUrl": "<string>" }
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({context7JsonUrl: '<string>'})
};
fetch('https://context7.com/api/v2/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim', 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/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim",
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([
'context7JsonUrl' => '<string>'
]),
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/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim"
payload := strings.NewReader("{\n \"context7JsonUrl\": \"<string>\"\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/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"context7JsonUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://context7.com/api/v2/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim")
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 \"context7JsonUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"libraryName": "<string>",
"ownership": {
"id": "<string>",
"libraryName": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"error": "invalid_request",
"message": "URL mismatch The url in context7.json must be \"https://context7.com/acme/docs\""
}{
"error": "invalid_api_key",
"message": "Invalid API key. Please check your API key. API keys should start with 'ctx7sk' prefix."
}{
"error": "forbidden",
"message": "The public_key in context7.json does not match your team's public key"
}{
"error": "library_not_found",
"message": "Library not found."
}{
"error": "conflict",
"message": "This library is already claimed by another teamspace"
}{
"error": "internal_error",
"message": "An error occurred while processing your request"
}Authorizations
Get your API key at context7.com/dashboard. Treat your API key like a password and store it securely. Every key can read the management API (/v2/teamspaces/*), except personal data: member and invitation emails, library requesters, visitor questions, Docs7 reader searches, conversations, feedback and feature requests, and the GitHub account behind a build. To read those or make changes there, the key must be created with Write access ticked; other keys get 403 write_access_required.
Path Parameters
Teamspace id (uuid).
First segment of the library id /owner/repo (for example vercel in /vercel/next.js, websites in /websites/docs_example_com). Case-insensitive.
Second segment of the library id /owner/repo. Case-insensitive.
Body
URL of the published file. Required for hostedFile, and for a repository on a host other than GitHub, GitLab or Bitbucket (the raw file URL).
Repositories: where the parser reads settings from after the claim. Default dashboard.
dashboard, context7json Was this page helpful?