Usestring

String Web Access API

Fetch any http or https URL, search the web, discover a site's URLs, and run a remote browser over CDP. Fetch and search are billed per request; remote…

Developer tools#development

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Fetch any http or https URL, search the web, discover a site's URLs, and run a remote browser over CDP. Fetch and search are billed per request; remote browser sessions are billed by bandwidth and session time. Failed requests are not billed. See https://docs.usestring.ai for guides and pricing. Versioning and deprecation policy: https://docs.usestring.ai/api-reference/versioning (at least 90 days' notice before removal, with Deprecation and Sunset headers). Live status and uptime: https://status.usestring.ai (JSON at https://status.usestring.ai/index.json); check it when requests fail before assuming the target site blocked you.

Endpoints 13

Fetch

  • POSTFetch a URL/fetchFetch one http or https URL and return the destination's response as a JSON envelope, Markdown, or raw bytes. String picks the fetch strategy (direct request…

Search

  • POSTSearch the web/searchRun a web search on Google (default), DuckDuckGo, Brave or Mojeek and return the ranked organic results, plus Google page surfaces such as ads, local places,…

Sitemap

  • GETList sitemap jobs/sitemapList your organization's sitemap jobs, most recent first. Use it to find a jobId or review past crawls. Also served under /map with the same shapes.
  • POSTSubmit a sitemap crawl and get a quote/sitemapSubmit an asynchronous crawl that discovers the URLs on one hostname from a starting URL, and get a cost quote. Nothing is crawled or charged until you call…
  • POSTApprove a sitemap quote and start the crawl/sitemap/:jobId/approveApprove a quoted sitemap job and start the crawl. The estimated cost is held against your balance and settled when the job finishes. Call it after…
  • GETGet sitemap job status/sitemap/:jobIdReturn a sitemap job's status and progress. Poll it after approveSitemapJob until the status is completed, failed, canceled or token_cap_exceeded. Also served…
  • DELETECancel a sitemap job/sitemap/:jobIdCancel a sitemap job that has not finished. Use it to stop a crawl you no longer need. Also served under /map with the same shapes.
  • GETGet discovered URLs/sitemap/:jobId/urlsReturn a page of the URLs a sitemap job discovered, with each URL's depth, parent and discovery source. It works mid-crawl and total grows as the crawl runs;…

Browser

  • GETList browser profiles/contextsList your organization's browser profiles, newest first, without deleted profiles. Use it to find a contextId.
  • POSTCreate a browser profile/contextsCreate a reusable browser profile (context) that saves logins, cookies and site storage between remote browser sessions. Pass the returned id as contextId…
  • GETInspect a browser profile/contexts/:contextIdReturn one browser profile with its status and latest save. Use it to check whether a profile is busy (IN_USE or UPLOADING) or to confirm that a session's…
  • DELETEDelete a browser profile/contexts/:contextIdDelete a browser profile. It becomes unusable at once and its name and slot are free; stored data is removed in the background. Repeating the request returns…
  • GETConnect to a remote CDP browser (WebSocket)wss://request.usestring.ai/v1/wssOpen a WebSocket to a remote Chrome DevTools Protocol (CDP) browser for Playwright, Puppeteer or another CDP client, at wss://request.usestring.ai/v1/wss.…

API details

Base URL
https://request.usestring.ai/v1
Authentication
A bearer token in the Authorization header
Operations
13 operations on 9 pathsGET 6POST 5DELETE 2
Main resources
Sitemap 6Browser 5Fetch 1Search 1
Response formats
application/json */* text/html text/markdown
Description format
OpenAPI 3.1.0, API version 1.0.0

How to test the String Web Access API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the String Web Access API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Fetch a URL” (POST /fetch), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the String Web Access API?

Fetch any http or https URL, search the web, discover a site's URLs, and run a remote browser over CDP. Fetch and search are billed per request; remote… It is listed under Developer tools and has 13 endpoints.

Who publishes the String Web Access API?

It is listed from Usestring's public API description (an OpenAPI document), not published by Usestring on Swastik Codes. Anyone who controls usestring.ai can claim the profile by adding a DNS TXT record.

What is the base URL of the String Web Access API?

Requests go to https://request.usestring.ai/v1. Endpoint paths are added to this base URL.

How do I authenticate with the String Web Access API?

With A bearer token in the Authorization header.

How many endpoints does the String Web Access API have?

13 operations on 9 paths (6 GET, 5 POST, 2 DELETE). The largest groups are Sitemap, Browser, Fetch, Search.

Is forking the String Web Access API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.