Class WebClient

WebClient provides methods to interact with web-related functionalities.

Index

Methods

aiSearch createShortUrl createShortUrls deleteShortUrl deleteShortUrls getUrlContent

Methods

aiSearch

aiSearch(
    query: string,
    abortSignal?: AbortSignal,
    allowedDomains?: string[],
): Promise<WebAiSearchResponse>
Search the web using AI. Returns a response containing Markdown text and cited URLs.
Parameters
- query: string
  The keywords or query string to search for.
- OptionalabortSignal: AbortSignal
  Optional signal used to abort the underlying request. When the signal aborts, the in-flight HTTP request is cancelled and its promise rejects, allowing callers to bound a single call without leaking the request.
- OptionalallowedDomains: string[]
  Optional list of domains the search is restricted to (subdomains included). When provided, every cited URL in the response belongs to one of the listed domains.
Returns Promise<WebAiSearchResponse>

createShortUrl

createShortUrl(
urlOrOptions: string | CreateShortUrlOptions,
): Promise<WebShortUrlResponse>
Creates a shortened URL for the given URL.

Defaults to a 1-day expiration if no expiry is provided via the secondsToLive field. If secondsToLive is set to 0, the URL will never expire.
Parameters
- urlOrOptions: string | CreateShortUrlOptions
  Either a URL string or an options object with url and all available options.
Returns Promise<WebShortUrlResponse>

createShortUrls

createShortUrls(
urlsOrOptions: string[] | CreateShortUrlsOptions,
): Promise<WebShortUrlBulkResponse>
Creates shortened URLs for the given URLs.

Defaults to a 1-day expiration if no expiry is provided via the secondsToLive field. If secondsToLive is set to 0, the URL will never expire.
Parameters
- urlsOrOptions: string[] | CreateShortUrlsOptions
  Either an array of URL strings or an options object and all available options.
Returns Promise<WebShortUrlBulkResponse>

deleteShortUrl

deleteShortUrl(id: string): Promise<void>
Deletes a shortened URL by its ID.

The ID is the unique identifier at the end of the shortened URL.
Parameters
- id: string
  The ID of the shortened URL to delete.
Returns Promise<void>

deleteShortUrls

deleteShortUrls(ids: string[]): Promise<void>
Deletes shortened URLs by their IDs.

The ID is the unique identifier at the end of the shortened URL.
Parameters
- ids: string[]
  The IDs of the shortened URL to delete.
Returns Promise<void>

getUrlContent

getUrlContent(url: string): Promise<string>
Fetch content from a URL.
Parameters
- url: string
  The URL to fetch content from.
Returns Promise<string>