{ "openapi": "3.1.0", "info": { "title": "String Web Access API", "version": "1.0.0", "description": "Fetch, search, and map the public web through String. Requests egress through rotating proxies with anti-bot handling, so pages that refuse ordinary automated traffic still return content. Full documentation: https://portal.usestring.ai/docs", "contact": { "name": "String", "url": "https://usestring.ai" } }, "servers": [ { "url": "https://request.usestring.ai/v1", "description": "Production" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "fetch", "description": "Retrieve a single URL." }, { "name": "search", "description": "Query a search engine for organic results." }, { "name": "sitemap", "description": "Discover the URLs of a whole site as an asynchronous job." }, { "name": "contexts", "description": "Browser profiles that persist logins and cookies between sessions." }, { "name": "sessions", "description": "Hosted-browser (`/wss`) sessions as API objects: ids, status, replays, live view and files. Every `/wss` connection gets an id, returned in its `x-session-id` upgrade response header." } ], "paths": { "/fetch": { "post": { "tags": [ "fetch" ], "operationId": "fetch", "summary": "Fetch a URL", "description": "Retrieves one URL and returns it as a JSON envelope, raw bytes, or Markdown. Supply `actions` or `screenshot` to drive a real browser session before the page is captured.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchRequest" } } } }, "responses": { "200": { "description": "The destination's response. `data` carries the page in the requested format.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchResponse" } } } }, "400": { "description": "The request failed validation, and `issues` names the offending fields. Or `error` is `unsupported_geography`: requests cannot be routed from the requested `countryCode`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "502": { "description": "The destination could not be reached or returned an unusable response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "`error` is `geography_unavailable`: no exit in the requested `countryCode` was available for this request. Retry it, or omit `countryCode`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/search": { "post": { "tags": [ "search" ], "operationId": "search", "summary": "Search the web", "description": "Returns the ranked organic results, plus the local pack (`places`) and knowledge panel (`entity`) when the results page carried them. Neither is merged into `results`, so a caller counting documents is never moved by a card it cannot tell from one. `engine: \"google_ai_mode\"` answers from Google AI Mode instead: `aiMode` carries the generated answer, its structure, the pages it cites and any products, places and videos it shows; `results` is empty, and `searchCount` is rejected. `aiOverview: true` (google only, off by default) makes a second, sequential fetch to fill the AI Overview Google streams in after the page: about 64% of results pages carry one, and filling it adds about 2.8 s at p50 and 5.6 s at p90. Such a request costs 2x a normal search. An AI Overview already present in the page is returned without it.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRequest" } } } }, "responses": { "200": { "description": "Ranked organic results and any whole-page surfaces the engine carried as JSON, or with `format: \"raw\"` the Google results page named by `page` as HTML.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } }, "text/html": { "schema": { "type": "string" } } } }, "400": { "description": "The request failed validation. `issues` names the offending fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "502": { "description": "The destination could not be reached or returned an unusable response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/sitemap": { "post": { "tags": [ "sitemap" ], "operationId": "createSitemapJob", "summary": "Start a site crawl", "description": "Queues a crawl bounded by `maxPages` and `maxDepth`. The job is quoted and parked at `awaiting_approval`; it spends nothing until `POST /sitemap/{jobId}/approve`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SitemapRequest" } } } }, "responses": { "202": { "description": "The quoted job, awaiting approval.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SitemapJobQuote" } } } }, "400": { "description": "The request failed validation. `issues` names the offending fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "403": { "description": "The target domain is not allowed for this organization.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainDenied" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } }, "get": { "tags": [ "sitemap" ], "operationId": "listSitemapJobs", "summary": "List crawl jobs", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "userId", "in": "query", "description": "Narrows the listing to one user's jobs. A filter within the caller's organization, never a widening.", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "A page of the organization's jobs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SitemapJobList" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } } }, "/sitemap/{jobId}": { "get": { "tags": [ "sitemap" ], "operationId": "getSitemapJob", "summary": "Read a crawl job", "description": "The response shape depends on the job's state; see the variants of `SitemapJobState`.", "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Current job state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SitemapJobState" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "404": { "description": "No such job in the caller's organization, or its results have expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "409": { "description": "The job's approval handoff is incomplete; retry the approve call.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SitemapConflict" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } }, "delete": { "tags": [ "sitemap" ], "operationId": "cancelSitemapJob", "summary": "Cancel a crawl job", "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The job is now `canceled`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SitemapJobAck" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "404": { "description": "No such job in the caller's organization.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "409": { "description": "The job is already in a terminal state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SitemapConflict" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } } }, "/sitemap/{jobId}/approve": { "post": { "tags": [ "sitemap" ], "operationId": "approveSitemapJob", "summary": "Approve a quoted crawl", "description": "Releases a job that is awaiting approval so it starts spending against its quote.", "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The job was already approved; its current status is returned unchanged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SitemapJobAck" } } } }, "202": { "description": "Approved and now running.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SitemapJobAck" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "402": { "description": "The organization cannot cover the quote.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SitemapInsufficientFunds" } } } }, "404": { "description": "No such job in the caller's organization.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "409": { "description": "The approval handoff is incomplete; retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SitemapConflict" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "500": { "description": "Approval failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } } }, "/sitemap/{jobId}/urls": { "get": { "tags": [ "sitemap" ], "operationId": "getSitemapUrls", "summary": "Read the URLs a crawl found", "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 1000 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "A page of discovered URLs. `total` counts them all, not this page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SitemapUrlPage" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "404": { "description": "No such job in the caller's organization, or its results have expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } } }, "/contexts": { "post": { "tags": [ "contexts" ], "operationId": "createBrowserContext", "summary": "Create a browser context", "description": "Creates an empty profile that a later `/wss` session can attach to, so logins and cookies survive between sessions.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Retry-safe creation. Replaying a completed key returns the context it created rather than a second one.", "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,255}$" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserContextCreateRequest" } } } }, "responses": { "201": { "description": "The created context, or the one a replayed Idempotency-Key already created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserContext" } } } }, "400": { "description": "The request failed validation. `issues` names the offending fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "409": { "description": "The name is taken, or a create with this Idempotency-Key is still in flight.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "429": { "description": "The organization's context count or storage limit is reached, or its rate limit is.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } }, "get": { "tags": [ "contexts" ], "operationId": "listBrowserContexts", "summary": "List browser contexts", "description": "Credit-free: an organization whose balance ran out must still be able to see what it has.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "The organization's contexts.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserContextList" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } } }, "/contexts/{contextId}": { "get": { "tags": [ "contexts" ], "operationId": "getBrowserContext", "summary": "Read a browser context", "description": "Credit-free.", "parameters": [ { "name": "contextId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The context.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserContext" } } } }, "400": { "description": "`contextId` is not a context UUID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "404": { "description": "No such context in the caller's organization.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } }, "delete": { "tags": [ "contexts" ], "operationId": "deleteBrowserContext", "summary": "Delete a browser context", "description": "202 is the normal answer and 200 the exception. Accepting the deletion is immediate and irreversible — the profile is never attachable again from the moment this returns — but its stored data may take a moment to be removed, so 200 is reserved for when nothing is left. A client that wants to know when that is repeats the same call.", "parameters": [ { "name": "contextId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Deleted; nothing remains in storage.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserContextDeleted" } } } }, "202": { "description": "Accepted and irreversible; the stored objects are not gone yet.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserContextDeleteAccepted" } } } }, "400": { "description": "`contextId` is not a context UUID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "404": { "description": "No such context in the caller's organization.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "409": { "description": "The context is attached to a running session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } } }, "/sessions": { "post": { "tags": [ "sessions" ], "operationId": "createBrowserSession", "summary": "Create a browser session", "description": "Takes the same options as the `/wss` query string and returns a session to connect at `connectUrl` within ten minutes. `record: true` stores a screencast replay.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserSessionCreateRequest" } } } }, "responses": { "201": { "description": "The pending session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserSession" } } } }, "400": { "description": "The request failed validation. `issues` names the offending fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "403": { "description": "Browser contexts are not enabled for this organization.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "503": { "description": "Session storage is not configured on this deployment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } }, "get": { "tags": [ "sessions" ], "operationId": "listBrowserSessions", "summary": "List browser sessions", "description": "Newest first. Credit-free. Lists sessions made through `POST /sessions`, recorded, or given a file; any other `/wss` session is readable by its `x-session-id` for a week.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "A page of the organization's sessions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserSessionList" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } } }, "/sessions/{sessionId}": { "get": { "tags": [ "sessions" ], "operationId": "getBrowserSession", "summary": "Read a browser session", "description": "Status, proxy route and file list. Watch a running session live by opening a WebSocket to `/sessions/{sessionId}/live` with the same `Authorization` header.", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ses_[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "The session and its files.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserSessionDetail" } } } }, "400": { "description": "`sessionId` is not a session id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "404": { "description": "No such session in the caller's organization.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } } }, "/sessions/{sessionId}/replay": { "get": { "tags": [ "sessions" ], "operationId": "getBrowserSessionReplay", "summary": "Read a session replay", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ses_[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Short-lived URLs for the replay's frame chunks, in order.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserSessionReplay" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "404": { "description": "No such session, or it was not recorded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "503": { "description": "Session storage is not configured on this deployment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } } }, "/sessions/{sessionId}/files": { "get": { "tags": [ "sessions" ], "operationId": "listBrowserSessionFiles", "summary": "List a session's files", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ses_[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "The session's files with short-lived download URLs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserSessionFileList" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "404": { "description": "No such session in the caller's organization.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } } }, "/sessions/{sessionId}/files/{name}": { "put": { "tags": [ "sessions" ], "operationId": "putBrowserSessionFile", "summary": "Store a file on a session", "description": "Stores the request body as one of the session's files, such as a receipt, replacing any file of that name. At most 26214400 bytes and 50 files per session.", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ses_[0-9a-f]{32}$" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$" } } ], "requestBody": { "required": true, "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "201": { "description": "The stored file.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserSessionFile" } } } }, "400": { "description": "The request failed validation. `issues` names the offending fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "404": { "description": "No such session in the caller's organization.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "409": { "description": "The session already holds 50 files.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "413": { "description": "The file is too large.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "503": { "description": "Session storage is not configured on this deployment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } }, "get": { "tags": [ "sessions" ], "operationId": "getBrowserSessionFile", "summary": "Download a session file", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ses_[0-9a-f]{32}$" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$" } } ], "responses": { "302": { "description": "Redirects to a short-lived download URL." }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "404": { "description": "No such session or file.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "429": { "description": "Rate limit or plan quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } }, "503": { "description": "Session storage is not configured on this deployment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "A String API key, sent as `Authorization: Bearer `. Keys are issued in the portal." } }, "schemas": { "FetchRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "url": { "type": "string" }, "method": { "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS", "get", "post", "put", "patch", "delete", "head", "options" ], "type": "string" }, "format": { "default": "json", "type": "string", "enum": [ "json", "raw", "markdown" ] }, "mainContentOnly": { "default": false, "type": "boolean" }, "markdownMode": { "default": "full", "type": "string", "enum": [ "readable", "full" ] }, "actions": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "waitForNetworkIdle" }, "idleTime": { "description": "Milliseconds the network must stay quiet, at most 10000. Defaults to 500.", "type": "integer", "minimum": 0, "maximum": 10000 }, "concurrency": { "description": "Requests that may stay in flight while the network counts as quiet, at most 10. Defaults to 0; 1 or 2 suits a page that holds a long-poll or analytics connection open.", "type": "integer", "minimum": 0, "maximum": 10 }, "timeout": { "description": "Milliseconds to wait for the network to go quiet, at most 30000 (the default).", "type": "integer", "exclusiveMinimum": 0, "maximum": 30000 }, "onTimeout": { "description": "`continue` (default): the sequence carries on with the page as it is and the action is listed in `timedOutActions`. `fail`: the sequence fails at this action.", "type": "string", "enum": [ "fail", "continue" ] } }, "required": [ "type" ], "additionalProperties": false, "description": "Waits until the page has had no more than `concurrency` requests in flight for `idleTime` milliseconds. The defaults wait like `waitUntil: \"networkidle0\"`, and `concurrency: 2` waits like `networkidle2`." }, { "type": "object", "properties": { "type": { "type": "string", "const": "wait" }, "milliseconds": { "type": "integer", "minimum": 0, "maximum": 30000 }, "selector": { "type": "string" }, "timeout": { "type": "integer", "minimum": 0, "maximum": 30000 }, "frame": { "description": "Runs the action inside an iframe, cross-origin ones included: a selector for the `