curl --request POST \
--url https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/connect \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"repoUrl": "<string>",
"branch": "<string>",
"docsPath": "<string>",
"context7Index": true
}
'import requests
url = "https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/connect"
payload = {
"repoUrl": "<string>",
"branch": "<string>",
"docsPath": "<string>",
"context7Index": True
}
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({
repoUrl: '<string>',
branch: '<string>',
docsPath: '<string>',
context7Index: true
})
};
fetch('https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/connect', 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}/sites/{siteId}/connect",
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([
'repoUrl' => '<string>',
'branch' => '<string>',
'docsPath' => '<string>',
'context7Index' => true
]),
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}/sites/{siteId}/connect"
payload := strings.NewReader("{\n \"repoUrl\": \"<string>\",\n \"branch\": \"<string>\",\n \"docsPath\": \"<string>\",\n \"context7Index\": true\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}/sites/{siteId}/connect")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"repoUrl\": \"<string>\",\n \"branch\": \"<string>\",\n \"docsPath\": \"<string>\",\n \"context7Index\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/connect")
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 \"repoUrl\": \"<string>\",\n \"branch\": \"<string>\",\n \"docsPath\": \"<string>\",\n \"context7Index\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}Connect a CLI site to GitHub
Changes a site deployed from the CLI to build from a GitHub repository, keeping its id and address. The Docs7 GitHub App must be installed on the repository.
curl --request POST \
--url https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/connect \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"repoUrl": "<string>",
"branch": "<string>",
"docsPath": "<string>",
"context7Index": true
}
'import requests
url = "https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/connect"
payload = {
"repoUrl": "<string>",
"branch": "<string>",
"docsPath": "<string>",
"context7Index": True
}
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({
repoUrl: '<string>',
branch: '<string>',
docsPath: '<string>',
context7Index: true
})
};
fetch('https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/connect', 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}/sites/{siteId}/connect",
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([
'repoUrl' => '<string>',
'branch' => '<string>',
'docsPath' => '<string>',
'context7Index' => true
]),
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}/sites/{siteId}/connect"
payload := strings.NewReader("{\n \"repoUrl\": \"<string>\",\n \"branch\": \"<string>\",\n \"docsPath\": \"<string>\",\n \"context7Index\": true\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}/sites/{siteId}/connect")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"repoUrl\": \"<string>\",\n \"branch\": \"<string>\",\n \"docsPath\": \"<string>\",\n \"context7Index\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}/connect")
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 \"repoUrl\": \"<string>\",\n \"branch\": \"<string>\",\n \"docsPath\": \"<string>\",\n \"context7Index\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}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.
Docs7 site id.
Body
Docs folder, . for the root.
Also keep the docs on Context7.
Response
The connected site
Was this page helpful?