Context7 Platform -- Up-to-date docs for AI agents
import type { LibrarySearchResponse, ContextResponse } from "../types.js";
import { VERSION } from "../constants.js";
export const DEFAULT_CONTEXT7_BASE_URL = "https://context7.com";
let baseUrl = DEFAULT_CONTEXT7_BASE_URL;
export function getBaseUrl(): string {
return baseUrl;
}
export function setBaseUrl(url: string): void {
baseUrl = url;
}
function getAuthHeaders(accessToken?: string): Record<string, string> {
const headers: Record<string, string> = {
"X-Context7-Source": "cli",
"X-Context7-Client-IDE": "ctx7-cli",
"X-Context7-Client-Version": VERSION,
"X-Context7-Transport": "cli",
};
const apiKey = process.env.CONTEXT7_API_KEY;
if (apiKey) {
headers["Authorization"] = `Bearer ${apiKey}`;
} else if (accessToken) {
headers["Authorization"] = `Bearer ${accessToken}`;
}
return headers;
}
export async function resolveLibrary(
libraryName: string,
query?: string,
accessToken?: string
): Promise<LibrarySearchResponse> {
const params = new URLSearchParams({ libraryName });
if (query) {
params.set("query", query);
}
const response = await fetch(`${baseUrl}/api/v2/libs/search?${params}`, {
headers: getAuthHeaders(accessToken),
});
if (!response.ok) {
const errorData = (await response.json().catch(() => ({}))) as {
error?: string;
message?: string;
};
return {
results: [],
error: errorData.error || `HTTP error ${response.status}`,
message: errorData.message,
};
}
return (await response.json()) as LibrarySearchResponse;
}
export interface GetContextOptions {
type?: "json" | "txt";
language?: string;
}
export async function getLibraryContext(
libraryId: string,
query: string,
options?: GetContextOptions,
accessToken?: string
): Promise<ContextResponse | string> {
const params = new URLSearchParams({ libraryId, query });
if (options?.type) {
params.set("type", options.type);
}
if (options?.language) {
params.set("language", options.language);
}
const headers = getAuthHeaders(accessToken);
const response = await fetch(`${baseUrl}/api/v2/context?${params}`, {
headers,
});
if (!response.ok) {
const errorData = (await response.json().catch(() => ({}))) as {
error?: string;
message?: string;
redirectUrl?: string;
};
if (response.status === 301 && errorData.redirectUrl) {
return {
codeSnippets: [],
infoSnippets: [],
error: errorData.error || "library_redirected",
message: errorData.message,
redirectUrl: errorData.redirectUrl,
};
}
return {
codeSnippets: [],
infoSnippets: [],
error: errorData.error || `HTTP error ${response.status}`,
message: errorData.message,
};
}
if (options?.type === "txt") {
return await response.text();
}
return (await response.json()) as ContextResponse;
}