web_access_fetch
ChatGPTFetch a caller-specified HTTP(S) URL and get clean, LLM-ready Markdown back. Primary use (the common case): pass only a url. The page is fetched with a normal GET and returned as Markdown — no other parameters are needed. ``json { "url": "https://example.com/article" } ` **Best for:** any public URL, including pages that render their content client-side (news, docs, blogs, web apps). **Not for:** searching the web when you don't have a URL — use web_access_search instead. **Optional parameters (omit unless you need them):** - format — markdown (default), raw (the destination's verbatim body), or json (a { statusCode, headers, data } envelope with the destination's status and headers). - executeJS — set true to render JavaScript for SPAs when the content comes back empty. - headers — forward custom request headers; not combinable with executeJS, which runs in a browser. - countryCode — ISO 3166-1 alpha-2 (e.g. "US") to get the page as it is served in that country. - solveCaptcha — defaults false, so a challenge page fails fast and is reported as an error; set true to have the request attempt the challenge. **To send a direct POST, PUT or PATCH** (with a body), use web_access_request — this tool only issues GETs. Plenty of those calls are reads: a GraphQL query, a search backend that takes a body, a JSON API that refuses GET. **Returns:** Markdown by default; the verbatim body or a JSON envelope when format` is set accordingly. Requests must comply with destination policy, robots directives, rate limits, and access controls. Challenge handling is subject to the caller's String account and organization policy.
web_access_request
ChatGPTSend a POST, PUT or PATCH request to any URL, through String's Web Access API. It works like web_access_fetch, but for calls that submit data rather than read a page — a JSON API that only accepts POST, a GraphQL endpoint, a search backend that takes a body. Use web_access_fetch instead whenever you only need to read a page. This tool sends a body to the destination rather than reading it, so use it only for a request the user actually asked for. Usage Example: ``json { "url": "https://api.example.com/search", "method": "POST", "body": { "q": "widgets" } } `` Returns: The destination's response, in the requested format.
web_access_search
ChatGPTSearch the public web for a caller-specified query and get ranked organic results back, plus whatever Google rendered around them: knowledge panel, AI overview, People also ask, local pack, videos, discussions. Google's images, videos, shopping, books, places and forums tabs are searched with searchType. Primary use: pass a query string. There is no engine or domain-filter parameter; any other key is rejected before the call. ``json { "query": "site:arxiv.org retrieval augmented generation" } ` **Optional targeting fields:** country — ISO 3166-1 alpha-2 code the search runs from, e.g. GB (default US); language — results language tag such as en or pt-br. `json { "query": "plumbers", "country": "GB", "language": "en" } ` To search from a place, send location, a place name such as London or Austin,Texas,United States (1 to 200 characters), or coordinates, { latitude, longitude, radius } with radius in meters (default 5000). The search is sent from that place's country; if both are sent, coordinates win. A name that cannot be placed fails, so send coordinates instead. On the results page the place biases results toward it. The effect is strongest for queries like plumbers near me, and it is not exact city targeting: a bare query such as coffee shops may still return results from a wider area. `json { "query": "plumbers near me", "location": "Austin,Texas,United States" } ` **Optional request field:** searchCount — how many organic results you want, an integer from 1 to 300 (above 300 is rejected). Google is paged, up to 36 pages, until that many are in hand; each page is billed as one search. Many queries run out before 300: Google often has 100-200 results for a query, and you get what it has, with paging.complete: true and paging.stoppedBy: "end_of_results". Omit it for one page, about 10 results, and the response then carries no paging. Not with format: "raw", which returns one page per call. `json { "query": "construction consulting firms Ohio", "searchCount": 30 } ` **Optional Google field:** searchType — the Google tab to search: "web" (the default, the ordinary results page), "images", "videos", "shopping", "books", "places" or "forums". There is no news tab. Each page fetched is billed as one search, as on the web. - videos, books, forums answer results, paged like the web; each video carries video (channel, platform, duration) and each book book (authors, published). - images answers images, about 100 a page, each with title, url (the page it is on), source, imageUrl (the file), imageWidth, imageHeight and thumbnail. It has 3 pages; searchCount up to 300 collects across them, usually about 270 images. - shopping answers products, the one page of about 55 product cards: title, productId, price and originalPrice as shown, merchant and moreMerchants, delivery, returns, rating, reviews. A card has no url. Google does not page this tab, so page must be 1. - places answers places, 20 businesses a page, paged like the web up to page 15. results is empty for images, shopping and places. dateRange, sortBy and verbatim apply to web, videos and forums only; format: "raw" and aiOverview to web only. `json { "query": "eames lounge chair", "searchType": "images", "searchCount": 150 } ` **Optional Google filters:** safeSearch — true removes explicit results; includeOmittedResults — true includes the results Google hides as very similar to ones shown; autocorrect — false searches the query exactly as typed instead of Google's correction; restrictCountry — a two-letter code — keeps only pages from that country (unlike country, which sets where the search runs from); verbatim — true matches the words exactly, without synonyms. None combines with aiMode. `json { "query": "climate policy", "restrictCountry": "FR", "safeSearch": true } ` **Optional Google fields:** page, dateRange and sortBy` apply to Google results only; none of them combi…
web_access_sitemap_quote
ChatGPTQuote an asynchronous crawl of authorized public pages on one website. Nothing is crawled or billed: the quote creates a job that waits for approval. Starting from one URL, the crawler follows same-domain links breadth-first and can also seed from the site's /sitemap.xml. Requests must comply with destination policy, robots directives, rate limits, and access controls. Use it to discover pages for site audits, authorized retrieval worklists, or coverage checks before fetching individual pages. Not for: reading one page's content (use web_access_fetch) or open-ended web queries (use web_access_search). Requires url. Optional: maxPages (1–10000, default 10), maxDepth (1–100, default 2), pathPrefix (only crawl URLs whose path starts with this, e.g. "/docs"), budgetUsd (spend ceiling; the crawl stops with status token_cap_exceeded if it would exceed it), useSitemap (also seed the site's root /sitemap.xml — one extra billed page, but finds pages links miss). A maxPages or maxDepth outside its range, 0 included, is rejected rather than replaced by the default — omit the field to get the default. ``json { "url": "https://example.com", "maxPages": 200, "maxDepth": 3 } ` **Returns:** jobId, estimatedPages, and estimatedCostUsd, with status awaiting_approval. A 403 means the target domain is blocked for this account (contact support@usestring.ai). **Next:** show the user estimatedCostUsd. Only once they approve that cost, call web_access_sitemap_start with the jobId`.
web_access_sitemap_start
ChatGPTStart a crawl that web_access_sitemap_quote quoted. This is the billing-consent step: pages are billed as they are fetched, capped by the quote or budgetUsd. Call it only after the user has approved the quote's estimatedCostUsd. Requires jobId. Fails with status 402 if the account balance cannot cover the quote; a 409 partial_state error means an earlier start was interrupted — just call this tool again. A 404 means the job doesn't exist or belongs to another account. Returns: the jobId and its new status. Next: poll web_access_sitemap_status until the job is terminal; the terminal response carries its URLs.
web_access_sitemap_status
ChatGPTPoll a crawl job until it is terminal; the terminal response also carries the URLs it discovered. Statuses: awaiting_approval → running → terminal completed | failed | canceled | token_cap_exceeded (budget hit before maxPages; collected results are still readable). While running it returns pending and processed counts and no URLs; a partial_state status means an interrupted start — call web_access_sitemap_start again to repair it. Poll every few seconds for small crawls; give hundreds-of-pages crawls tens of seconds between polls. Once the job is terminal, the response carries total and urls, one page of the discovered URLs. Optional limit (1–5000, default 1000) and offset (≥ 0) choose the page; out-of-range values are rejected. Each entry has url, statusCode (0 = discovered but not fetched), depth, parentUrl, isSitemap, sourceType, and an error when that page failed. discoveredUrls (links found on the page) is only present for ~1h after completion; afterwards results come from durable storage which omits it — everything else stays available. Requires jobId. A 404 means the job doesn't exist or belongs to another account. If the job is terminal but its URLs cannot be read, the call fails rather than return the status without them; call it again. Returns: the jobId and status, with pending, processed, pagesProcessed, estimatedCostUsd, errorMessage and finishedAt as the job reports them, and total and urls once it is terminal. Next: call again with offset advanced by the page size until it reaches total; read a page's content with web_access_fetch.