Get an Ask site

curl --request GET \
  --url https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites/{siteKey} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites/{siteKey}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites/{siteKey}', 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/{siteKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites/{siteKey}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites/{siteKey}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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_teamspace",
  "message": "Invalid teamspace id"
}

{
  "error": "invalid_api_key",
  "message": "Invalid API key. Please check your API key. API keys should start with 'ctx7sk' prefix."
}

{
  "error": "forbidden",
  "message": "You do not have access to this teamspace."
}

{
  "error": "no_site",
  "message": "Site not found."
}

{
  "error": "internal_error",
  "message": "An error occurred while processing your request"
}

GET

teamspaces

{teamspaceId}

ask-sites

{siteKey}

Get an Ask site

curl --request GET \
  --url https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites/{siteKey} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites/{siteKey}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites/{siteKey}', 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/{siteKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites/{siteKey}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://context7.com/api/v2/teamspaces/{teamspaceId}/ask-sites/{siteKey}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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_teamspace",
  "message": "Invalid teamspace id"
}

{
  "error": "invalid_api_key",
  "message": "Invalid API key. Please check your API key. API keys should start with 'ctx7sk' prefix."
}

{
  "error": "forbidden",
  "message": "You do not have access to this teamspace."
}

{
  "error": "no_site",
  "message": "Site not found."
}

{
  "error": "internal_error",
  "message": "An error occurred while processing your request"
}

Authorizations

Authorization

string

header

required

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

teamspaceId

string<uuid>

required

Teamspace id (uuid).

siteKey

string

required

The site's public key, which is also its id.

Pattern: ^ask_[0-9a-f]{24}$

Response

The site

data

object

required

Show child attributes