{ "openapi": "3.1.0", "info": { "title": "Outcrawl API", "version": "1.0.0", "summary": "Web infrastructure for AI agents: scrape, crawl, search, agents and browsers on one credit balance.", "description": "Outcrawl exposes one API surface at `https://api.outcrawl.ai/v1`, generated here from the 62-row capability registry that is the only truth about what it serves. Every request carries one bearer credential: an API key, or an OAuth access token from `outcrawl login` or an MCP client that signed in. There is exactly one base URL for every capability below.\n\nThis document is GENERATED by `scripts/generate-openapi.mjs` from `outcrawl-browser@80d2fb7`. It is never hand-edited; `node scripts/generate-openapi.mjs --check` fails the build on drift.", "contact": { "name": "Outcrawl", "url": "https://outcrawl.ai/contact" } }, "servers": [ { "url": "https://api.outcrawl.ai", "description": "The only API surface." } ], "x-outcrawl-platform": { "homepage": "https://outcrawl.ai", "docs": "https://outcrawl.ai/docs", "pricing": "https://outcrawl.ai/pricing", "mcp": "https://api.outcrawl.ai/mcp", "sdks": { "typescript": "https://www.npmjs.com/package/@outcrawl/sdk", "python": "https://pypi.org/project/outcrawl/", "cli": "https://get.outcrawl.ai/cli/install.sh" } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ { "name": "Agent" }, { "name": "Crawl" }, { "name": "Credits" }, { "name": "Integrations" }, { "name": "Monitors" }, { "name": "Profiles" }, { "name": "Purchases" }, { "name": "Rules" }, { "name": "Scrape" }, { "name": "Search" }, { "name": "Secrets" }, { "name": "Sessions" }, { "name": "Usage" }, { "name": "Wallet" } ], "paths": { "/v1/scrape": { "post": { "operationId": "scrape", "summary": "Fetch one URL and return clean content in the requested formats.", "description": "Fetch one URL and return clean content in the requested formats. Use for a single known page; not for following links, and not for tasks that need decisions.", "tags": [ "Scrape" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Fetch one URL and return clean content in the requested formats. Use for a single known page; not for following links, and not for tasks that need decisions.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "scrape", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_scrape", "x-cli-command": "scrape", "x-sdk-method-ts": "oc.scrape(...)", "x-sdk-method-py": "oc.scrape(...)" } }, "/v1/crawl": { "post": { "operationId": "crawl", "summary": "Walk a site from a seed URL and stream every page as it is scraped.", "description": "Walk a site from a seed URL and stream every page as it is scraped. Use when the set of URLs is unknown; not for one page, and not for content behind a login flow.", "tags": [ "Crawl" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Walk a site from a seed URL and stream every page as it is scraped. Use when the set of URLs is unknown; not for one page, and not for content behind a login flow.", "content": { "application/json": { "schema": { "type": "object", "description": "Streamed as newline-delimited JSON: a header frame followed by zero or more item frames, one JSON object per line. See the matching capability page under docs/app/ for the frame shapes." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "crawl", "x-framing": "ndjson", "x-streams-when": null, "x-mcp-tool": "outcrawl_crawl", "x-cli-command": "crawl", "x-sdk-method-ts": "oc.crawl(...)", "x-sdk-method-py": "oc.crawl(...)" } }, "/v1/crawl/{id}": { "get": { "operationId": "crawlGet", "summary": "Where one crawl has got to: status, pages discovered, pages completed, what it has spent, and the per-URL failures.", "description": "Where one crawl has got to: status, pages discovered, pages completed, what it has spent, and the per-URL failures. A row read and not a browser, so it is safe to poll. Use it to learn whether a crawl is still running, or what it reached after a connection dropped; not to fetch the pages, which is /v1/crawl/{id}/results.", "tags": [ "Crawl" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Where one crawl has got to: status, pages discovered, pages completed, what it has spent, and the per-URL failures. A row read and not a browser, so it is safe to poll. Use it to learn whether a crawl is still running, or what it reached after a connection dropped; not to fetch the pages, which is /v1/crawl/{id}/results.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "crawl.get", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "crawl status", "x-sdk-method-ts": "oc.crawl.get(...)", "x-sdk-method-py": "oc.crawl.get(...)" } }, "/v1/crawl/{id}/results": { "get": { "operationId": "crawlResults", "summary": "The pages a crawl has delivered, a page at a time, oldest first.", "description": "The pages a crawl has delivered, a page at a time, oldest first. Pages land DURING the crawl, so this answers before it has finished, and a cancelled crawl still delivers what it bought. Resume with the `cursor` you last saw. Use it for the content; not for whether the crawl is done, which is /v1/crawl/{id}.", "tags": [ "Crawl" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "The pages a crawl has delivered, a page at a time, oldest first. Pages land DURING the crawl, so this answers before it has finished, and a cancelled crawl still delivers what it bought. Resume with the `cursor` you last saw. Use it for the content; not for whether the crawl is done, which is /v1/crawl/{id}.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "crawl.results", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "crawl results", "x-sdk-method-ts": "oc.crawl.results(...)", "x-sdk-method-py": "oc.crawl.results(...)" } }, "/v1/crawl/{id}/cancel": { "post": { "operationId": "crawlCancel", "summary": "Stop a crawl.", "description": "Stop a crawl. It settles with the pages it had reached and everything already delivered stays yours; pages already fetched are still billed, because the `limit` is the protection and not a refund argued afterwards. Use it to stop spending; not to delete the pages.", "tags": [ "Crawl" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Stop a crawl. It settles with the pages it had reached and everything already delivered stays yours; pages already fetched are still billed, because the `limit` is the protection and not a refund argued afterwards. Use it to stop spending; not to delete the pages.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "crawl.cancel", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "crawl cancel", "x-sdk-method-ts": "oc.crawl.cancel(...)", "x-sdk-method-py": "oc.crawl.cancel(...)" } }, "/v1/search": { "post": { "operationId": "search", "summary": "Web search, optionally with every hit rendered through our scrape pipeline.", "description": "Web search, optionally with every hit rendered through our scrape pipeline. Use to find pages; not to read one you already have a URL for.", "tags": [ "Search" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Web search, optionally with every hit rendered through our scrape pipeline. Use to find pages; not to read one you already have a URL for.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "search", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_search", "x-cli-command": "search", "x-sdk-method-ts": "oc.search(...)", "x-sdk-method-py": "oc.search(...)" } }, "/v1/monitors": { "post": { "operationId": "monitorsCreate", "summary": "Watch a URL on a schedule and notify on real change via Discord, Slack or webhook.", "description": "Watch a URL on a schedule and notify on real change via Discord, Slack or webhook. Use for recurring checks; not for a one-off comparison.", "tags": [ "Monitors" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Watch a URL on a schedule and notify on real change via Discord, Slack or webhook. Use for recurring checks; not for a one-off comparison.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "monitors.create", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_monitor_create", "x-cli-command": "monitors create", "x-sdk-method-ts": "oc.monitors.create(...)", "x-sdk-method-py": "oc.monitors.create(...)" }, "get": { "operationId": "monitorsList", "summary": "List monitors with their last check status.", "description": "List monitors with their last check status.", "tags": [ "Monitors" ], "responses": { "200": { "description": "List monitors with their last check status.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "monitors.list", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_monitor_list", "x-cli-command": "monitors ls", "x-sdk-method-ts": "oc.monitors.list(...)", "x-sdk-method-py": "oc.monitors.list(...)" } }, "/v1/monitors/{id}": { "delete": { "operationId": "monitorsDelete", "summary": "Delete a monitor and stop its schedule.", "description": "Delete a monitor and stop its schedule. Snapshots are discarded.", "tags": [ "Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Delete a monitor and stop its schedule. Snapshots are discarded.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "monitors.delete", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_monitor_delete", "x-cli-command": "monitors rm", "x-sdk-method-ts": "oc.monitors.delete(...)", "x-sdk-method-py": "oc.monitors.delete(...)" } }, "/v1/agent": { "post": { "operationId": "agent", "summary": "Submit a natural-language browser task as a JOB and get an id back in milliseconds.", "description": "Submit a natural-language browser task as a JOB and get an id back in milliseconds. The run is not held open on this call and hours are normal: read outcrawl_agent_status for the answer, outcrawl_agent_results for the records it appended, and outcrawl_agent_cancel to stop it. Use when the page needs decisions or interaction; not for plain reading, where scrape is far cheaper.", "tags": [ "Agent" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Submit a natural-language browser task as a JOB and get an id back in milliseconds. The run is not held open on this call and hours are normal: read outcrawl_agent_status for the answer, outcrawl_agent_results for the records it appended, and outcrawl_agent_cancel to stop it. Use when the page needs decisions or interaction; not for plain reading, where scrape is far cheaper.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "agent", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_agent", "x-cli-command": "agent", "x-sdk-method-ts": "oc.agent(...)", "x-sdk-method-py": "oc.agent(...)" }, "get": { "operationId": "agentList", "summary": "Your agent runs, newest first, by status and age: id, task, status, steps, records, credits and replay URL, without t...", "description": "Your agent runs, newest first, by status and age: id, task, status, steps, records, credits and replay URL, without the answer. Use to find a run you did not keep the id of; not to read one run's answer, which is outcrawl_agent_status.", "tags": [ "Agent" ], "responses": { "200": { "description": "Your agent runs, newest first, by status and age: id, task, status, steps, records, credits and replay URL, without the answer. Use to find a run you did not keep the id of; not to read one run's answer, which is outcrawl_agent_status.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "agent.list", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_agent_list", "x-cli-command": "agent list", "x-sdk-method-ts": "oc.agent.list(...)", "x-sdk-method-py": "oc.agent.list(...)" } }, "/v1/agent/{id}": { "get": { "operationId": "agentGet", "summary": "Where one run has got to: status, the plan it stated, what it has spent, and its answer once it has one.", "description": "Where one run has got to: status, the plan it stated, what it has spent, and its answer once it has one. Safe to call as often as you like: it is a row read, not a browser. Use it to find out whether a submitted run has finished; not to fetch the records it produced, which is outcrawl_agent_results.", "tags": [ "Agent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Where one run has got to: status, the plan it stated, what it has spent, and its answer once it has one. Safe to call as often as you like: it is a row read, not a browser. Use it to find out whether a submitted run has finished; not to fetch the records it produced, which is outcrawl_agent_results.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "agent.get", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_agent_status", "x-cli-command": "agent status", "x-sdk-method-ts": "oc.agent.get(...)", "x-sdk-method-py": "oc.agent.get(...)" } }, "/v1/agent/{id}/events": { "get": { "operationId": "agentEvents", "summary": "Everything a run has done, in order, from a cursor: steps, findings, dead ends, plan changes.", "description": "Everything a run has done, in order, from a cursor: steps, findings, dead ends, plan changes. Ask for the verbosity you want with `level`, and resume with the `after` sequence you last saw rather than re-reading from the start. Use it to watch or audit a run; not to get its answer, which is outcrawl_agent_status.", "tags": [ "Agent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Everything a run has done, in order, from a cursor: steps, findings, dead ends, plan changes. Ask for the verbosity you want with `level`, and resume with the `after` sequence you last saw rather than re-reading from the start. Use it to watch or audit a run; not to get its answer, which is outcrawl_agent_status.", "content": { "application/json": { "schema": { "type": "object", "description": "Streamed as newline-delimited JSON: a header frame followed by zero or more item frames, one JSON object per line. See the matching capability page under docs/app/ for the frame shapes." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "agent.events", "x-framing": "ndjson", "x-streams-when": null, "x-mcp-tool": "outcrawl_agent_events", "x-cli-command": "agent events", "x-sdk-method-ts": "oc.agent.events(...)", "x-sdk-method-py": "oc.agent.events(...)" } }, "/v1/agent/{id}/results": { "get": { "operationId": "agentResults", "summary": "The records a run appended, a page at a time, oldest first.", "description": "The records a run appended, a page at a time, oldest first. Records land DURING the run, so this answers before the run has finished and a killed run still delivers what it bought. Use it for the data; not for whether the run is done, which is outcrawl_agent_status.", "tags": [ "Agent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "The records a run appended, a page at a time, oldest first. Records land DURING the run, so this answers before the run has finished and a killed run still delivers what it bought. Use it for the data; not for whether the run is done, which is outcrawl_agent_status.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "agent.results", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_agent_results", "x-cli-command": "agent results", "x-sdk-method-ts": "oc.agent.results(...)", "x-sdk-method-py": "oc.agent.results(...)" } }, "/v1/agent/{id}/cancel": { "post": { "operationId": "agentCancel", "summary": "Stop a run.", "description": "Stop a run. It settles with whatever it had reached and everything it already appended stays yours; work already performed is still billed, because caps are the protection and not a refund argued afterwards. Use it to stop spending; not to delete the output.", "tags": [ "Agent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Stop a run. It settles with whatever it had reached and everything it already appended stays yours; work already performed is still billed, because caps are the protection and not a refund argued afterwards. Use it to stop spending; not to delete the output.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "agent.cancel", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_agent_cancel", "x-cli-command": "agent cancel", "x-sdk-method-ts": "oc.agent.cancel(...)", "x-sdk-method-py": "oc.agent.cancel(...)" } }, "/v1/agent/{id}/control": { "post": { "operationId": "agentControl", "summary": "Take the wheel of a live run, or hand it back.", "description": "Take the wheel of a live run, or hand it back. Taking it PAUSES the agent where it stands with the browser still open, and answers the URL a person drives it at; handing it back resumes the same run on whatever page you left it on. Use it when a run needs a human for one step (a login you will not automate, a form only you can fill); not to stop a run, which is outcrawl_agent_cancel, and not to answer a question the agent asked, which is outcrawl_agent_answer.", "tags": [ "Agent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Take the wheel of a live run, or hand it back. Taking it PAUSES the agent where it stands with the browser still open, and answers the URL a person drives it at; handing it back resumes the same run on whatever page you left it on. Use it when a run needs a human for one step (a login you will not automate, a form only you can fill); not to stop a run, which is outcrawl_agent_cancel, and not to answer a question the agent asked, which is outcrawl_agent_answer.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "agent.control", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_agent_control", "x-cli-command": "agent control", "x-sdk-method-ts": "oc.agent.control(...)", "x-sdk-method-py": "oc.agent.control(...)" } }, "/v1/agent/{id}/answer": { "post": { "operationId": "agentAnswer", "summary": "Answer the question a paused run is waiting on, and it carries on from where it stopped.", "description": "Answer the question a paused run is waiting on, and it carries on from where it stopped. A run parks when it needs something only you know (which of two options, a detail you did not give it) and reports the question on its status and its event stream. Use it to unblock a run whose status is paused; not to send a run new instructions, which no route does, and not to take over the browser yourself, which is outcrawl_agent_control.", "tags": [ "Agent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Answer the question a paused run is waiting on, and it carries on from where it stopped. A run parks when it needs something only you know (which of two options, a detail you did not give it) and reports the question on its status and its event stream. Use it to unblock a run whose status is paused; not to send a run new instructions, which no route does, and not to take over the browser yourself, which is outcrawl_agent_control.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "agent.answer", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_agent_answer", "x-cli-command": "agent answer", "x-sdk-method-ts": "oc.agent.answer(...)", "x-sdk-method-py": "oc.agent.answer(...)" } }, "/v1/agent/{id}/files": { "post": { "operationId": "agentFiles", "summary": "Hand a file to a run so it can attach it to a page: at submit time, mid-run, or before its first step.", "description": "Hand a file to a run so it can attach it to a page: at submit time, mid-run, or before its first step. Answers a HANDLE the agent uses with attachFile; you never send the bytes twice and the model never sees them. The file is destroyed when the run ends, on every ending. Use it for something the task needs to upload; not to fetch a file the run downloaded, which is outcrawl_agent_downloads.", "tags": [ "Agent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Hand a file to a run so it can attach it to a page: at submit time, mid-run, or before its first step. Answers a HANDLE the agent uses with attachFile; you never send the bytes twice and the model never sees them. The file is destroyed when the run ends, on every ending. Use it for something the task needs to upload; not to fetch a file the run downloaded, which is outcrawl_agent_downloads.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "agent.files", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_agent_file_add", "x-cli-command": "agent files add", "x-sdk-method-ts": "oc.agent.files(...)", "x-sdk-method-py": "oc.agent.files(...)" } }, "/v1/agent/{id}/downloads": { "get": { "operationId": "agentDownloads", "summary": "Every file the run's browser downloaded, kept 7 days, up to 200 MB each: name, content type, size, the URL it came fr...", "description": "Every file the run's browser downloaded, kept 7 days, up to 200 MB each: name, content type, size, the URL it came from, and a link to the bytes that works for an hour with no API key. Use it to get a file the run downloaded, such as an invoice PDF or a CSV export; not for the run's extracted data, which is outcrawl_agent_results.", "tags": [ "Agent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Every file the run's browser downloaded, kept 7 days, up to 200 MB each: name, content type, size, the URL it came from, and a link to the bytes that works for an hour with no API key. Use it to get a file the run downloaded, such as an invoice PDF or a CSV export; not for the run's extracted data, which is outcrawl_agent_results.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "agent.downloads", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_agent_downloads", "x-cli-command": "agent downloads", "x-sdk-method-ts": "oc.agent.downloads(...)", "x-sdk-method-py": "oc.agent.downloads(...)" } }, "/v1/agent/{id}/secrets": { "post": { "operationId": "agentSecretsAdd", "summary": "Give a live run one temporary secret, held only in the memory of the machine running it and dropped when the run ends...", "description": "Give a live run one temporary secret, held only in the memory of the machine running it and dropped when the run ends: a text value, a whole card (which may carry its security code), a billing profile (kind details), or one card field such as a stored card’s security code (kind card_field). Answers 204. Use it to answer a run asking for a security code, or to hand a running checkout a card or billing details for this run only; not to store a credential, which is secrets.create.", "tags": [ "Agent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Give a live run one temporary secret, held only in the memory of the machine running it and dropped when the run ends: a text value, a whole card (which may carry its security code), a billing profile (kind details), or one card field such as a stored card’s security code (kind card_field). Answers 204. Use it to answer a run asking for a security code, or to hand a running checkout a card or billing details for this run only; not to store a credential, which is secrets.create.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "agent.secrets.add", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "agent secrets add", "x-sdk-method-ts": "oc.agent.secrets.add(...)", "x-sdk-method-py": "oc.agent.secrets.add(...)" } }, "/v1/agent/{id}/secret-intents": { "post": { "operationId": "agentSecretsIntent", "summary": "Get a single-use upload URL and token (at most five minutes, dead when the run ends) that let a browser add ONE tempo...", "description": "Get a single-use upload URL and token (at most five minutes, dead when the run ends) that let a browser add ONE temporary secret to ONE live run without the value passing through your server: a security code, a whole card, a billing profile or a text value. Name your checkout page’s origin when you mint it to send from your own page; without one, only the Outcrawl console may send it. Not for a value your server holds, which is agent.secrets.add.", "tags": [ "Agent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Get a single-use upload URL and token (at most five minutes, dead when the run ends) that let a browser add ONE temporary secret to ONE live run without the value passing through your server: a security code, a whole card, a billing profile or a text value. Name your checkout page’s origin when you mint it to send from your own page; without one, only the Outcrawl console may send it. Not for a value your server holds, which is agent.secrets.add.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "agent.secrets.intent", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": null, "x-sdk-method-ts": "oc.agent.secrets.intent(...)", "x-sdk-method-py": "oc.agent.secrets.intent(...)" } }, "/v1/profiles": { "post": { "operationId": "profilesCreate", "summary": "Create a profile with a pinned exit and persistent storage.", "description": "Create a profile with a pinned exit and persistent storage. Use to keep a login across sessions.", "tags": [ "Profiles" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Create a profile with a pinned exit and persistent storage. Use to keep a login across sessions.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "profiles.create", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_profile_create", "x-cli-command": "profiles create", "x-sdk-method-ts": "oc.profiles.create(...)", "x-sdk-method-py": "oc.profiles.create(...)" }, "get": { "operationId": "profilesList", "summary": "List profiles, optionally filtered by a label glob.", "description": "List profiles, optionally filtered by a label glob.", "tags": [ "Profiles" ], "responses": { "200": { "description": "List profiles, optionally filtered by a label glob.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "profiles.list", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_profile_list", "x-cli-command": "profiles ls", "x-sdk-method-ts": "oc.profiles.list(...)", "x-sdk-method-py": "oc.profiles.list(...)" } }, "/v1/profiles/{id}": { "get": { "operationId": "profilesGet", "summary": "Fetch one profile: its label, pinned exit and creation time.", "description": "Fetch one profile: its label, pinned exit and creation time.", "tags": [ "Profiles" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Fetch one profile: its label, pinned exit and creation time.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "profiles.get", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_profile_get", "x-cli-command": "profiles get", "x-sdk-method-ts": "oc.profiles.get(...)", "x-sdk-method-py": "oc.profiles.get(...)" }, "delete": { "operationId": "profilesDelete", "summary": "Delete a profile and its stored cookies and site data.", "description": "Delete a profile and its stored cookies and site data. Irreversible.", "tags": [ "Profiles" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Delete a profile and its stored cookies and site data. Irreversible.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "profiles.delete", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_profile_delete", "x-cli-command": "profiles rm", "x-sdk-method-ts": "oc.profiles.delete(...)", "x-sdk-method-py": "oc.profiles.delete(...)" } }, "/v1/sessions": { "get": { "operationId": "sessionsList", "summary": "Query past agent runs and browser sessions by status, outcome, task or age, each with its replay URL, duration, charg...", "description": "Query past agent runs and browser sessions by status, outcome, task or age, each with its replay URL, duration, charges and who may watch it. Use to find the session behind a charge or a failure; not for what happened inside one, which is outcrawl_session_network.", "tags": [ "Sessions" ], "responses": { "200": { "description": "Query past agent runs and browser sessions by status, outcome, task or age, each with its replay URL, duration, charges and who may watch it. Use to find the session behind a charge or a failure; not for what happened inside one, which is outcrawl_session_network.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "sessions.list", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_sessions_list", "x-cli-command": "sessions list", "x-sdk-method-ts": "oc.sessions.list(...)", "x-sdk-method-py": "oc.sessions.list(...)" } }, "/v1/sessions/{id}": { "get": { "operationId": "sessionsGet", "summary": "Fetch one session with its replay URL, share URL, tabs, duration, page count and charges.", "description": "Fetch one session with its replay URL, share URL, tabs, duration, page count and charges. This is how a charge is disputed: watch what it bought. Use for one session you hold the id of; not for its requests, which is outcrawl_session_network.", "tags": [ "Sessions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Fetch one session with its replay URL, share URL, tabs, duration, page count and charges. This is how a charge is disputed: watch what it bought. Use for one session you hold the id of; not for its requests, which is outcrawl_session_network.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "sessions.get", "x-framing": "json", "x-streams-when": "live", "x-mcp-tool": "outcrawl_sessions_get", "x-cli-command": "sessions get", "x-sdk-method-ts": "oc.sessions.get(...)", "x-sdk-method-py": "oc.sessions.get(...)" } }, "/v1/sessions/{id}/export": { "post": { "operationId": "sessionsExport", "summary": "Export a session as a portable bundle that plays offline.", "description": "Export a session as a portable bundle that plays offline.", "tags": [ "Sessions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Export a session as a portable bundle that plays offline.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "sessions.export", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": null, "x-sdk-method-ts": "oc.sessions.export(...)", "x-sdk-method-py": "oc.sessions.export(...)" } }, "/v1/sessions/{id}/events": { "get": { "operationId": "sessionsEvents", "summary": "Every event a session recorded, in order, as a stream: tabs, navigations, console, network phases, pointer, video chu...", "description": "Every event a session recorded, in order, as a stream: tabs, navigations, console, network phases, pointer, video chunks and agent marks, filtered by `kind` and `tab`, resumable with `after`, and kept open on a live session with `follow`. Use to replay or audit a session programmatically; not for a summary of what went wrong, which is the digest.", "tags": [ "Sessions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Every event a session recorded, in order, as a stream: tabs, navigations, console, network phases, pointer, video chunks and agent marks, filtered by `kind` and `tab`, resumable with `after`, and kept open on a live session with `follow`. Use to replay or audit a session programmatically; not for a summary of what went wrong, which is the digest.", "content": { "application/json": { "schema": { "type": "object", "description": "Streamed as newline-delimited JSON: a header frame followed by zero or more item frames, one JSON object per line. See the matching capability page under docs/app/ for the frame shapes." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "sessions.events", "x-framing": "ndjson", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "sessions events", "x-sdk-method-ts": "oc.sessions.events(...)", "x-sdk-method-py": "oc.sessions.events(...)" } }, "/v1/sessions/{id}/network": { "get": { "operationId": "sessionsNetwork", "summary": "Every request a session made, as a stream of folded rows with headers, timing, protocol, remote address, initiator an...", "description": "Every request a session made, as a stream of folded rows with headers, timing, protocol, remote address, initiator and sizes; filter by url, method, status, type, tab or duration, opt into stored bodies with `bodies`, and follow a live session with `follow`. Use to debug a session's traffic; not for a summary, which is the digest, and not for one request, which is sessions.request.", "tags": [ "Sessions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Every request a session made, as a stream of folded rows with headers, timing, protocol, remote address, initiator and sizes; filter by url, method, status, type, tab or duration, opt into stored bodies with `bodies`, and follow a live session with `follow`. Use to debug a session's traffic; not for a summary, which is the digest, and not for one request, which is sessions.request.", "content": { "application/json": { "schema": { "type": "object", "description": "Streamed as newline-delimited JSON: a header frame followed by zero or more item frames, one JSON object per line. See the matching capability page under docs/app/ for the frame shapes." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "sessions.network", "x-framing": "ndjson", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "sessions network", "x-sdk-method-ts": "oc.sessions.network(...)", "x-sdk-method-py": "oc.sessions.network(...)" } }, "/v1/sessions/{id}/digest": { "get": { "operationId": "sessionsNetworkDigest", "summary": "What went wrong in a session, compactly: failed, blocked and 4xx/5xx requests, the slowest ones, the site's own XHR/f...", "description": "What went wrong in a session, compactly: failed, blocked and 4xx/5xx requests, the slowest ones, the site's own XHR/fetch calls, per-origin totals, console errors and the tabs, every list capped and no headers or bodies. Use first when a run failed or a page misbehaved; then fetch one request in full with outcrawl_session_request.", "tags": [ "Sessions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "What went wrong in a session, compactly: failed, blocked and 4xx/5xx requests, the slowest ones, the site's own XHR/fetch calls, per-origin totals, console errors and the tabs, every list capped and no headers or bodies. Use first when a run failed or a page misbehaved; then fetch one request in full with outcrawl_session_request.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "sessions.network.digest", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_session_network", "x-cli-command": "sessions digest", "x-sdk-method-ts": "oc.sessions.network.digest(...)", "x-sdk-method-py": "oc.sessions.network.digest(...)" } }, "/v1/sessions/{id}/request": { "get": { "operationId": "sessionsRequest", "summary": "One request of a session in full, by the `requestId` the digest or the network stream named: request and response hea...", "description": "One request of a session in full, by the `requestId` the digest or the network stream named: request and response headers, timing, protocol, remote address, initiator, redirect, sizes and its stored body when there is one. Not for listing requests.", "tags": [ "Sessions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "One request of a session in full, by the `requestId` the digest or the network stream named: request and response headers, timing, protocol, remote address, initiator, redirect, sizes and its stored body when there is one. Not for listing requests.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "sessions.request", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_session_request", "x-cli-command": "sessions request", "x-sdk-method-ts": "oc.sessions.request(...)", "x-sdk-method-py": "oc.sessions.request(...)" } }, "/v1/sessions/{id}/console": { "get": { "operationId": "sessionsConsole", "summary": "The console lines a session's pages produced, a page at a time, oldest first, filtered by level and tab, with the scr...", "description": "The console lines a session's pages produced, a page at a time, oldest first, filtered by level and tab, with the script URL and line when the browser knew them.", "tags": [ "Sessions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "The console lines a session's pages produced, a page at a time, oldest first, filtered by level and tab, with the script URL and line when the browser knew them.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "sessions.console", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "sessions console", "x-sdk-method-ts": "oc.sessions.console(...)", "x-sdk-method-py": "oc.sessions.console(...)" } }, "/v1/sessions/{id}/har": { "get": { "operationId": "sessionsHar", "summary": "A session's network as a HAR 1.2 file that opens in a browser's developer tools, with stored bodies inline.", "description": "A session's network as a HAR 1.2 file that opens in a browser's developer tools, with stored bodies inline. Use to hand traffic to a tool that reads HAR; not for reading in code, which is sessions.network.", "tags": [ "Sessions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "A session's network as a HAR 1.2 file that opens in a browser's developer tools, with stored bodies inline. Use to hand traffic to a tool that reads HAR; not for reading in code, which is sessions.network.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "sessions.har", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "sessions har", "x-sdk-method-ts": "oc.sessions.har(...)", "x-sdk-method-py": "oc.sessions.har(...)" } }, "/v1/sessions/{id}/videos": { "get": { "operationId": "sessionsVideos", "summary": "Links to a session's video, one per recorded stretch of each tab, with its time range and size, plus the tabs.", "description": "Links to a session's video, one per recorded stretch of each tab, with its time range and size, plus the tabs. Fetch a link with the same API key.", "tags": [ "Sessions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Links to a session's video, one per recorded stretch of each tab, with its time range and size, plus the tabs. Fetch a link with the same API key.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "sessions.videos", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "sessions videos", "x-sdk-method-ts": "oc.sessions.videos(...)", "x-sdk-method-py": "oc.sessions.videos(...)" } }, "/v1/sessions/{id}/downloads": { "get": { "operationId": "sessionsDownloads", "summary": "Every file a browser session you drove over /connect downloaded, kept 7 days, up to 200 MB each: name, content type, ...", "description": "Every file a browser session you drove over /connect downloaded, kept 7 days, up to 200 MB each: name, content type, size, the URL it came from, and a link to the bytes that works for an hour with no API key. Use it to get a file your own script downloaded; not for an agent run's files, which is outcrawl_agent_downloads.", "tags": [ "Sessions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Every file a browser session you drove over /connect downloaded, kept 7 days, up to 200 MB each: name, content type, size, the URL it came from, and a link to the bytes that works for an hour with no API key. Use it to get a file your own script downloaded; not for an agent run's files, which is outcrawl_agent_downloads.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "sessions.downloads", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_session_downloads", "x-cli-command": "sessions downloads", "x-sdk-method-ts": "oc.sessions.downloads(...)", "x-sdk-method-py": "oc.sessions.downloads(...)" } }, "/v1/sessions/{id}/share": { "post": { "operationId": "sessionsShare", "summary": "Choose who may watch a session besides your own API keys: `private` (your organization, the default), `link` (anyone ...", "description": "Choose who may watch a session besides your own API keys: `private` (your organization, the default), `link` (anyone holding the returned share URL) or `people` (named Outcrawl users, by email). Setting `private` revokes sharing and rotates the link.", "tags": [ "Sessions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Choose who may watch a session besides your own API keys: `private` (your organization, the default), `link` (anyone holding the returned share URL) or `people` (named Outcrawl users, by email). Setting `private` revokes sharing and rotates the link.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "sessions.share", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "sessions share", "x-sdk-method-ts": "oc.sessions.share(...)", "x-sdk-method-py": "oc.sessions.share(...)" } }, "/v1/usage": { "get": { "operationId": "usage", "summary": "Aggregate the same usage numbers already attached to each call.", "description": "Aggregate the same usage numbers already attached to each call. Nothing appears here that was not visible on the call that caused it.", "tags": [ "Usage" ], "responses": { "200": { "description": "Aggregate the same usage numbers already attached to each call. Nothing appears here that was not visible on the call that caused it.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "usage", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_usage", "x-cli-command": "usage", "x-sdk-method-ts": "oc.usage(...)", "x-sdk-method-py": "oc.usage(...)" } }, "/v1/credits": { "get": { "operationId": "credits", "summary": "What this account has been granted, what it has spent against the grant, and what is left.", "description": "What this account has been granted, what it has spent against the grant, and what is left. Use to see a promotional or student balance and when it lapses; not for the monthly plan allowance, and not for per-call cost, which every response already carries.", "tags": [ "Credits" ], "responses": { "200": { "description": "What this account has been granted, what it has spent against the grant, and what is left. Use to see a promotional or student balance and when it lapses; not for the monthly plan allowance, and not for per-call cost, which every response already carries.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "credits", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_credits", "x-cli-command": "credits", "x-sdk-method-ts": "oc.credits(...)", "x-sdk-method-py": "oc.credits(...)" } }, "/v1/secrets": { "post": { "operationId": "secretsCreate", "summary": "Store a credential under a handle an agent can reference but never read.", "description": "Store a credential under a handle an agent can reference but never read. Use to save a card or an environment variable for a run to use; not to read one back, which nothing can do.", "tags": [ "Secrets" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Store a credential under a handle an agent can reference but never read. Use to save a card or an environment variable for a run to use; not to read one back, which nothing can do.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "secrets.create", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "secrets create", "x-sdk-method-ts": "oc.secrets.create(...)", "x-sdk-method-py": "oc.secrets.create(...)" }, "get": { "operationId": "secretsList", "summary": "List stored credentials by handle, with the last four digits of a card and nothing else.", "description": "List stored credentials by handle, with the last four digits of a card and nothing else. No route returns a value, and that absence is the point.", "tags": [ "Secrets" ], "responses": { "200": { "description": "List stored credentials by handle, with the last four digits of a card and nothing else. No route returns a value, and that absence is the point.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "secrets.list", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "secrets ls", "x-sdk-method-ts": "oc.secrets.list(...)", "x-sdk-method-py": "oc.secrets.list(...)" } }, "/v1/secrets/{id}": { "delete": { "operationId": "secretsDelete", "summary": "Delete a credential and the record of which runs used it.", "description": "Delete a credential and the record of which runs used it. Takes effect on the next fill: a run holding a grant finds nothing to resolve.", "tags": [ "Secrets" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Delete a credential and the record of which runs used it. Takes effect on the next fill: a run holding a grant finds nothing to resolve.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "secrets.delete", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "secrets rm", "x-sdk-method-ts": "oc.secrets.delete(...)", "x-sdk-method-py": "oc.secrets.delete(...)" } }, "/v1/secrets/intents": { "post": { "operationId": "secretsIntent", "summary": "Get a single-use, five-minute upload URL and token that let a browser store ONE secret under ONE name without the val...", "description": "Get a single-use, five-minute upload URL and token that let a browser store ONE secret under ONE name without the value passing through your server. Use when a person types a credential into your own web page; not to store a value you already hold, which is secrets.create.", "tags": [ "Secrets" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Get a single-use, five-minute upload URL and token that let a browser store ONE secret under ONE name without the value passing through your server. Use when a person types a credential into your own web page; not to store a value you already hold, which is secrets.create.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "secrets.intent", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": null, "x-sdk-method-ts": "oc.secrets.intent(...)", "x-sdk-method-py": "oc.secrets.intent(...)" } }, "/v1/secrets/batch": { "post": { "operationId": "secretsBatch", "summary": "Store up to 500 credentials in one call, with one result per item and never a value.", "description": "Store up to 500 credentials in one call, with one result per item and never a value. Use to import a wallet of cards or payment details, retry-safe per handle (onConflict skip or replace); not for one secret, which is secrets.create.", "tags": [ "Secrets" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Store up to 500 credentials in one call, with one result per item and never a value. Use to import a wallet of cards or payment details, retry-safe per handle (onConflict skip or replace); not for one secret, which is secrets.create.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "secrets.batch", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "secrets import", "x-sdk-method-ts": "oc.secrets.batch(...)", "x-sdk-method-py": "oc.secrets.batch(...)" } }, "/v1/rules": { "get": { "operationId": "rulesGet", "summary": "The workspace rules and, for each one, whether it is ENFORCED as a gate that blocks a dispatch or is only GUIDANCE in...", "description": "The workspace rules and, for each one, whether it is ENFORCED as a gate that blocks a dispatch or is only GUIDANCE in the prompt. Use it to check that a rule you wrote is actually enforced; the class is the answer, not the text.", "tags": [ "Rules" ], "responses": { "200": { "description": "The workspace rules and, for each one, whether it is ENFORCED as a gate that blocks a dispatch or is only GUIDANCE in the prompt. Use it to check that a rule you wrote is actually enforced; the class is the answer, not the text.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "rules.get", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_rules_get", "x-cli-command": "rules get", "x-sdk-method-ts": "oc.rules.get(...)", "x-sdk-method-py": "oc.rules.get(...)" }, "put": { "operationId": "rulesSet", "summary": "Replace the workspace rules with these plain-language sentences and get the classification back on the same call.", "description": "Replace the workspace rules with these plain-language sentences and get the classification back on the same call. Use to forbid something in your own words; a rule that could not be compiled into a gate comes back as guidance with the reason.", "tags": [ "Rules" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Replace the workspace rules with these plain-language sentences and get the classification back on the same call. Use to forbid something in your own words; a rule that could not be compiled into a gate comes back as guidance with the reason.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "rules.set", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": "outcrawl_rules_set", "x-cli-command": "rules set", "x-sdk-method-ts": "oc.rules.set(...)", "x-sdk-method-py": "oc.rules.set(...)" } }, "/v1/integrations": { "post": { "operationId": "integrationsConnect", "summary": "Connect an MCP server (Gmail, Slack, Twilio) so a run can call its tools mid-task.", "description": "Connect an MCP server (Gmail, Slack, Twilio) so a run can call its tools mid-task. HTTPS endpoints only, authenticated by a secret handle, and no run reaches it unless the run names it. Use to give an agent a way past a wall the browser cannot climb; not to store the credential itself, which is a secret and has no tool.", "tags": [ "Integrations" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Connect an MCP server (Gmail, Slack, Twilio) so a run can call its tools mid-task. HTTPS endpoints only, authenticated by a secret handle, and no run reaches it unless the run names it. Use to give an agent a way past a wall the browser cannot climb; not to store the credential itself, which is a secret and has no tool.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "integrations.connect", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "integrations connect", "x-sdk-method-ts": "oc.integrations.connect(...)", "x-sdk-method-py": "oc.integrations.connect(...)" }, "get": { "operationId": "integrationsList", "summary": "Everything an agent can reach outside the browser: each connected server, the tools it exposes, and the secret handle...", "description": "Everything an agent can reach outside the browser: each connected server, the tools it exposes, and the secret handle it authenticates with. This is the blast radius, and a customer who cannot see it cannot consent to it.", "tags": [ "Integrations" ], "responses": { "200": { "description": "Everything an agent can reach outside the browser: each connected server, the tools it exposes, and the secret handle it authenticates with. This is the blast radius, and a customer who cannot see it cannot consent to it.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "integrations.list", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "integrations ls", "x-sdk-method-ts": "oc.integrations.list(...)", "x-sdk-method-py": "oc.integrations.list(...)" } }, "/v1/integrations/test": { "post": { "operationId": "integrationsTest", "summary": "Check an MCP server before connecting it: calls its tool list with the credential a secret handle names, and answers ...", "description": "Check an MCP server before connecting it: calls its tool list with the credential a secret handle names, and answers ok with the tools it offers, or not ok with the reason (not_mcp, unauthorized, unreachable, missing_secret) and what to do. Stores nothing and grants nothing.", "tags": [ "Integrations" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Check an MCP server before connecting it: calls its tool list with the credential a secret handle names, and answers ok with the tools it offers, or not ok with the reason (not_mcp, unauthorized, unreachable, missing_secret) and what to do. Stores nothing and grants nothing.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "integrations.test", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "integrations test", "x-sdk-method-ts": "oc.integrations.test(...)", "x-sdk-method-py": "oc.integrations.test(...)" } }, "/v1/integrations/{id}": { "patch": { "operationId": "integrationsUpdate", "summary": "Change a connected server's tool list or the secret handle it authenticates with, without disconnecting it.", "description": "Change a connected server's tool list or the secret handle it authenticates with, without disconnecting it. A new secret is checked against the server first and refused if it does not work.", "tags": [ "Integrations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Change a connected server's tool list or the secret handle it authenticates with, without disconnecting it. A new secret is checked against the server first and refused if it does not work.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "integrations.update", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "integrations update", "x-sdk-method-ts": "oc.integrations.update(...)", "x-sdk-method-py": "oc.integrations.update(...)" }, "delete": { "operationId": "integrationsDelete", "summary": "Disconnect an MCP server.", "description": "Disconnect an MCP server. Takes effect on the next call: a run already holding a grant finds the connector gone and is told so. The credential is untouched: it lives in the secrets store and is deleted there.", "tags": [ "Integrations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Disconnect an MCP server. Takes effect on the next call: a run already holding a grant finds the connector gone and is told so. The credential is untouched: it lives in the secrets store and is deleted there.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "integrations.delete", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "integrations rm", "x-sdk-method-ts": "oc.integrations.delete(...)", "x-sdk-method-py": "oc.integrations.delete(...)" } }, "/v1/agent/{id}/purchases": { "get": { "operationId": "agentPurchases", "summary": "List the purchases one run opened: merchant, amount, the card by handle and last four, and how each ended (completed,...", "description": "List the purchases one run opened: merchant, amount, the card by handle and last four, and how each ended (completed, declined, abandoned, unknown, or still reserved). Use to reconcile a run's checkout; not for the run's credits, which are on agent.get.", "tags": [ "Agent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "List the purchases one run opened: merchant, amount, the card by handle and last four, and how each ended (completed, declined, abandoned, unknown, or still reserved). Use to reconcile a run's checkout; not for the run's credits, which are on agent.get.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "agent.purchases", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "agent purchases", "x-sdk-method-ts": "oc.agent.purchases(...)", "x-sdk-method-py": "oc.agent.purchases(...)" } }, "/v1/purchases": { "get": { "operationId": "purchasesList", "summary": "List every purchase your runs made, newest first, filtered by card, merchant, status or time.", "description": "List every purchase your runs made, newest first, filtered by card, merchant, status or time. Use to reconcile spending across runs; not one run's purchases, which is agent.purchases.", "tags": [ "Purchases" ], "responses": { "200": { "description": "List every purchase your runs made, newest first, filtered by card, merchant, status or time. Use to reconcile spending across runs; not one run's purchases, which is agent.purchases.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "purchases.list", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "purchases ls", "x-sdk-method-ts": "oc.purchases.list(...)", "x-sdk-method-py": "oc.purchases.list(...)" } }, "/v1/wallet/settings": { "get": { "operationId": "walletSettingsGet", "summary": "Read the workspace wallet settings: approvalAbove, the purchase amount above which a run pauses for a person's yes.", "description": "Read the workspace wallet settings: approvalAbove, the purchase amount above which a run pauses for a person's yes. Null means off, the default.", "tags": [ "Wallet" ], "responses": { "200": { "description": "Read the workspace wallet settings: approvalAbove, the purchase amount above which a run pauses for a person's yes. Null means off, the default.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "wallet.settings.get", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "wallet settings", "x-sdk-method-ts": "oc.wallet.settings.get(...)", "x-sdk-method-py": "oc.wallet.settings.get(...)" }, "put": { "operationId": "walletSettingsSet", "summary": "Set approvalAbove { amount, currency }, or null to turn it off: a purchase within a run's spend cap and above this am...", "description": "Set approvalAbove { amount, currency }, or null to turn it off: a purchase within a run's spend cap and above this amount pauses the run until a person answers approve true or false. It never lets a purchase past the cap.", "tags": [ "Wallet" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Set approvalAbove { amount, currency }, or null to turn it off: a purchase within a run's spend cap and above this amount pauses the run until a person answers approve true or false. It never lets a purchase past the cap.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "wallet.settings.set", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "wallet settings set", "x-sdk-method-ts": "oc.wallet.settings.set(...)", "x-sdk-method-py": "oc.wallet.settings.set(...)" } }, "/v1/wallet/providers": { "get": { "operationId": "walletProvidersList", "summary": "List the five card providers a workspace can connect (Privacy.com, Brex, Slash, Stripe Issuing, Airwallex): regions, ...", "description": "List the five card providers a workspace can connect (Privacy.com, Brex, Slash, Stripe Issuing, Airwallex): regions, currencies, the credential fields each needs, what its cards can do, and whether this deployment can connect it now. Use before connecting one; not your connected accounts, which is wallet.connections.list.", "tags": [ "Wallet" ], "responses": { "200": { "description": "List the five card providers a workspace can connect (Privacy.com, Brex, Slash, Stripe Issuing, Airwallex): regions, currencies, the credential fields each needs, what its cards can do, and whether this deployment can connect it now. Use before connecting one; not your connected accounts, which is wallet.connections.list.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "wallet.providers.list", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "wallet providers", "x-sdk-method-ts": "oc.wallet.providers.list(...)", "x-sdk-method-py": "oc.wallet.providers.list(...)" } }, "/v1/wallet/connections": { "get": { "operationId": "walletConnectionsList", "summary": "List the card provider accounts this workspace has connected, newest first: handle, provider, account name, status (a...", "description": "List the card provider accounts this workspace has connected, newest first: handle, provider, account name, status (active, failing, revoked, pending), warnings and cards made this period. Never a credential, and no route returns one.", "tags": [ "Wallet" ], "responses": { "200": { "description": "List the card provider accounts this workspace has connected, newest first: handle, provider, account name, status (active, failing, revoked, pending), warnings and cards made this period. Never a credential, and no route returns one.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "wallet.connections.list", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "wallet connections", "x-sdk-method-ts": "oc.wallet.connections.list(...)", "x-sdk-method-py": "oc.wallet.connections.list(...)" }, "post": { "operationId": "walletConnectionsCreate", "summary": "Connect a card provider account with a credential your server holds: the provider's test runs first and the credentia...", "description": "Connect a card provider account with a credential your server holds: the provider's test runs first and the credential is sealed only if it passes (422 provider_test_failed, nothing stored, if not). The same handle again rotates the credential, replacing the old one only if the new one passes. Runs then mint one card per run from it.", "tags": [ "Wallet" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Connect a card provider account with a credential your server holds: the provider's test runs first and the credential is sealed only if it passes (422 provider_test_failed, nothing stored, if not). The same handle again rotates the credential, replacing the old one only if the new one passes. Runs then mint one card per run from it.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "wallet.connections.create", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "wallet connect", "x-sdk-method-ts": "oc.wallet.connections.create(...)", "x-sdk-method-py": "oc.wallet.connections.create(...)" } }, "/v1/wallet/connections/{id}": { "get": { "operationId": "walletConnectionsGet", "summary": "Read one connected card provider account by id: its status and the reason for it, the account name, warnings from the...", "description": "Read one connected card provider account by id: its status and the reason for it, the account name, warnings from the last test, and when it was last used and tested. Never a credential.", "tags": [ "Wallet" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Read one connected card provider account by id: its status and the reason for it, the account name, warnings from the last test, and when it was last used and tested. Never a credential.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "wallet.connections.get", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": null, "x-sdk-method-ts": "oc.wallet.connections.get(...)", "x-sdk-method-py": "oc.wallet.connections.get(...)" }, "delete": { "operationId": "walletConnectionsDelete", "summary": "Disconnect a card provider account: every card a run made from it that is still open is closed first, then the creden...", "description": "Disconnect a card provider account: every card a run made from it that is still open is closed first, then the credential is deleted. A run using it fails its next fill with a sentence naming the connection.", "tags": [ "Wallet" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "responses": { "200": { "description": "Disconnect a card provider account: every card a run made from it that is still open is closed first, then the credential is deleted. A run using it fails its next fill with a sentence naming the connection.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "wallet.connections.delete", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "wallet disconnect", "x-sdk-method-ts": "oc.wallet.connections.delete(...)", "x-sdk-method-py": "oc.wallet.connections.delete(...)" } }, "/v1/wallet/connections/intents": { "post": { "operationId": "walletConnectionsIntent", "summary": "Get a single-use upload URL and token (at most five minutes) that let a browser connect ONE card provider under ONE h...", "description": "Get a single-use upload URL and token (at most five minutes) that let a browser connect ONE card provider under ONE handle without the credential passing through your server. Name your page's origin to send from your own page; without one, only the Outcrawl console may send it. Not for a credential your server holds, which is wallet.connections.create.", "tags": [ "Wallet" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Get a single-use upload URL and token (at most five minutes) that let a browser connect ONE card provider under ONE handle without the credential passing through your server. Name your page's origin to send from your own page; without one, only the Outcrawl console may send it. Not for a credential your server holds, which is wallet.connections.create.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "wallet.connections.intent", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": null, "x-sdk-method-ts": "oc.wallet.connections.intent(...)", "x-sdk-method-py": "oc.wallet.connections.intent(...)" } }, "/v1/wallet/connections/{id}/test": { "post": { "operationId": "walletConnectionsTest", "summary": "Run the provider's read-only test again on a connected account and get ok, the account name, warnings and the reason ...", "description": "Run the provider's read-only test again on a connected account and get ok, the account name, warnings and the reason it failed. Answers 200 either way, and the connection's status follows the result.", "tags": [ "Wallet" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` this route addresses." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "See the matching capability page under docs/app/ and the SDK reference for the exact fields this route accepts." } } } }, "responses": { "200": { "description": "Run the provider's read-only test again on a connected account and get ok, the account name, warnings and the reason it failed. Answers 200 either way, and the connection's status follows the result.", "content": { "application/json": { "schema": { "type": "object", "description": "See the matching capability page under docs/app/ and the SDK reference for the exact shape." } } } }, "400": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The request failed. `code` is one of the 22 values in the Error schema below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-outcrawl-capability": "wallet.connections.test", "x-framing": "json", "x-streams-when": null, "x-mcp-tool": null, "x-cli-command": "wallet test", "x-sdk-method-ts": "oc.wallet.connections.test(...)", "x-sdk-method-py": "oc.wallet.connections.test(...)" } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "http", "scheme": "bearer", "description": "An Outcrawl API key, `ock_.`, minted in the console at https://outcrawl.ai/console/keys, or an OAuth access token, `oat_...`, issued by https://outcrawl.ai/api/auth with scope `api` (the CLI gets one from `outcrawl login`, an MCP client when it signs in)." } }, "schemas": { "Error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Machine-readable, one of the 45 values in the closed union. Branch on this, never on `message`.", "enum": [ "unauthorized", "profile_in_use", "cap_exceeded", "exit_unavailable", "no_capacity", "tenant_scope", "bad_request", "not_found", "profile_not_found", "method_not_allowed", "capability_unavailable", "decode_unavailable", "quota_exceeded", "concurrency_limit", "plan_required", "page_unreachable", "document_unrepresentable", "page_lost", "extraction_failed", "answer_lost", "deadline_exceeded", "lab_arm_forbidden", "search_refused", "integration_check_failed", "integration_changed", "secret_intent_invalid", "secret_intent_spent", "cvc_not_storable", "run_secrets_limit", "run_secret_undeliverable", "replay_access_denied", "replay_control_denied", "replay_control_cross_site", "spend_cap_required", "card_number_in_task", "merchant_not_allowed", "spend_cap_exceeded", "per_purchase_exceeded", "no_open_purchase", "approval_denied", "approval_timed_out", "secret_in_answer", "provider_test_failed", "provider_cards_open", "internal" ] }, "message": { "type": "string", "description": "Human-readable, fixed per code. Never parsed." }, "details": { "type": "object", "additionalProperties": true, "description": "Optional structured context, shape depends on `code`." } } } } } }