{ "components": { "securitySchemes": { "bearerAuth": { "scheme": "bearer", "type": "http" } }, "schemas": {}, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "links": {}, "callbacks": {}, "pathItems": {} }, "info": { "description": "", "title": "Olostep", "version": "1", "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" } }, "x-aisa-configured-paths": [ "/apis/v1/olostep/web-answer", "/apis/v1/olostep/web-map-search", "/apis/v1/olostep/web-scrape", "/apis/v1/olostep/web-search" ], "x-aisa-document": { "facts_hash": "38c943bb476bb18b1fd99fb8db9bcad82d14ebb7b44a3a9a333afafc8c0ebc6d", "generator_version": "3", "protocol_version": "1", "schema_version": "1", "composer_version": "28", "response_pending": [ { "operation_id": "olostep.web-map-search", "path": "/apis/v1/olostep/web-map-search", "method": "POST", "statuses": [ "200" ], "reason": "public success response has no authoritative payload declaration" }, { "operation_id": "olostep.web-scrape", "path": "/apis/v1/olostep/web-scrape", "method": "POST", "statuses": [ "200" ], "reason": "public success response has no authoritative payload declaration" }, { "operation_id": "olostep.web-search", "path": "/apis/v1/olostep/web-search", "method": "POST", "statuses": [ "200" ], "reason": "public success response has no authoritative payload declaration" } ], "document_hash": "sha256:d292380cc6ac89b3653805e92d147fdf2ed491025bff124abf6a194f3ca6fe3f" }, "x-aisa-plans": { "builder": 1.0, "display_plan": "payg", "payg": 1.0, "similarweb_payg": 1.0, "team": 1.0, "version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb" }, "x-aisa-provider": "olostep", "x-aisa-catalogs": { "olostep": { "title": "Olostep", "description": "", "x-aisa-document": { "facts_hash": "38c943bb476bb18b1fd99fb8db9bcad82d14ebb7b44a3a9a333afafc8c0ebc6d", "generator_version": "3", "protocol_version": "1", "schema_version": "1" }, "x-aisa-plans": { "builder": 1.0, "display_plan": "payg", "payg": 1.0, "similarweb_payg": 1.0, "team": 1.0, "version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb" }, "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" } } } } }, "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "openapi": "3.1.0", "security": [ { "bearerAuth": [] } ], "servers": [ { "url": "https://api.aisa.one" } ], "paths": { "/apis/v1/olostep/web-map-search": { "post": { "description": "Olostep bills one credit for the first 1,000 returned URLs and another credit per additional 1,000. Requiring top_n <= 1,000 makes the platform hold exact. Unbounded mapping is available through a team's own raw Olostep tool.\n\n\nUsage-based billing; Default request estimate: $0.002 USD (not a fixed price). Declared unit rate: $0.000001 USD per provider_credit. Account-specific pricing and final settlement may differ.\n", "operationId": "olostep.web-map-search", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "minLength": 1, "type": "string" }, "search_query": { "minLength": 1, "type": "string", "examples": [ "billing and credit documentation" ] }, "top_n": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "The 1,000-URL cap keeps this request inside Olostep's first one-credit map band.", "examples": [ 10 ] }, "include_subdomain": { "type": "boolean", "default": true }, "include_urls": { "type": "array", "items": { "type": "string" } }, "exclude_urls": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "search_query", "top_n", "url" ] } } } }, "responses": { "200": { "description": "Successful response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Find relevant URLs on a website", "tags": [ "Olostep" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": false, "mpp_methods": [], "x402": false }, "x-aisa-category": "search", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "response_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.002, "estimate_source": "profile_seed", "evidence_source": "response_header", "unit": "provider_credit", "unit_rate_usd": 1e-06 }, "x-aisa-query-policy": { "ignore_undeclared": false, "open_query": true, "request_wins": false }, "x-aisa-revision": { "customer_pricing_ref": "fda7874df42d", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "6e42c885a92c" }, "x-aisa-status": "enabled", "x-aisa-validation": "mixed", "x-aisa-catalog-id": "olostep", "x-aisa-runtime-operation": { "operation_id": "olostep.web-map-search", "method": "POST", "path": "/apis/v1/olostep/web-map-search" }, "x-aisa-source": { "kind": "manual", "url": "https://raw.githubusercontent.com/superdesigndev/treg/95670bbae5561fce0ea55c1e0ee4216eb34cbf18/src/treg/catalog/", "fetched_at": "2026-11-07T11:52:30.302332+00:00", "content_hash": "sha256:3ba9b222c7b0d3b69c4895ec21da5d6e6d8a55ffb2152b5d5c1a65bcc2973566", "raw_content_hash": "sha256:0804b46b6fb80c59d215e1ed43032d11e13328e2c2ade48d85c75ae00fd9cb68", "converter": "scripts/prepare_treg_public_reference.py@1", "path_space": "public", "refresh_policy": "pinned", "refresh_reason": "Review immutable provider declarations and both gateway HTTP boundaries together.", "source_git_revision": "95670bbae5561fce0ea55c1e0ee4216eb34cbf18", "source_pages": [ { "url": "https://raw.githubusercontent.com/superdesigndev/treg/95670bbae5561fce0ea55c1e0ee4216eb34cbf18/src/treg/application/call/resolve.py", "scope": "pathParams arrive as query; array enum and numeric bounds semantics" }, { "url": "https://raw.githubusercontent.com/superdesigndev/treg/95670bbae5561fce0ea55c1e0ee4216eb34cbf18/src/treg/domain/catalog/schema/common.py", "scope": "Parameter declaration vocabulary and optional required flag" } ], "qualification": "Request-only source review candidate. Exact declarations retained; unsupported shapes remain pending. No formal approval or response schema asserted.", "owner": "AIsa-team/docs", "review_period_days": 30, "policy_revision": "sha256:5284e1076511154e5bd27c88cf8f1f29cf6ca5b51a779bd931e39faa66f99978" }, "x-aisa-response-pending": { "operation_id": "olostep.web-map-search", "path": "/apis/v1/olostep/web-map-search", "method": "POST", "statuses": [ "200" ], "reason": "public success response has no authoritative payload declaration" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/olostep/olostep-web-map-search" } }, "/apis/v1/olostep/web-scrape": { "post": { "description": "This is the fixed one-credit surface. Olostep parsers and LLM extraction are not accepted by this catalog tool; a team can call them directly through its own raw Olostep tool.\n\n\nA request reference price is not currently available; use a request quote where supported. Declared unit rate: $0.000001 USD per provider_credit. Account-specific pricing and final settlement may differ.\n", "operationId": "olostep.web-scrape", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url_to_scrape": { "minLength": 1, "type": "string" }, "formats": { "items": { "enum": [ "markdown" ], "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array", "description": "Structured parsers, JSON extraction and llm_extract are deliberately excluded because they have separate variable credit prices." }, "max_age": { "type": "integer", "default": 0, "minimum": 0, "maximum": 604800, "description": "Reuse an Olostep scrape no older than this many seconds; 0 requests a fresh scrape." }, "remove_images": { "type": "boolean", "default": false }, "transformer": { "type": "string", "enum": [ "postlight", "none" ] }, "links_on_page": { "type": "object", "properties": { "query_to_order_links_by": { "type": "string" }, "include_links": { "type": "array", "items": { "type": "string" } }, "exclude_links": { "type": "array", "items": { "type": "string" } } } } }, "additionalProperties": false, "required": [ "formats", "url_to_scrape" ] } } } }, "responses": { "200": { "description": "Successful response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Scrape a web page", "tags": [ "Olostep" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": false, "mpp_methods": [], "x402": false }, "x-aisa-category": "search", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "response_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "estimate_source": "unavailable", "estimate_unavailable_reason": "reference_request_unavailable", "evidence_source": "response_header", "unit": "provider_credit", "unit_rate_usd": 1e-06 }, "x-aisa-query-policy": { "ignore_undeclared": false, "open_query": true, "request_wins": false }, "x-aisa-revision": { "customer_pricing_ref": "fda7874df42d", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "65d11b616481" }, "x-aisa-status": "enabled", "x-aisa-validation": "mixed", "x-aisa-catalog-id": "olostep", "x-aisa-runtime-operation": { "operation_id": "olostep.web-scrape", "method": "POST", "path": "/apis/v1/olostep/web-scrape" }, "x-aisa-source": { "kind": "manual", "url": "https://raw.githubusercontent.com/superdesigndev/treg/95670bbae5561fce0ea55c1e0ee4216eb34cbf18/src/treg/catalog/", "fetched_at": "2026-11-07T11:52:30.302332+00:00", "content_hash": "sha256:3ba9b222c7b0d3b69c4895ec21da5d6e6d8a55ffb2152b5d5c1a65bcc2973566", "raw_content_hash": "sha256:0804b46b6fb80c59d215e1ed43032d11e13328e2c2ade48d85c75ae00fd9cb68", "converter": "scripts/prepare_treg_public_reference.py@1", "path_space": "public", "refresh_policy": "pinned", "refresh_reason": "Review immutable provider declarations and both gateway HTTP boundaries together.", "source_git_revision": "95670bbae5561fce0ea55c1e0ee4216eb34cbf18", "source_pages": [ { "url": "https://raw.githubusercontent.com/superdesigndev/treg/95670bbae5561fce0ea55c1e0ee4216eb34cbf18/src/treg/application/call/resolve.py", "scope": "pathParams arrive as query; array enum and numeric bounds semantics" }, { "url": "https://raw.githubusercontent.com/superdesigndev/treg/95670bbae5561fce0ea55c1e0ee4216eb34cbf18/src/treg/domain/catalog/schema/common.py", "scope": "Parameter declaration vocabulary and optional required flag" } ], "qualification": "Request-only source review candidate. Exact declarations retained; unsupported shapes remain pending. No formal approval or response schema asserted.", "owner": "AIsa-team/docs", "review_period_days": 30, "policy_revision": "sha256:5284e1076511154e5bd27c88cf8f1f29cf6ca5b51a779bd931e39faa66f99978" }, "x-aisa-response-pending": { "operation_id": "olostep.web-scrape", "path": "/apis/v1/olostep/web-scrape", "method": "POST", "statuses": [ "200" ], "reason": "public success response has no authoritative payload declaration" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/olostep/olostep-web-scrape" } }, "/apis/v1/olostep/web-search": { "post": { "description": "The five-credit base search is exposed. scrape_options is deliberately excluded because it adds one or more scrape credits for every returned page.\n\n\nUsage-based billing; Default request estimate: $0.01 USD (not a fixed price). Declared unit rate: $0.000001 USD per provider_credit. Account-specific pricing and final settlement may differ.\n", "operationId": "olostep.web-search", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "minLength": 1, "type": "string", "examples": [ "Olostep API documentation" ] }, "limit": { "maximum": 25, "minimum": 1, "type": "integer", "examples": [ 5 ] }, "include_domains": { "type": "array", "items": { "type": "string" }, "maxItems": 20 }, "exclude_domains": { "type": "array", "items": { "type": "string" }, "maxItems": 20 }, "fast_mode": { "enum": [ false ], "type": "boolean" } }, "additionalProperties": false, "required": [ "fast_mode", "limit", "query" ] } } } }, "responses": { "200": { "description": "Successful response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Search the open web", "tags": [ "Olostep" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": false, "mpp_methods": [], "x402": false }, "x-aisa-category": "search", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "response_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.01, "estimate_source": "profile_seed", "evidence_source": "response_header", "unit": "provider_credit", "unit_rate_usd": 1e-06 }, "x-aisa-query-policy": { "ignore_undeclared": false, "open_query": true, "request_wins": false }, "x-aisa-revision": { "customer_pricing_ref": "fda7874df42d", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "5a2f6547ee30" }, "x-aisa-status": "enabled", "x-aisa-validation": "mixed", "x-aisa-catalog-id": "olostep", "x-aisa-runtime-operation": { "operation_id": "olostep.web-search", "method": "POST", "path": "/apis/v1/olostep/web-search" }, "x-aisa-source": { "kind": "manual", "url": "https://raw.githubusercontent.com/superdesigndev/treg/95670bbae5561fce0ea55c1e0ee4216eb34cbf18/src/treg/catalog/", "fetched_at": "2026-11-07T11:52:30.302332+00:00", "content_hash": "sha256:3ba9b222c7b0d3b69c4895ec21da5d6e6d8a55ffb2152b5d5c1a65bcc2973566", "raw_content_hash": "sha256:0804b46b6fb80c59d215e1ed43032d11e13328e2c2ade48d85c75ae00fd9cb68", "converter": "scripts/prepare_treg_public_reference.py@1", "path_space": "public", "refresh_policy": "pinned", "refresh_reason": "Review immutable provider declarations and both gateway HTTP boundaries together.", "source_git_revision": "95670bbae5561fce0ea55c1e0ee4216eb34cbf18", "source_pages": [ { "url": "https://raw.githubusercontent.com/superdesigndev/treg/95670bbae5561fce0ea55c1e0ee4216eb34cbf18/src/treg/application/call/resolve.py", "scope": "pathParams arrive as query; array enum and numeric bounds semantics" }, { "url": "https://raw.githubusercontent.com/superdesigndev/treg/95670bbae5561fce0ea55c1e0ee4216eb34cbf18/src/treg/domain/catalog/schema/common.py", "scope": "Parameter declaration vocabulary and optional required flag" } ], "qualification": "Request-only source review candidate. Exact declarations retained; unsupported shapes remain pending. No formal approval or response schema asserted.", "owner": "AIsa-team/docs", "review_period_days": 30, "policy_revision": "sha256:5284e1076511154e5bd27c88cf8f1f29cf6ca5b51a779bd931e39faa66f99978" }, "x-aisa-response-pending": { "operation_id": "olostep.web-search", "path": "/apis/v1/olostep/web-search", "method": "POST", "statuses": [ "200" ], "reason": "public success response has no authoritative payload declaration" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/olostep/olostep-web-search" } } } }