Developer-friendly & type-safe Typescript SDK specifically catered to leverage youdotcom API.
You.com Contents API: Get the best search results from web and news sources
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add @youdotcom-oss/sdkpnpm add @youdotcom-oss/sdkbun add @youdotcom-oss/sdkyarn add @youdotcom-oss/sdkNote
This package is published with CommonJS and ES Modules (ESM) support.
For supported JavaScript runtimes, please consult RUNTIMES.md.
We provide a comprehensive example file with interactive demos for all API endpoints. You can find it at examples/api-example-calls.ts.
To run the examples:
cd examples
npm install
npx tsx api-example-calls.tsThe example file includes:
- Express Agent - Batch and streaming requests
- Advanced Agent - Research-powered requests
- Custom Agent - Using your own agent configurations
- Search API - Web search queries
- Contents API - URL content extraction
This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
|---|---|---|---|
apiKeyAuth |
apiKey | API key | YOU_API_KEY_AUTH |
To authenticate with the API the apiKeyAuth parameter must be set when initializing the SDK client instance. For example:
import { You } from "@youdotcom-oss/sdk";
const you = new You({
apiKeyAuth: process.env["YOU_API_KEY_AUTH"] ?? "",
});
async function run() {
const result = await you.agentsRuns({
agent: "express",
input: "What is the capital of France?",
stream: false,
});
console.log(result);
}
run();Available methods
- agentsRuns - Run an Agent
- search - Returns a list of unified search results from web and news sources
- contents - Returns the content of the web pages
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
Available standalone functions
agentsRuns- Run an Agentcontents- Returns the content of the web pagessearch- Returns a list of unified search results from web and news sources
Server-sent events are used to stream content from certain
operations. These operations will expose the stream as an async iterable that
can be consumed using a for await...of loop. The loop will
terminate when the server no longer has any events to send and closes the
underlying connection.
import { You } from "youdotcom";
import {
type ExpressAgentRunsRequest,
type AgentRunsStreamingResponse,
} from "youdotcom/models"
import { type EventStream } from "youdotcom/lib/event-streams.js";
const you = new You({
apiKeyAuth: process.env["YOU_API_KEY_AUTH"] ?? "",
});
const request: ExpressAgentRunsRequest = {
agent: "express",
stream: true,
input: "Restaurants in San Francisco",
tools: [{
type: "web_search"
}]
};
async function run() {
const result = await you.agentsRuns(request) as EventStream<AgentRunsStreamingResponse>;
// Iterate over the streaming response and print tokens as they arrive
for await (const chunk of result) {
switch(chunk.data.type) {
case "response.created": {
console.log("Response created, seqId:", chunk.data.seqId);
break;
}
case "response.starting": {
console.log("Response starting, seqId:", chunk.data.seqId);
break;
}
case "response.output_item.added": {
console.log("Output item added:", chunk.data);
break;
}
case "response.output_content.full": {
console.log("\nWeb Search Results:");
let urls = chunk.data.response.full.map((result) => {
return result.url
})
console.log(urls);
break;
}
case "response.output_text.delta": {
// This contains the incremental response from the agent
process.stdout.write(chunk.data.response.delta)
break;
}
case "response.output_item.done": {
console.log("\nOutput item done:", chunk.data);
break;
}
case "response.done": {
console.log("\nResponse completed!");
console.log("Runtime:", chunk.data.response.runTimeMs, "ms");
console.log("Finished:", chunk.data.response.finished);
break;
}
default: {
console.log("Unknown event type:", chunk.data);
break;
}
}
}
}
run();Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { You } from "@youdotcom-oss/sdk";
const you = new You({
apiKeyAuth: process.env["YOU_API_KEY_AUTH"] ?? "",
});
async function run() {
const result = await you.agentsRuns({
agent: "express",
input: "What is the capital of France?",
stream: false,
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
console.log(result);
}
run();If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { You } from "@youdotcom-oss/sdk";
const you = new You({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
apiKeyAuth: process.env["YOU_API_KEY_AUTH"] ?? "",
});
async function run() {
const result = await you.agentsRuns({
agent: "express",
input: "What is the capital of France?",
stream: false,
});
console.log(result);
}
run();YouError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
|---|---|---|
error.message |
string |
Error message |
error.statusCode |
number |
HTTP response status code eg 404 |
error.headers |
Headers |
HTTP response headers |
error.body |
string |
HTTP body. Can be empty string if no body is returned. |
error.rawResponse |
Response |
Raw HTTP response |
error.data$ |
Optional. Some errors may contain structured data. See Error Classes. |
import { You } from "@youdotcom-oss/sdk";
import * as errors from "@youdotcom-oss/sdk/models/errors";
const you = new You({
apiKeyAuth: process.env["YOU_API_KEY_AUTH"] ?? "",
});
async function run() {
try {
const result = await you.agentsRuns({
agent: "express",
input: "What is the capital of France?",
stream: false,
});
console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.YouError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
// Depending on the method different errors may be thrown
if (error instanceof errors.AgentRuns400ResponseError) {
console.log(error.data$.detail); // string
}
}
}
}
run();Primary error:
YouError: The base class for HTTP error responses.
Less common errors (15)
Network errors:
ConnectionError: HTTP client was unable to make a request to a server.RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.RequestAbortedError: HTTP request was aborted by the client.InvalidRequestError: Any input used to create a request is invalid.UnexpectedClientError: Unrecognised or unexpected error.
Inherit from YouError:
AgentRuns400ResponseError: The message returned by the error. Status code400. Applicable to 1 of 3 methods.*AgentRuns401ResponseError: The message returned by the error. Status code401. Applicable to 1 of 3 methods.*SearchUnauthorizedError: Unauthorized. Problems with API key. Status code401. Applicable to 1 of 3 methods.*ContentsUnauthorizedError: Unauthorized. Status code401. Applicable to 1 of 3 methods.*SearchForbiddenError: Forbidden. API key lacks scope for this path. Status code403. Applicable to 1 of 3 methods.*ContentsForbiddenError: Forbidden. Status code403. Applicable to 1 of 3 methods.*AgentRuns422ResponseError: Unprocessable Entity - Invalid request data. Status code422. Applicable to 1 of 3 methods.*SearchInternalServerError: Internal Server Error during authentication/authorization middleware. Status code500. Applicable to 1 of 3 methods.*ContentsInternalServerError: Internal Server Error. Status code500. Applicable to 1 of 3 methods.*ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. Seeerror.rawValuefor the raw value anderror.pretty()for a nicely formatted multi-line string.
* Check the method documentation to see if the error is applicable.
The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
import { You } from "@youdotcom-oss/sdk";
const you = new You({
serverURL: "https://ydc-index.io",
apiKeyAuth: process.env["YOU_API_KEY_AUTH"] ?? "",
});
async function run() {
const result = await you.agentsRuns({
agent: "express",
input: "What is the capital of France?",
stream: false,
});
console.log(result);
}
run();The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
import { You } from "@youdotcom-oss/sdk";
const you = new You({
apiKeyAuth: process.env["YOU_API_KEY_AUTH"] ?? "",
});
async function run() {
const result = await you.agentsRuns({
agent: "express",
input: "What is the capital of France?",
stream: false,
}, {
serverURL: "https://api.you.com",
});
console.log(result);
}
run();The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:
import { You } from "@youdotcom-oss/sdk";
import { HTTPClient } from "@youdotcom-oss/sdk/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new You({ httpClient: httpClient });You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
Warning
Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { You } from "@youdotcom-oss/sdk";
const sdk = new You({ debugLogger: console });You can also enable a default debug logger by setting an environment variable YOU_DEBUG to true.
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, note that all files in this repository, with the exception of examples/api-example-calls.ts and the openapi_schemas folder, are automatically generated by Speakeasy. Any manual changes outside of these files will be overwritten on the next generation.
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.