Add an Ask site
curl --request POST \
--url https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://docs.example.com"
}
'import requests
url = "https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites"
payload = { "url": "https://docs.example.com" }
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({url: 'https://docs.example.com'})
};
fetch('https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites', 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}/ask-sites",
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([
'url' => 'https://docs.example.com'
]),
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}/ask-sites"
payload := strings.NewReader("{\n \"url\": \"https://docs.example.com\"\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}/ask-sites")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://docs.example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites")
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 \"url\": \"https://docs.example.com\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"siteKey": "ask_0123456789abcdef01234567",
"url": "https://docs.example.com",
"hostname": "docs.example.com",
"verification": {
"kind": "pending"
},
"indexStatus": {
"kind": "pending"
},
"verificationTag": "<meta name=\"context7-site-verification\" content=\"ask_0123456789abcdef01234567\">",
"snippet": "<string>",
"markdown": "<string>",
"endpoint": "https://context7.com/api/v2/ask?siteKey=ask_0123456789abcdef01234567"
}
}{
"error": "invalid_payload",
"message": "Enter a public hostname, for example https://docs.example.com."
}{
"error": "invalid_api_key",
"message": "Invalid API key. Please check your API key. API keys should start with 'ctx7sk' prefix."
}{
"error": "site_limit",
"message": "Your plan includes 3 sites. Upgrade to add more."
}{
"error": "site_exists",
"message": "This teamspace already has this site."
}{
"error": "internal_error",
"message": "An error occurred while processing your request"
}Ask Sites
Add an Ask site
Register a website. The response holds the <meta> verification tag for the site’s <head> and the hidden note for the top of <body>. Add both to the site, deploy, then call verify. Free teamspaces allow 3 sites; paid plans have no site limit. Owner or admin.
POST
/
v2
/
teamspaces
/
{teamspaceId}
/
ask-sites
Add an Ask site
curl --request POST \
--url https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://docs.example.com"
}
'import requests
url = "https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites"
payload = { "url": "https://docs.example.com" }
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({url: 'https://docs.example.com'})
};
fetch('https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites', 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}/ask-sites",
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([
'url' => 'https://docs.example.com'
]),
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}/ask-sites"
payload := strings.NewReader("{\n \"url\": \"https://docs.example.com\"\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}/ask-sites")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://docs.example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites")
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 \"url\": \"https://docs.example.com\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"siteKey": "ask_0123456789abcdef01234567",
"url": "https://docs.example.com",
"hostname": "docs.example.com",
"verification": {
"kind": "pending"
},
"indexStatus": {
"kind": "pending"
},
"verificationTag": "<meta name=\"context7-site-verification\" content=\"ask_0123456789abcdef01234567\">",
"snippet": "<string>",
"markdown": "<string>",
"endpoint": "https://context7.com/api/v2/ask?siteKey=ask_0123456789abcdef01234567"
}
}{
"error": "invalid_payload",
"message": "Enter a public hostname, for example https://docs.example.com."
}{
"error": "invalid_api_key",
"message": "Invalid API key. Please check your API key. API keys should start with 'ctx7sk' prefix."
}{
"error": "site_limit",
"message": "Your plan includes 3 sites. Upgrade to add more."
}{
"error": "site_exists",
"message": "This teamspace already has this site."
}{
"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).
Body
application/json
Public http(s) address of the site. The query string and fragment are dropped; a path such as /docs is kept.
Example:
"https://docs.example.com"
Response
The new site
Show child attributes
Show child attributes
Was this page helpful?