{ "openapi": "3.1.0", "info": { "title": "Social Dash Scraper", "version": "0.1.0", "description": "Independent stateless workers. Local URLs are examples; replace with operator-provided origins. See each platform for current private service availability." }, "tags": [ { "name": "Bluesky", "description": "Retrieve public Bluesky profiles, paginated user posts, and individual posts with nested replies." }, { "name": "Kick", "description": "Retrieve a public Kick clip with media URLs, counts, timestamps, category, creator, and channel details." }, { "name": "Komi", "description": "Retrieve creator profiles, social accounts, and rich links from public Komi pages." }, { "name": "Linkme", "description": "Retrieve a public Linkme profile with grouped contact links, social links, and page settings." }, { "name": "Linktree", "description": "Retrieve a public profile and its published links in one request." }, { "name": "Pillar", "description": "Retrieve a public Pillar creator profile, social links, link click counts, and featured products." }, { "name": "Pinterest", "description": "Search public pins, retrieve pin details, browse user boards, and read board pins." }, { "name": "Reddit", "description": "Discover public discussions and retrieve posts with bounded comments." }, { "name": "Twitch", "description": "Retrieve Twitch profiles, video pages, weekly schedules and complete public clips." } ], "paths": { "/v1/bluesky/profile": { "get": { "operationId": "blueskyProfile", "tags": [ "Bluesky" ], "summary": "Get a Bluesky profile", "description": "Retrieve a public Bluesky profile by handle, including DID, display name, bio, avatar, banner, follower/following/post counts and available source extensions.", "servers": [ { "url": "http://localhost:3013", "description": "Local worker; replace for deployment." } ], "security": [ { "bluesky": [] } ], "parameters": [ { "name": "handle", "in": "query", "required": true, "schema": { "type": "string", "minLength": 3, "maxLength": 253, "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$" }, "description": "Required domain-style Bluesky handle, without @ or a profile URL. Custom domain handles are supported.", "example": "example.test" } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/blueskyProfileResponseSchema" }, "example": { "success": true, "status": "success", "requestId": "00000000-0000-4000-8000-000000000001", "sourceUrl": "https://bsky.app/profile/example.test", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_api", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 1, "responseBytes": 1500, "durationMs": 300 }, "did": "did:plc:abcdefghijklmnopqrstuvwx", "handle": "example.test", "displayName": "Example", "description": "Synthetic profile", "followersCount": 12, "followsCount": 2, "postsCount": 3, "labels": [] } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } } } } }, "/v1/bluesky/user/posts": { "get": { "operationId": "blueskyPosts", "tags": [ "Bluesky" ], "summary": "Get a Bluesky user’s posts", "description": "Retrieve one author-feed page of up to 30 posts and reposts, including replies. Provide exactly one of handle or user_id. Pass the opaque response cursor unchanged to retrieve the next page. Each feed item is the complete source post view; feed wrappers such as repost reasons are not included.", "servers": [ { "url": "http://localhost:3013", "description": "Local worker; replace for deployment." } ], "security": [ { "bluesky": [] } ], "parameters": [ { "name": "handle", "in": "query", "required": false, "schema": { "type": "string", "minLength": 3, "maxLength": 253, "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$" }, "description": "One Bluesky handle; mutually exclusive with user_id.", "example": "example.test" }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "pattern": "^did:(?:plc:[a-z2-7]{24}|web:[a-zA-Z0-9._:%-]+(?::[a-zA-Z0-9._:%-]+)*)$" }, "description": "One did:plc or did:web account identifier, mutually exclusive with handle." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 2048, "x-runtime-refinement": true }, "description": "Opaque next-page cursor. Absence means the source provided no continuation; do not invent a cursor." } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/blueskyPostsResponseSchema" }, "example": { "success": true, "status": "success", "requestId": "00000000-0000-4000-8000-000000000001", "sourceUrl": "https://bsky.app/profile/example.test", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_api", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 1, "responseBytes": 1500, "durationMs": 300 }, "feed": [ { "uri": "at://did:plc:abcdefghijklmnopqrstuvwx/app.bsky.feed.post/3abcdefghijkl", "cid": "synthetic-cid", "author": { "did": "did:plc:abcdefghijklmnopqrstuvwx", "handle": "example.test" }, "record": { "$type": "app.bsky.feed.post", "text": "A synthetic public post.", "createdAt": "2026-09-10T00:00:00.000Z" }, "replyCount": 0, "repostCount": 1, "likeCount": 2, "quoteCount": 0, "indexedAt": "2026-09-10T00:00:01.000Z" } ], "cursor": "opaque-next-page" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } } } } }, "/v1/bluesky/post": { "get": { "operationId": "blueskyPost", "tags": [ "Bluesky" ], "summary": "Get a Bluesky post", "description": "Retrieve a public post and a bounded nested reply tree by HTTPS bsky.app URL. The profile segment accepts a handle or DID. Handles are resolved through the public profile API. Up to six reply levels and 100 visited reply nodes are included; ancestors are not fetched.", "servers": [ { "url": "http://localhost:3013", "description": "Local worker; replace for deployment." } ], "security": [ { "bluesky": [] } ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 4096, "x-runtime-refinement": true }, "description": "Required HTTPS bsky.app/profile//post/ URL. No credentials, ports or encoded path segments. Tracking query and fragment are discarded.", "example": "https://bsky.app/profile/example.test/post/3abcdefghijkl" } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/blueskyPostResponseSchema" }, "example": { "success": true, "status": "success", "requestId": "00000000-0000-4000-8000-000000000001", "sourceUrl": "https://bsky.app/profile/example.test/post/3abcdefghijkl", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_api", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 2, "responseBytes": 1500, "durationMs": 300 }, "post": { "uri": "at://did:plc:abcdefghijklmnopqrstuvwx/app.bsky.feed.post/3abcdefghijkl", "cid": "synthetic-cid", "author": { "did": "did:plc:abcdefghijklmnopqrstuvwx", "handle": "example.test" }, "record": { "$type": "app.bsky.feed.post", "text": "A synthetic public post.", "createdAt": "2026-09-10T00:00:00.000Z" }, "replyCount": 0, "repostCount": 1, "likeCount": 2, "quoteCount": 0, "indexedAt": "2026-09-10T00:00:01.000Z" }, "replies": [] } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } } } } }, "/v1/kick/clip": { "get": { "operationId": "kickClip", "tags": [ "Kick" ], "summary": "Get a Kick clip", "description": "Retrieve one public Kick clip from the public player metadata API for current counters. Media and thumbnail URLs are returned without downloading their contents. No channel discovery, clip listing, or video transcription is performed.", "servers": [ { "url": "http://localhost:3011", "description": "Local worker; replace for deployment." } ], "security": [ { "kick": [] } ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true, "format": "uri", "description": "HTTPS kick.com//clips/ or legacy kick.com/?clip=. No credentials or ports. Tracking parameters/fragments are removed; ambiguous clip IDs are rejected." }, "description": "Required HTTPS Kick clip URL. Canonical //clips/ and legacy /?clip= forms are supported. Duplicate/conflicting clip IDs are rejected.", "example": "https://kick.com/example/clips/clip_01JGJHB6CEVFCQRYTVPM8DW892" } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kickResponseSchema" }, "example": { "success": true, "status": "success", "clip": { "id": "clip_01JGJHB6CEVFCQRYTVPM8DW892", "livestream_id": "123", "category_id": "15", "channel_id": 10, "user_id": 20, "title": "Synthetic clip", "clip_url": "https://clips.kick.com/example/playlist.m3u8", "thumbnail_url": "https://clips.kick.com/example/thumbnail.webp", "privacy": "public", "likes": 0, "liked": false, "views": 42, "duration": 12.5, "started_at": "2026-09-10T00:00:00.123Z", "created_at": "2026-09-10T00:00:13.123456Z", "vod_starts_at": 15, "is_mature": false, "video_url": "https://clips.kick.com/example/playlist.m3u8", "view_count": 42, "likes_count": 0, "vod": { "id": "00000000-0000-4000-8000-000000000001" }, "category": { "id": 15, "name": "Example category", "slug": "example-category", "responsive": "https://example.test/banner", "banner": "https://example.test/banner", "parent_category": "example" }, "creator": { "id": 20, "username": "ExampleCreator", "slug": "examplecreator", "profile_picture": null }, "channel": { "id": 10, "username": "Example", "slug": "example", "profile_picture": "https://example.test/avatar" } }, "requestId": "00000000-0000-4000-8000-000000000099", "sourceUrl": "https://kick.com/example/clips/clip_01JGJHB6CEVFCQRYTVPM8DW892", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_api", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 1, "responseBytes": 1500, "durationMs": 800 } } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } } } } }, "/v1/komi": { "get": { "operationId": "komiProfile", "tags": [ "Komi" ], "summary": "Get a Komi profile", "description": "Pass one public Komi profile URL. Tracking parameters and fragments are removed. Returned URLs are data; their destinations are never fetched.", "servers": [ { "url": "http://localhost:3008", "description": "Local worker; replace for deployment." } ], "security": [ { "komi": [] } ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true, "format": "uri", "description": "HTTPS .komi.io profile URL only. No credentials, ports or paths. Tracking parameters and fragments are removed." }, "description": "Required. An HTTPS .komi.io profile URL. Custom domains and paths are unsupported.", "example": "https://example.komi.io/" } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/komiResponseSchema" }, "example": { "success": true, "status": "success", "requestId": "00000000-0000-4000-8000-000000000001", "fetchedAt": "2026-09-10T00:00:00.000Z", "id": "00000000-0000-4000-8000-000000000002", "username": "example", "avatar": "https://example.test/avatar.png", "bio": "Synthetic creator", "firstName": "Example", "lastName": "Creator", "displayName": "Example Creator", "displayNameImage": null, "instagram": "https://instagram.com/example", "website": null, "links": [ { "id": "link-1", "type": "LINK", "url": "https://example.test/", "title": "Website", "order": 0, "visible": true }, { "id": "product-1", "type": "PRODUCT", "url": "https://example.test/shop", "title": "Studio T-shirt", "price": 44, "currency": "USD", "visible": false }, { "type": "NORMAL", "url": "https://example.test/music", "isVisible": true } ], "sourceUrl": "https://example.komi.io/", "coverage": { "source": "public_api", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 2, "responseBytes": 18000, "durationMs": 750 } } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } } } } }, "/v1/linkme": { "get": { "operationId": "linkmeProfile", "tags": [ "Linkme" ], "summary": "Get a Linkme profile", "description": "Accepts one public Linkme profile URL. The result is nested under profile, matching the reference API. Image paths and linkValue strings are returned as published; no destination is visited.", "servers": [ { "url": "http://localhost:3009", "description": "Local worker; replace for deployment." } ], "security": [ { "linkme": [] } ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true, "format": "uri", "description": "HTTPS link.me/ profile URL only. No credentials, ports or nested paths. www, case, tracking queries and fragments are canonicalized." }, "description": "Required. An HTTPS link.me/ URL. www, case, tracking parameters, and fragments are canonicalized.", "example": "https://link.me/example" } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/linkmeResponseSchema" }, "example": { "success": true, "status": "success", "requestId": "00000000-0000-4000-8000-000000000001", "profile": { "id": "public-id-example", "username": "example", "isPrivate": 0, "firstName": "Example", "lastName": "Creator", "bio": "Synthetic profile", "profileImage": "user-profile/example/avatar.png", "profileVisitCount": "1.2k", "totalFollowers": null, "totalLinks": 2, "infoLinks": [ { "title": "Email", "linkId": 1, "isCustom": false, "links": [ { "webLinkId": 10, "linkValue": "hello@example.test", "isAdult": false } ] } ], "webLinks": [ { "title": "Website", "linkId": 2, "isCustom": true, "links": [ { "webLinkId": 20, "linkValue": "https://example.test/", "isAdult": false } ] } ], "customisedTheme": { "backgroundColor": "#FFFFFF" }, "sectionVisibility": [ { "section": "links", "order": 1, "enabled": 0 } ] }, "sourceUrl": "https://link.me/example", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_page", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 1, "responseBytes": 48000, "durationMs": 450 } } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } } } } }, "/v1/linktree": { "get": { "operationId": "linktreeProfile", "tags": [ "Linktree" ], "summary": "Get a Linktree profile", "description": "Accepts one HTTPS linktr.ee profile URL. Tracking parameters and fragments are removed. Custom domains, duplicate parameters, and cache_max_age are unsupported.", "servers": [ { "url": "http://localhost:3007", "description": "Local worker; replace for deployment." } ], "security": [ { "linktree": [] } ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true, "format": "uri", "description": "An HTTPS linktr.ee URL with a single profile path. No credentials or explicit ports. Query and fragment are stripped." }, "description": "Required. A public HTTPS linktr.ee profile URL.", "example": "https://linktr.ee/example" } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/linktreeResponseSchema" }, "example": { "success": true, "status": "success", "requestId": "00000000-0000-4000-8000-000000000001", "id": 123, "username": "example", "profilePictureUrl": "https://example.test/avatar.png", "description": "Synthetic creator", "verticals": [ "music" ], "linkPlatforms": [ "Instagram" ], "timezone": "America/New_York", "links": [ { "id": 1, "type": "CLASSIC", "title": "Website", "url": "https://example.test/" }, { "id": 2, "type": "PRODUCT", "title": "Merch", "url": "" } ], "socialLinks": [ { "type": "INSTAGRAM", "url": "https://instagram.com/example" } ], "instagram": "https://instagram.com/example", "sourceUrl": "https://linktr.ee/example", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_page", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 1, "responseBytes": 18000, "durationMs": 350 } } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } } } } }, "/v1/pillar": { "get": { "operationId": "pillarProfile", "tags": [ "Pillar" ], "summary": "Get a Pillar page", "description": "Accepts a public Pillar profile URL. Returns profile fields, links, and products at the top level, matching the reference API's data shape. Outbound URLs are returned as data and never visited.", "servers": [ { "url": "http://localhost:3010", "description": "Local worker; replace for deployment." } ], "security": [ { "pillar": [] } ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true, "format": "uri", "description": "HTTPS pillar.io/ profile URL only. No credentials, ports or nested paths. www, case, tracking queries and fragments are canonicalized." }, "description": "Required. An HTTPS pillar.io/ URL. www, case, tracking parameters, and fragments are canonicalized; nested paths and custom domains are unsupported.", "example": "https://pillar.io/example" } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pillarResponseSchema" }, "example": { "success": true, "status": "success", "id": "00000000-0000-4000-8000-000000000001", "first_name": "Example", "last_name": "Creator", "location": "Example City", "email": "hello@example.test", "email_primary": "account@example.test", "instagram": "https://instagram.com/example", "github": "", "links": [ { "id": "00000000-0000-4000-8000-000000000010", "type": "my website", "title": "my website", "url": "https://example.test/", "clicks": 0, "order": null } ], "products": [ { "id": "00000000-0000-4000-8000-000000000020", "title": "Example Product", "price": 19, "url": "https://example.test/product", "name": "Example Product", "description": "A synthetic product listing.", "image": null } ], "requestId": "00000000-0000-4000-8000-000000000099", "sourceUrl": "https://pillar.io/example", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_api", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 4, "responseBytes": 1300000, "durationMs": 1200 } } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "public_client_unavailable", "account_metadata_unavailable", "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "public_client_unavailable", "account_metadata_unavailable", "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "public_client_unavailable", "account_metadata_unavailable", "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "public_client_unavailable", "account_metadata_unavailable", "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "public_client_unavailable", "account_metadata_unavailable", "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "public_client_unavailable", "account_metadata_unavailable", "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "public_client_unavailable", "account_metadata_unavailable", "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "public_client_unavailable", "account_metadata_unavailable", "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } } } } }, "/v1/pinterest/search": { "get": { "operationId": "pinterestSearch", "tags": [ "Pinterest" ], "summary": "Search Pinterest pins", "description": "Discover public pins for a keyword. Retrieves one page with a requested page size of 25; Pinterest controls the actual result count and ranking. Pass cursor to continue. Full records retain available image, destination, board, author, counter and media fields. Trimmed pins contain id, url, description, created_at, pinner and images when supplied.", "servers": [ { "url": "http://localhost:3014", "description": "Local worker; replace for deployment." } ], "security": [ { "pinterest": [] } ], "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 500 }, "description": "Required keyword, 1–500 characters after trimming.", "example": "synthetic recipes" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 16384, "pattern": "^[A-Za-z0-9_~+/=|.*%-]+$" }, "description": "Optional source bookmark returned by the previous response. Reuse with the same query, handle, or board. Null means end of results unless coverage warns pagination_unavailable. Source cursors can expire. Maximum 16,384 characters." }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Optional true or false (default false). True selects the documented compact fields; false preserves the public source record and nested extensions. Missing source fields remain absent." } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pinterestSearchResponseSchema" }, "example": { "success": true, "status": "success", "requestId": "synthetic-pinterest-request", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_resource", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 1, "responseBytes": 1200, "durationMs": 120 }, "pins": [ { "id": "123456789", "type": "pin", "title": "Synthetic recipe", "description": "", "created_at": "Thu, 10 Sep 2026 00:00:00 +0000", "images": { "orig": { "url": "https://i.pinimg.com/synthetic.jpg", "width": 800, "height": 600 } }, "pinner": { "id": "456", "username": "example", "follower_count": 0 }, "board": { "id": "777", "url": "/example/recipes/" }, "videos": null, "sourceExtension": { "unknown": null }, "url": "https://www.pinterest.com/pin/123456789/" } ], "cursor": "synthetic-next-page", "sourceUrl": "https://www.pinterest.com/search/pins/?q=synthetic+recipes" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } } } } }, "/v1/pinterest/pin": { "get": { "operationId": "pinterestPin", "tags": [ "Pinterest" ], "summary": "Get a Pinterest pin", "description": "Read a public pin’s page data without executing page scripts. Full responses expose Pinterest’s camelCase fields at the top level, preserving nested media and author data. imageSpec_orig aliases images_orig when needed. Trimmed fields: entityId, seoAltText, originPinner, pinner, imageSpec_orig, description, shareCount, nativeCreator, createdAt, repinCount and totalReactionCount. Counts are never guessed; missing required pin fields fail explicitly. cache_max_age is unsupported.", "servers": [ { "url": "http://localhost:3014", "description": "Local worker; replace for deployment." } ], "security": [ { "pinterest": [] } ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true }, "description": "Required HTTPS pinterest.com or www.pinterest.com pin URL (/pin//). No credentials, explicit ports, short links, regional domains or encoded path segments. Tracking query parameters and fragments are removed.", "example": "https://www.pinterest.com/pin/123456789/" }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Optional true or false (default false). True selects the documented compact fields; false preserves the public source record and nested extensions. Missing source fields remain absent." } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pinterestPinResponseSchema" }, "example": { "success": true, "status": "success", "requestId": "synthetic-pinterest-request", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_page", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 1, "responseBytes": 1200, "durationMs": 120 }, "entityId": "123456789", "id": "UGluOjEyMzQ1Njc4OQ==", "description": "Synthetic recipe", "seoAltText": "Synthetic illustration", "createdAt": "Thu, 10 Sep 2026 00:00:00 +0000", "pinner": { "entityId": "456", "username": "example", "followerCount": 0 }, "originPinner": null, "nativeCreator": null, "images_orig": { "url": "https://i.pinimg.com/synthetic.jpg", "width": 800, "height": 600 }, "shareCount": 0, "repinCount": 2, "totalReactionCount": 0, "videos": null, "sourceExtension": { "unknown": null }, "imageSpec_orig": { "url": "https://i.pinimg.com/synthetic.jpg", "width": 800, "height": 600 }, "sourceUrl": "https://www.pinterest.com/pin/123456789/" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } } } } }, "/v1/pinterest/user/boards": { "get": { "operationId": "pinterestBoards", "tags": [ "Pinterest" ], "summary": "Get a user’s boards", "description": "List one page of public boards, preserving order, source counts and nested metadata. Requests 25 boards. Cursor input is supported as an extension to the competitor’s documented request contract. Trimmed boards retain id, url, description, follower_count, pin_count, name, image_cover_hd_url and created_at when present. Pinterest does not supply every field for every board; absent timestamps and cover fields are not invented.", "servers": [ { "url": "http://localhost:3014", "description": "Local worker; replace for deployment." } ], "security": [ { "pinterest": [] } ], "parameters": [ { "name": "handle", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_]{1,60}$", "x-runtime-refinement": true }, "description": "Required Pinterest username, 1–60 letters, digits or underscores; normalized to lowercase.", "example": "example" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 16384, "pattern": "^[A-Za-z0-9_~+/=|.*%-]+$" }, "description": "Optional source bookmark returned by the previous response. Reuse with the same query, handle, or board. Null means end of results unless coverage warns pagination_unavailable. Source cursors can expire. Maximum 16,384 characters." }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Optional true or false (default false). True selects the documented compact fields; false preserves the public source record and nested extensions. Missing source fields remain absent." } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pinterestBoardsResponseSchema" }, "example": { "success": true, "status": "success", "requestId": "synthetic-pinterest-request", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_resource", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 1, "responseBytes": 1200, "durationMs": 120 }, "boards": [ { "id": "777", "type": "board", "name": "Synthetic recipes", "description": "", "url": "https://www.pinterest.com/example/recipes/", "owner": { "id": "456", "username": "example" }, "privacy": "public", "pin_count": 2, "follower_count": 0, "image_cover_hd_url": null, "created_at": null, "sourceExtension": { "unknown": null } } ], "cursor": null, "sourceUrl": "https://www.pinterest.com/example/" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } } } } }, "/v1/pinterest/board": { "get": { "operationId": "pinterestBoard", "tags": [ "Pinterest" ], "summary": "Get pins from a board", "description": "Resolve a public board and retrieve one page of its pins, requesting 25 items. Each returned pin’s board ID must match. All board sections are included where Pinterest supplies them. Pass cursor for the next page. Full records preserve source fields; trim=true uses the same compact pin fields as search. Media files and destination links are never downloaded.", "servers": [ { "url": "http://localhost:3014", "description": "Local worker; replace for deployment." } ], "security": [ { "pinterest": [] } ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true }, "description": "Required HTTPS pinterest.com or www.pinterest.com board URL (///). Board slugs currently accept ASCII letters, digits, underscores and hyphens. No credentials, explicit ports, short links, regional domains or encoded path segments. Tracking query parameters and fragments are removed.", "example": "https://www.pinterest.com/example/recipes/" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 16384, "pattern": "^[A-Za-z0-9_~+/=|.*%-]+$" }, "description": "Optional source bookmark returned by the previous response. Reuse with the same query, handle, or board. Null means end of results unless coverage warns pagination_unavailable. Source cursors can expire. Maximum 16,384 characters." }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Optional true or false (default false). True selects the documented compact fields; false preserves the public source record and nested extensions. Missing source fields remain absent." } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pinterestBoardResponseSchema" }, "example": { "success": true, "status": "success", "requestId": "synthetic-pinterest-request", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_resource", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 2, "responseBytes": 1200, "durationMs": 120 }, "pins": [ { "id": "123456789", "type": "pin", "title": "Synthetic recipe", "description": "", "created_at": "Thu, 10 Sep 2026 00:00:00 +0000", "images": { "orig": { "url": "https://i.pinimg.com/synthetic.jpg", "width": 800, "height": 600 } }, "pinner": { "id": "456", "username": "example", "follower_count": 0 }, "board": { "id": "777", "url": "/example/recipes/" }, "videos": null, "sourceExtension": { "unknown": null }, "url": "https://www.pinterest.com/pin/123456789/" } ], "cursor": null, "sourceUrl": "https://www.pinterest.com/example/recipes/" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } } } } } } }, "/v1/search": { "post": { "operationId": "redditSearch", "tags": [ "Reddit" ], "summary": "Search discussions", "description": "RSS keyword discovery with optional subreddit, ranking, time-window, and result bounds. Unknown scores and metrics remain null.", "servers": [ { "url": "http://localhost:3006", "description": "Local worker; replace for deployment." } ], "security": [ { "reddit": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redditSearchRequestSchema" }, "example": { "query": "meal planning", "subreddits": [ "MealPrepSunday" ], "sort": "relevance", "timeWindow": "month", "maxPosts": 10 } } } }, "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redditSearchResponseSchema" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "accounting": { "type": "object", "properties": { "pageLoads": { "type": "integer", "minimum": 0 }, "httpRequests": { "type": "integer", "minimum": 0 }, "proxyBytes": { "type": "integer", "minimum": 0 }, "challengeCount": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "proxySessionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "rssRequests": { "type": "integer", "minimum": 0 } }, "required": [ "pageLoads", "httpRequests", "proxyBytes", "challengeCount", "durationMs", "proxySessionId" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "partial", "challenged", "failed" ] }, "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "title": { "type": "string", "minLength": 1, "maxLength": 1000 }, "permalink": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "url": { "type": "string", "maxLength": 4096, "format": "uri", "x-runtime-refinement": true }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "upvoteRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "flair": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "selftext": { "type": "string", "maxLength": 4000 }, "retrievalStatus": { "type": "string", "enum": [ "success", "partial", "challenged", "failed" ] } }, "required": [ "id", "subreddit", "title", "permalink", "url", "author", "createdAt", "score", "upvoteRatio", "commentCount", "flair", "selftext", "retrievalStatus" ], "additionalProperties": false }, "maxItems": 50 }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "challenge_detected", "breaker_open", "upstream_error", "timeout", "partial_results" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "status", "posts", "failure" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "accounting": { "type": "object", "properties": { "pageLoads": { "type": "integer", "minimum": 0 }, "httpRequests": { "type": "integer", "minimum": 0 }, "proxyBytes": { "type": "integer", "minimum": 0 }, "challengeCount": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "proxySessionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "rssRequests": { "type": "integer", "minimum": 0 } }, "required": [ "pageLoads", "httpRequests", "proxyBytes", "challengeCount", "durationMs", "proxySessionId" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "partial", "challenged", "failed" ] }, "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "title": { "type": "string", "minLength": 1, "maxLength": 1000 }, "permalink": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "url": { "type": "string", "maxLength": 4096, "format": "uri", "x-runtime-refinement": true }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "upvoteRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "flair": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "selftext": { "type": "string", "maxLength": 4000 }, "retrievalStatus": { "type": "string", "enum": [ "success", "partial", "challenged", "failed" ] } }, "required": [ "id", "subreddit", "title", "permalink", "url", "author", "createdAt", "score", "upvoteRatio", "commentCount", "flair", "selftext", "retrievalStatus" ], "additionalProperties": false }, "maxItems": 50 }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "challenge_detected", "breaker_open", "upstream_error", "timeout", "partial_results" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "status", "posts", "failure" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "accounting": { "type": "object", "properties": { "pageLoads": { "type": "integer", "minimum": 0 }, "httpRequests": { "type": "integer", "minimum": 0 }, "proxyBytes": { "type": "integer", "minimum": 0 }, "challengeCount": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "proxySessionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "rssRequests": { "type": "integer", "minimum": 0 } }, "required": [ "pageLoads", "httpRequests", "proxyBytes", "challengeCount", "durationMs", "proxySessionId" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "partial", "challenged", "failed" ] }, "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "title": { "type": "string", "minLength": 1, "maxLength": 1000 }, "permalink": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "url": { "type": "string", "maxLength": 4096, "format": "uri", "x-runtime-refinement": true }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "upvoteRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "flair": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "selftext": { "type": "string", "maxLength": 4000 }, "retrievalStatus": { "type": "string", "enum": [ "success", "partial", "challenged", "failed" ] } }, "required": [ "id", "subreddit", "title", "permalink", "url", "author", "createdAt", "score", "upvoteRatio", "commentCount", "flair", "selftext", "retrievalStatus" ], "additionalProperties": false }, "maxItems": 50 }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "challenge_detected", "breaker_open", "upstream_error", "timeout", "partial_results" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "status", "posts", "failure" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "accounting": { "type": "object", "properties": { "pageLoads": { "type": "integer", "minimum": 0 }, "httpRequests": { "type": "integer", "minimum": 0 }, "proxyBytes": { "type": "integer", "minimum": 0 }, "challengeCount": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "proxySessionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "rssRequests": { "type": "integer", "minimum": 0 } }, "required": [ "pageLoads", "httpRequests", "proxyBytes", "challengeCount", "durationMs", "proxySessionId" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "partial", "challenged", "failed" ] }, "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "title": { "type": "string", "minLength": 1, "maxLength": 1000 }, "permalink": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "url": { "type": "string", "maxLength": 4096, "format": "uri", "x-runtime-refinement": true }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "upvoteRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "flair": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "selftext": { "type": "string", "maxLength": 4000 }, "retrievalStatus": { "type": "string", "enum": [ "success", "partial", "challenged", "failed" ] } }, "required": [ "id", "subreddit", "title", "permalink", "url", "author", "createdAt", "score", "upvoteRatio", "commentCount", "flair", "selftext", "retrievalStatus" ], "additionalProperties": false }, "maxItems": 50 }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "challenge_detected", "breaker_open", "upstream_error", "timeout", "partial_results" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "status", "posts", "failure" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "accounting": { "type": "object", "properties": { "pageLoads": { "type": "integer", "minimum": 0 }, "httpRequests": { "type": "integer", "minimum": 0 }, "proxyBytes": { "type": "integer", "minimum": 0 }, "challengeCount": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "proxySessionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "rssRequests": { "type": "integer", "minimum": 0 } }, "required": [ "pageLoads", "httpRequests", "proxyBytes", "challengeCount", "durationMs", "proxySessionId" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "partial", "challenged", "failed" ] }, "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "title": { "type": "string", "minLength": 1, "maxLength": 1000 }, "permalink": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "url": { "type": "string", "maxLength": 4096, "format": "uri", "x-runtime-refinement": true }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "upvoteRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "flair": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "selftext": { "type": "string", "maxLength": 4000 }, "retrievalStatus": { "type": "string", "enum": [ "success", "partial", "challenged", "failed" ] } }, "required": [ "id", "subreddit", "title", "permalink", "url", "author", "createdAt", "score", "upvoteRatio", "commentCount", "flair", "selftext", "retrievalStatus" ], "additionalProperties": false }, "maxItems": 50 }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "challenge_detected", "breaker_open", "upstream_error", "timeout", "partial_results" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "status", "posts", "failure" ], "additionalProperties": false } } } } } } }, "/v1/threads": { "post": { "operationId": "redditThreads", "tags": [ "Reddit" ], "summary": "Retrieve threads", "description": "Retrieve posts and nested comments from canonical HTTPS www.reddit.com post permalinks. Reaching a cap or leaving unloaded comments returns partial.", "servers": [ { "url": "http://localhost:3006", "description": "Local worker; replace for deployment." } ], "security": [ { "reddit": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redditThreadRequestSchema" }, "example": { "permalinks": [ "https://www.reddit.com/r/example/comments/abc123/topic/" ], "maxCommentsPerThread": 50, "maxDepth": 3 } } } }, "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redditThreadResponseSchema" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "accounting": { "type": "object", "properties": { "pageLoads": { "type": "integer", "minimum": 0 }, "httpRequests": { "type": "integer", "minimum": 0 }, "proxyBytes": { "type": "integer", "minimum": 0 }, "challengeCount": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "proxySessionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "rssRequests": { "type": "integer", "minimum": 0 } }, "required": [ "pageLoads", "httpRequests", "proxyBytes", "challengeCount", "durationMs", "proxySessionId" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "partial", "challenged", "failed" ] }, "threads": { "type": "array", "items": { "type": "object", "properties": { "post": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "title": { "type": "string", "minLength": 1, "maxLength": 1000 }, "permalink": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "url": { "type": "string", "maxLength": 4096, "format": "uri", "x-runtime-refinement": true }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "upvoteRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "flair": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "selftext": { "type": "string", "maxLength": 4000 }, "retrievalStatus": { "type": "string", "enum": [ "success", "partial", "challenged", "failed" ] } }, "required": [ "id", "subreddit", "title", "permalink", "url", "author", "createdAt", "score", "upvoteRatio", "commentCount", "flair", "selftext", "retrievalStatus" ], "additionalProperties": false }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "postId": { "type": "string", "minLength": 1, "maxLength": 128 }, "parentId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "depth": { "type": "integer", "minimum": 0, "maximum": 5 }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "body": { "type": "string", "maxLength": 2000 } }, "required": [ "id", "postId", "parentId", "depth", "author", "createdAt", "score", "body" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "post", "comments" ], "additionalProperties": false }, "maxItems": 10 }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "challenge_detected", "breaker_open", "upstream_error", "timeout", "partial_results" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "status", "threads", "failure" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "accounting": { "type": "object", "properties": { "pageLoads": { "type": "integer", "minimum": 0 }, "httpRequests": { "type": "integer", "minimum": 0 }, "proxyBytes": { "type": "integer", "minimum": 0 }, "challengeCount": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "proxySessionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "rssRequests": { "type": "integer", "minimum": 0 } }, "required": [ "pageLoads", "httpRequests", "proxyBytes", "challengeCount", "durationMs", "proxySessionId" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "partial", "challenged", "failed" ] }, "threads": { "type": "array", "items": { "type": "object", "properties": { "post": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "title": { "type": "string", "minLength": 1, "maxLength": 1000 }, "permalink": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "url": { "type": "string", "maxLength": 4096, "format": "uri", "x-runtime-refinement": true }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "upvoteRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "flair": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "selftext": { "type": "string", "maxLength": 4000 }, "retrievalStatus": { "type": "string", "enum": [ "success", "partial", "challenged", "failed" ] } }, "required": [ "id", "subreddit", "title", "permalink", "url", "author", "createdAt", "score", "upvoteRatio", "commentCount", "flair", "selftext", "retrievalStatus" ], "additionalProperties": false }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "postId": { "type": "string", "minLength": 1, "maxLength": 128 }, "parentId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "depth": { "type": "integer", "minimum": 0, "maximum": 5 }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "body": { "type": "string", "maxLength": 2000 } }, "required": [ "id", "postId", "parentId", "depth", "author", "createdAt", "score", "body" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "post", "comments" ], "additionalProperties": false }, "maxItems": 10 }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "challenge_detected", "breaker_open", "upstream_error", "timeout", "partial_results" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "status", "threads", "failure" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "accounting": { "type": "object", "properties": { "pageLoads": { "type": "integer", "minimum": 0 }, "httpRequests": { "type": "integer", "minimum": 0 }, "proxyBytes": { "type": "integer", "minimum": 0 }, "challengeCount": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "proxySessionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "rssRequests": { "type": "integer", "minimum": 0 } }, "required": [ "pageLoads", "httpRequests", "proxyBytes", "challengeCount", "durationMs", "proxySessionId" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "partial", "challenged", "failed" ] }, "threads": { "type": "array", "items": { "type": "object", "properties": { "post": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "title": { "type": "string", "minLength": 1, "maxLength": 1000 }, "permalink": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "url": { "type": "string", "maxLength": 4096, "format": "uri", "x-runtime-refinement": true }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "upvoteRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "flair": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "selftext": { "type": "string", "maxLength": 4000 }, "retrievalStatus": { "type": "string", "enum": [ "success", "partial", "challenged", "failed" ] } }, "required": [ "id", "subreddit", "title", "permalink", "url", "author", "createdAt", "score", "upvoteRatio", "commentCount", "flair", "selftext", "retrievalStatus" ], "additionalProperties": false }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "postId": { "type": "string", "minLength": 1, "maxLength": 128 }, "parentId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "depth": { "type": "integer", "minimum": 0, "maximum": 5 }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "body": { "type": "string", "maxLength": 2000 } }, "required": [ "id", "postId", "parentId", "depth", "author", "createdAt", "score", "body" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "post", "comments" ], "additionalProperties": false }, "maxItems": 10 }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "challenge_detected", "breaker_open", "upstream_error", "timeout", "partial_results" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "status", "threads", "failure" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "accounting": { "type": "object", "properties": { "pageLoads": { "type": "integer", "minimum": 0 }, "httpRequests": { "type": "integer", "minimum": 0 }, "proxyBytes": { "type": "integer", "minimum": 0 }, "challengeCount": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "proxySessionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "rssRequests": { "type": "integer", "minimum": 0 } }, "required": [ "pageLoads", "httpRequests", "proxyBytes", "challengeCount", "durationMs", "proxySessionId" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "partial", "challenged", "failed" ] }, "threads": { "type": "array", "items": { "type": "object", "properties": { "post": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "title": { "type": "string", "minLength": 1, "maxLength": 1000 }, "permalink": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "url": { "type": "string", "maxLength": 4096, "format": "uri", "x-runtime-refinement": true }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "upvoteRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "flair": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "selftext": { "type": "string", "maxLength": 4000 }, "retrievalStatus": { "type": "string", "enum": [ "success", "partial", "challenged", "failed" ] } }, "required": [ "id", "subreddit", "title", "permalink", "url", "author", "createdAt", "score", "upvoteRatio", "commentCount", "flair", "selftext", "retrievalStatus" ], "additionalProperties": false }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "postId": { "type": "string", "minLength": 1, "maxLength": 128 }, "parentId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "depth": { "type": "integer", "minimum": 0, "maximum": 5 }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "body": { "type": "string", "maxLength": 2000 } }, "required": [ "id", "postId", "parentId", "depth", "author", "createdAt", "score", "body" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "post", "comments" ], "additionalProperties": false }, "maxItems": 10 }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "challenge_detected", "breaker_open", "upstream_error", "timeout", "partial_results" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "status", "threads", "failure" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "accounting": { "type": "object", "properties": { "pageLoads": { "type": "integer", "minimum": 0 }, "httpRequests": { "type": "integer", "minimum": 0 }, "proxyBytes": { "type": "integer", "minimum": 0 }, "challengeCount": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "proxySessionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "rssRequests": { "type": "integer", "minimum": 0 } }, "required": [ "pageLoads", "httpRequests", "proxyBytes", "challengeCount", "durationMs", "proxySessionId" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "partial", "challenged", "failed" ] }, "threads": { "type": "array", "items": { "type": "object", "properties": { "post": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "title": { "type": "string", "minLength": 1, "maxLength": 1000 }, "permalink": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "url": { "type": "string", "maxLength": 4096, "format": "uri", "x-runtime-refinement": true }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "upvoteRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "flair": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "selftext": { "type": "string", "maxLength": 4000 }, "retrievalStatus": { "type": "string", "enum": [ "success", "partial", "challenged", "failed" ] } }, "required": [ "id", "subreddit", "title", "permalink", "url", "author", "createdAt", "score", "upvoteRatio", "commentCount", "flair", "selftext", "retrievalStatus" ], "additionalProperties": false }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "postId": { "type": "string", "minLength": 1, "maxLength": 128 }, "parentId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "depth": { "type": "integer", "minimum": 0, "maximum": 5 }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "body": { "type": "string", "maxLength": 2000 } }, "required": [ "id", "postId", "parentId", "depth", "author", "createdAt", "score", "body" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "post", "comments" ], "additionalProperties": false }, "maxItems": 10 }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "challenge_detected", "breaker_open", "upstream_error", "timeout", "partial_results" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "status", "threads", "failure" ], "additionalProperties": false } } } } } } }, "/v1/reddit/subreddit/details": { "get": { "operationId": "redditDetails", "tags": [ "Reddit" ], "summary": "Subreddit details", "description": "Read community metadata, rendered rules, images, dates and weekly metrics. A matching community search header can fill a missing subscriber count; unavailable required metadata stays null with explicit partial coverage.", "servers": [ { "url": "http://localhost:3006", "description": "Local worker; replace for deployment." } ], "security": [ { "reddit": [] } ], "parameters": [ { "name": "subreddit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "example": "Example" }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "format": "uri" } }, { "name": "cache_max_age", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1d", "3d", "7d", "14d", "30d" ] }, "description": "Accepted only on competitor-documented routes; always fetches live. No retained cache, credit balance or billing fields." } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redditApiResponseSchema" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/reddit/subreddit": { "get": { "operationId": "redditPosts", "tags": [ "Reddit" ], "summary": "Subreddit posts", "description": "Read one rendered page of up to 50 public posts with sort, timeframe, signed after continuation and optional trimmed records.", "servers": [ { "url": "http://localhost:3006", "description": "Local worker; replace for deployment." } ], "security": [ { "reddit": [] } ], "parameters": [ { "name": "subreddit", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "example": "Example" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "best", "hot", "new", "top", "rising" ], "default": "hot" }, "example": "hot" }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "day", "week", "month", "year" ], "default": "all" }, "example": "all" }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 5000, "pattern": "^[A-Za-z0-9_.=-]+$" } }, { "name": "trim", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ], "x-runtime-refinement": true } ], "default": false }, "example": false }, { "name": "cache_max_age", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1d", "3d", "7d", "14d", "30d" ] }, "description": "Accepted only on competitor-documented routes; always fetches live. No retained cache, credit balance or billing fields." } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redditApiResponseSchema" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/reddit/subreddit/search": { "get": { "operationId": "redditSubredditSearch", "tags": [ "Reddit" ], "summary": "Subreddit search", "description": "Read public post, comment and media search sections. One signed cursor tracks each section independently and skips exhausted sections. A section failure retains usable results with explicit partial coverage. Ranking and page sizes can differ from the competitor.", "servers": [ { "url": "http://localhost:3006", "description": "Local worker; replace for deployment." } ], "security": [ { "reddit": [] } ], "parameters": [ { "name": "subreddit", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "example": "Example" }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 500, "default": "" }, "example": "planning" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "hot", "top", "new", "comments" ], "default": "relevance" }, "example": "relevance" }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "year", "month", "week", "day", "hour" ], "default": "all" }, "example": "all" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 50000, "pattern": "^[A-Za-z0-9_.-]+$" } } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redditApiResponseSchema" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/reddit/post": { "get": { "operationId": "redditPost", "tags": [ "Reddit" ], "summary": "Post details", "description": "Read one post and omit comments from the response. Canonical Reddit URLs and bounded same-origin mobile share-link redirects are supported.", "servers": [ { "url": "http://localhost:3006", "description": "Local worker; replace for deployment." } ], "security": [ { "reddit": [] } ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "format": "uri", "maxLength": 2048 }, "example": "https://www.reddit.com/r/Example/comments/abc123/example/" } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redditApiResponseSchema" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/reddit/post/comments": { "get": { "operationId": "redditGetComments", "tags": [ "Reddit" ], "summary": "Post comments (GET)", "description": "Read a post and up to 100 comments with nested replies (depth 8). Truncation is explicit. Pass the returned signed continuation unchanged with the same post URL to retrieve native comment fragments or visible focused replies. Source POST controls retain their hidden form cursor; hidden fallback links are excluded.", "servers": [ { "url": "http://localhost:3006", "description": "Local worker; replace for deployment." } ], "security": [ { "reddit": [] } ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "format": "uri", "maxLength": 2048 }, "example": "https://www.reddit.com/r/Example/comments/abc123/example/" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 50000, "pattern": "^[A-Za-z0-9_.-]+$" } }, { "name": "trim", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ], "x-runtime-refinement": true } ], "default": false }, "example": false } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redditApiResponseSchema" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } } } }, "post": { "operationId": "redditPostComments", "tags": [ "Reddit" ], "summary": "Post comments (POST)", "description": "The same comments operation accepts JSON when a continuation is too large for a URL. Body limit 64 KiB; cursor limit 50,000 characters. Query/body mixing and cursor batching are rejected.", "servers": [ { "url": "http://localhost:3006", "description": "Local worker; replace for deployment." } ], "security": [ { "reddit": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redditCommentsRequestSchema" }, "example": { "url": "https://www.reddit.com/r/Example/comments/abc123/example/", "trim": false } } } }, "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redditApiResponseSchema" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/reddit/post/transcript": { "get": { "operationId": "redditTranscript", "tags": [ "Reddit" ], "summary": "Post transcript", "description": "Read published WebVTT captions by post/share or direct v.redd.it video URL. Preserve raw_vtt and parse rolling captions into plain text. A source without published captions returns transcriptNotAvailable; challenges and failed retrieval remain failures.", "servers": [ { "url": "http://localhost:3006", "description": "Local worker; replace for deployment." } ], "security": [ { "reddit": [] } ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "format": "uri", "maxLength": 2048 }, "example": "https://v.redd.it/video123" }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-z]{2}$", "default": "en" }, "example": "en" }, { "name": "cache_max_age", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1d", "3d", "7d", "14d", "30d" ] }, "description": "Accepted only on competitor-documented routes; always fetches live. No retained cache, credit balance or billing fields." } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redditApiResponseSchema" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/reddit/search": { "get": { "operationId": "redditGlobalSearch", "tags": [ "Reddit" ], "summary": "Global search", "description": "Search public posts or comments with signed after continuation. Comment search supports relevance/new/top and no timeframe. Unknown card fields, including post bodies and comment parent identities, remain null.", "servers": [ { "url": "http://localhost:3006", "description": "Local worker; replace for deployment." } ], "security": [ { "reddit": [] } ], "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 500 }, "example": "planning" }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "posts", "comments" ], "default": "posts" }, "example": "posts" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "new", "top", "comment_count" ], "default": "relevance" }, "example": "relevance" }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "day", "week", "month", "year" ], "default": "all" }, "example": "all" }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 5000, "pattern": "^[A-Za-z0-9_.=-]+$" } }, { "name": "trim", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ], "x-runtime-refinement": true } ], "default": false }, "example": false } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redditApiResponseSchema" } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/twitch/profile": { "get": { "operationId": "twitchProfile", "tags": [ "Twitch" ], "summary": "Get a Twitch profile", "description": "Retrieve profile identity, biography, social links, followers, partner status, current stream, videos, home-page video shelves and similar streamers. Social names become lowercase top-level keys. Deployment-host acceptance is currently blocked by an integrity challenge on social links. The worker returns HTTP 502 / upstream_challenged without a reduced profile.", "servers": [ { "url": "http://localhost:3012", "description": "Local worker; replace for deployment." } ], "security": [ { "twitch": [] } ], "parameters": [ { "name": "handle", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_]{1,25}$", "x-runtime-refinement": true }, "description": "Required Twitch login, 1–25 letters, digits or underscores. Normalized to lowercase.", "example": "example" } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/twitchProfileResponseSchema" }, "example": { "id": "1", "isLive": false, "currentViewersCount": null, "stream": {}, "handle": "example", "displayName": "Example", "profileImageURL": "https://example.test/avatar", "bannerImageURL": null, "description": "Synthetic profile", "followers": 0, "isPartner": false, "allVideos": [ { "id": "3", "animatedPreviewURL": null, "lengthSeconds": 12, "game": { "id": "2", "slug": "example", "name": "Example", "displayName": "Example", "boxArtURL": "https://example.test/game", "__typename": "Game" }, "owner": { "id": "1", "login": "example", "displayName": "Example", "profileImageURL": "https://example.test/avatar", "primaryColorHex": null, "roles": { "isPartner": false, "__typename": "UserRoles" }, "__typename": "User" }, "previewThumbnailURL": "https://example.test/thumb", "publishedAt": "2026-09-10T00:00:00Z", "title": "Synthetic video", "viewCount": 0, "contentTags": [], "resourceRestriction": null, "self": { "isRestricted": false, "viewingHistory": null, "__typename": "VideoSelfEdge" }, "__typename": "Video" } ], "recentBroadcasts": [ { "id": "3", "animatedPreviewURL": null, "lengthSeconds": 12, "game": { "id": "2", "slug": "example", "name": "Example", "displayName": "Example", "boxArtURL": "https://example.test/game", "__typename": "Game" }, "owner": { "id": "1", "login": "example", "displayName": "Example", "profileImageURL": "https://example.test/avatar", "primaryColorHex": null, "roles": { "isPartner": false, "__typename": "UserRoles" }, "__typename": "User" }, "previewThumbnailURL": "https://example.test/thumb", "publishedAt": "2026-09-10T00:00:00Z", "title": "Synthetic video", "viewCount": 0, "contentTags": [], "resourceRestriction": null, "self": { "isRestricted": false, "viewingHistory": null, "__typename": "VideoSelfEdge" }, "__typename": "Video" } ], "featuredClips": [ { "id": "4", "slug": "SyntheticClip", "clipTitle": "Synthetic clip", "clipViewCount": 0, "curator": { "id": "5", "login": "creator", "displayName": "Creator", "__typename": "User" }, "clipGame": { "id": "2", "slug": "example", "name": "Example", "displayName": "Example", "boxArtURL": "https://example.test/game", "__typename": "Game" }, "broadcaster": { "id": "1", "login": "example", "displayName": "Example", "profileImageURL": "https://example.test/avatar", "primaryColorHex": null, "roles": { "isPartner": false, "__typename": "UserRoles" }, "__typename": "User" }, "thumbnailURL": "https://example.test/thumb", "createdAt": "2026-09-10T00:00:00Z", "durationSeconds": 12, "isFeatured": true, "guestStarParticipants": null, "__typename": "Clip" } ], "similarStreamers": [], "youtube": "https://youtube.com/example", "success": true, "status": "success", "requestId": "00000000-0000-4000-8000-000000000099", "sourceUrl": "https://www.twitch.tv/example", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_graphql", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 2, "responseBytes": 4000, "durationMs": 500 } } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } } } } }, "/v1/twitch/user/videos": { "get": { "operationId": "twitchVideos", "tags": [ "Twitch" ], "summary": "Get user videos", "description": "Retrieve the first page of up to 100 videos, with optional type and sort filters. Source hasNextPage and cursor metadata are returned for compatibility; continuation requests are not supported because the logged-out source rejects them with an integrity challenge.", "servers": [ { "url": "http://localhost:3012", "description": "Local worker; replace for deployment." } ], "security": [ { "twitch": [] } ], "parameters": [ { "name": "handle", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_]{1,25}$", "x-runtime-refinement": true }, "description": "Required Twitch login, 1–25 letters, digits or underscores. Normalized to lowercase.", "example": "example" }, { "name": "filter_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "HIGHLIGHT", "ARCHIVE", "UPLOAD" ] }, "description": "Optional HIGHLIGHT, ARCHIVE or UPLOAD. Omit to include all source video types.", "example": "ARCHIVE" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "TIME", "VIEWS" ], "default": "TIME" }, "description": "TIME (default) or VIEWS.", "example": "TIME" } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/twitchVideosResponseSchema" }, "example": { "videos": [ { "id": "3", "animatedPreviewURL": null, "lengthSeconds": 12, "game": { "id": "2", "slug": "example", "name": "Example", "displayName": "Example", "boxArtURL": "https://example.test/game", "__typename": "Game" }, "owner": { "id": "1", "login": "example", "displayName": "Example", "profileImageURL": "https://example.test/avatar", "primaryColorHex": null, "roles": { "isPartner": false, "__typename": "UserRoles" }, "__typename": "User" }, "previewThumbnailURL": "https://example.test/thumb", "publishedAt": "2026-09-10T00:00:00Z", "title": "Synthetic video", "viewCount": 0, "contentTags": [], "broadcastIdentifier": { "id": "6", "__typename": "Broadcast" } } ], "hasNextPage": true, "cursor": "synthetic_cursor", "success": true, "status": "success", "requestId": "00000000-0000-4000-8000-000000000099", "sourceUrl": "https://www.twitch.tv/example/videos", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_graphql", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 2, "responseBytes": 4000, "durationMs": 500 } } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } } } } }, "/v1/twitch/user/schedule": { "get": { "operationId": "twitchSchedule", "tags": [ "Twitch" ], "summary": "Get user schedule", "description": "Retrieve the current calendar week, Monday 00:00 UTC through the next Monday. Includes schedule segments, cancellation metadata, interruption, next segment, current stream and this week’s recent broadcasts.", "servers": [ { "url": "http://localhost:3012", "description": "Local worker; replace for deployment." } ], "security": [ { "twitch": [] } ], "parameters": [ { "name": "handle", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_]{1,25}$", "x-runtime-refinement": true }, "description": "Required Twitch login, 1–25 letters, digits or underscores. Normalized to lowercase.", "example": "example" } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/twitchScheduleResponseSchema" }, "example": { "id": "1", "primaryColorHex": null, "lastBroadcast": { "id": "6", "startedAt": "2026-09-09T00:00:00Z", "__typename": "Broadcast" }, "broadcastSettings": { "id": "1", "title": "Synthetic broadcast", "__typename": "BroadcastSettings" }, "stream": null, "videos": { "edges": [], "__typename": "VideoConnection" }, "channel": { "id": "1", "schedule": { "id": "schedule", "nextSegment": null, "interruption": null, "segments": [], "__typename": "Schedule" }, "__typename": "Channel" }, "__typename": "User", "success": true, "status": "success", "requestId": "00000000-0000-4000-8000-000000000099", "sourceUrl": "https://www.twitch.tv/example/schedule", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_graphql", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 2, "responseBytes": 4000, "durationMs": 500 } } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } } } } }, "/v1/twitch/clip": { "get": { "operationId": "twitchClip", "tags": [ "Twitch" ], "summary": "Get a Twitch clip", "description": "Retrieve the complete public clip and playback metadata. Numeric keys preserve the reference API’s GraphQL batch response: 0 is the clip, 1 related clips, and 2 logged-out viewer data.", "servers": [ { "url": "http://localhost:3012", "description": "Local worker; replace for deployment." } ], "security": [ { "twitch": [] } ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true }, "description": "Required HTTPS clips.twitch.tv/ or twitch.tv//clip/. Tracking queries/fragments are removed; credentials, ports and embedded URLs are rejected.", "example": "https://clips.twitch.tv/SyntheticClip" } ], "responses": { "200": { "description": "Inspect the response status and failure or coverage fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/twitchClipResponseSchema" }, "example": { "0": { "data": { "clip": { "id": "4", "slug": "SyntheticClip", "url": "https://clips.twitch.tv/SyntheticClip", "embedURL": "https://clips.twitch.tv/embed?clip=SyntheticClip", "title": "Synthetic clip", "viewCount": 0, "language": "EN", "isFeatured": true, "assets": [], "curator": { "id": "1", "login": "example", "displayName": "Example", "profileImageURL": "https://example.test/avatar", "primaryColorHex": null, "roles": { "isPartner": false, "__typename": "UserRoles" }, "__typename": "User" }, "game": { "id": "2", "slug": "example", "name": "Example", "displayName": "Example", "boxArtURL": "https://example.test/game", "__typename": "Game" }, "broadcast": { "id": "6", "title": null, "__typename": "Broadcast" }, "broadcaster": { "id": "1", "login": "example", "displayName": "Example", "profileImageURL": "https://example.test/avatar", "primaryColorHex": null, "roles": { "isPartner": false, "__typename": "UserRoles" }, "__typename": "User", "isPartner": false, "followers": { "totalCount": 0, "__typename": "FollowerConnection" }, "stream": null, "lastBroadcast": null, "self": null }, "thumbnailURL": "https://example.test/thumb", "createdAt": "2026-09-10T00:00:00Z", "isPublished": true, "durationSeconds": 12, "champBadge": null, "playbackAccessToken": { "signature": "synthetic-signature", "value": "{\"authorization\": {\"forbidden\": false}, \"expires\": 4102444800, \"clip_slug\": \"SyntheticClip\", \"user_id\": null}", "__typename": "PlaybackAccessToken" }, "video": null, "videoOffsetSeconds": null, "videoQualities": [ { "sourceURL": "https://clips-media-assets2.twitch.tv/example.mp4", "__typename": "ClipVideoQuality" } ], "isViewerEditRestricted": true, "suggestedCropping": null, "__typename": "Clip", "videoURL": "https://clips-media-assets2.twitch.tv/example.mp4?sig=synthetic-signature&token=%7B%22authorization%22%3A%20%7B%22forbidden%22%3A%20false%7D%2C%20%22expires%22%3A%204102444800%2C%20%22clip_slug%22%3A%20%22SyntheticClip%22%2C%20%22user_id%22%3A%20null%7D" } }, "extensions": { "operationName": "ShareClipRenderStatus", "durationMilliseconds": 1, "requestID": "synthetic-upstream" } }, "1": { "data": { "user": { "id": "1", "login": "example", "clips": { "edges": [], "pageInfo": { "hasNextPage": false, "__typename": "PageInfo" }, "__typename": "ClipConnection" }, "__typename": "User" } }, "extensions": { "operationName": "ClipsCards__User", "durationMilliseconds": 1, "requestID": "synthetic-related" } }, "2": { "data": { "user": null }, "extensions": { "operationName": "GetDisplayName", "durationMilliseconds": 1, "requestID": "synthetic-upstream" } }, "success": true, "status": "success", "requestId": "00000000-0000-4000-8000-000000000099", "sourceUrl": "https://clips.twitch.tv/SyntheticClip", "fetchedAt": "2026-09-10T00:00:00.000Z", "coverage": { "source": "public_graphql", "complete": true, "warnings": [] }, "accounting": { "upstreamRequests": 3, "responseBytes": 4000, "durationMs": 500 } } } } }, "400": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "401": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "403": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "404": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "429": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "502": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "503": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } }, "504": { "description": "Request could not complete; inspect error or failure.code.", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } } } } } } } }, "components": { "securitySchemes": { "bluesky": { "type": "apiKey", "in": "header", "name": "x-api-key" }, "kick": { "type": "apiKey", "in": "header", "name": "x-api-key" }, "komi": { "type": "apiKey", "in": "header", "name": "x-api-key" }, "linkme": { "type": "apiKey", "in": "header", "name": "x-api-key" }, "linktree": { "type": "apiKey", "in": "header", "name": "x-api-key" }, "pillar": { "type": "apiKey", "in": "header", "name": "x-api-key" }, "pinterest": { "type": "apiKey", "in": "header", "name": "x-api-key" }, "reddit": { "type": "apiKey", "in": "header", "name": "x-reddit-retrieval-secret" }, "twitch": { "type": "apiKey", "in": "header", "name": "x-api-key" } }, "schemas": { "blueskyPostRequestSchema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 4096, "x-runtime-refinement": true } }, "required": [ "url" ], "additionalProperties": false }, "blueskyPostResponseSchema": { "anyOf": [ { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "const": "public_api" }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": false }, "post": { "type": "object", "properties": { "uri": { "type": "string", "pattern": "^at:\\/\\/did:[^/]+\\/app\\.bsky\\.feed\\.post\\/[^/]+$" }, "cid": { "type": "string", "minLength": 1 }, "author": { "type": "object", "properties": { "did": { "type": "string", "maxLength": 2048, "pattern": "^did:(?:plc:[a-z2-7]{24}|web:[a-zA-Z0-9._:%-]+(?::[a-zA-Z0-9._:%-]+)*)$" }, "handle": { "type": "string", "minLength": 1 } }, "required": [ "did", "handle" ], "additionalProperties": true }, "record": { "type": "object", "properties": { "$type": { "type": "string", "const": "app.bsky.feed.post" }, "text": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "$type", "text", "createdAt" ], "additionalProperties": true }, "replyCount": { "type": "integer", "minimum": 0 }, "repostCount": { "type": "integer", "minimum": 0 }, "likeCount": { "type": "integer", "minimum": 0 }, "quoteCount": { "type": "integer", "minimum": 0 }, "indexedAt": { "type": "string" } }, "required": [ "uri", "cid", "author", "record", "replyCount", "repostCount", "likeCount", "quoteCount", "indexedAt" ], "additionalProperties": true }, "replies": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "maxItems": 100 } }, "required": [ "requestId", "accounting", "success", "status", "sourceUrl", "fetchedAt", "coverage", "post", "replies" ], "additionalProperties": true }, { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } ] }, "blueskyPostsRequestSchema": { "type": "object", "properties": { "handle": { "type": "string", "minLength": 3, "maxLength": 253, "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$" }, "user_id": { "type": "string", "maxLength": 2048, "pattern": "^did:(?:plc:[a-z2-7]{24}|web:[a-zA-Z0-9._:%-]+(?::[a-zA-Z0-9._:%-]+)*)$" }, "cursor": { "type": "string", "minLength": 1, "maxLength": 2048, "x-runtime-refinement": true } }, "required": [], "additionalProperties": false, "x-runtime-refinement": true }, "blueskyPostsResponseSchema": { "anyOf": [ { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "const": "public_api" }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": false }, "feed": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string", "pattern": "^at:\\/\\/did:[^/]+\\/app\\.bsky\\.feed\\.post\\/[^/]+$" }, "cid": { "type": "string", "minLength": 1 }, "author": { "type": "object", "properties": { "did": { "type": "string", "maxLength": 2048, "pattern": "^did:(?:plc:[a-z2-7]{24}|web:[a-zA-Z0-9._:%-]+(?::[a-zA-Z0-9._:%-]+)*)$" }, "handle": { "type": "string", "minLength": 1 } }, "required": [ "did", "handle" ], "additionalProperties": true }, "record": { "type": "object", "properties": { "$type": { "type": "string", "const": "app.bsky.feed.post" }, "text": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "$type", "text", "createdAt" ], "additionalProperties": true }, "replyCount": { "type": "integer", "minimum": 0 }, "repostCount": { "type": "integer", "minimum": 0 }, "likeCount": { "type": "integer", "minimum": 0 }, "quoteCount": { "type": "integer", "minimum": 0 }, "indexedAt": { "type": "string" } }, "required": [ "uri", "cid", "author", "record", "replyCount", "repostCount", "likeCount", "quoteCount", "indexedAt" ], "additionalProperties": true }, "maxItems": 30 }, "cursor": { "type": "string" } }, "required": [ "requestId", "accounting", "success", "status", "sourceUrl", "fetchedAt", "coverage", "feed" ], "additionalProperties": false }, { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } ] }, "blueskyProfileRequestSchema": { "type": "object", "properties": { "handle": { "type": "string", "minLength": 3, "maxLength": 253, "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$" } }, "required": [ "handle" ], "additionalProperties": false }, "blueskyProfileResponseSchema": { "anyOf": [ { "type": "object", "properties": { "did": { "type": "string", "maxLength": 2048, "pattern": "^did:(?:plc:[a-z2-7]{24}|web:[a-zA-Z0-9._:%-]+(?::[a-zA-Z0-9._:%-]+)*)$" }, "handle": { "type": "string", "minLength": 1 }, "displayName": { "type": "string" }, "description": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "followersCount": { "type": "integer", "minimum": 0 }, "followsCount": { "type": "integer", "minimum": 0 }, "postsCount": { "type": "integer", "minimum": 0 }, "labels": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "const": "public_api" }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": false } }, "required": [ "did", "handle", "followersCount", "followsCount", "postsCount", "requestId", "accounting", "success", "status", "sourceUrl", "fetchedAt", "coverage" ], "additionalProperties": true }, { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } ] }, "kickRequestSchema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true, "format": "uri", "description": "HTTPS kick.com//clips/ or legacy kick.com/?clip=. No credentials or ports. Tracking parameters/fragments are removed; ambiguous clip IDs are rejected." } }, "required": [ "url" ], "additionalProperties": false }, "kickResponseSchema": { "anyOf": [ { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "status": { "type": "string", "const": "success" }, "clip": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^clip_[0-9A-HJKMNP-TV-Z]{26}$" }, "livestream_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "channel_id": { "type": "integer", "minimum": 0 }, "user_id": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "title": { "type": "string" }, "clip_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "privacy": { "type": "string", "enum": [ "CLIP_PRIVACY_PUBLIC", "public" ] }, "likes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "liked": { "type": "boolean" }, "views": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "started_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "vod_starts_at": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "is_mature": { "type": "boolean" }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "view_count": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "likes_count": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "vod": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "required": [ "id" ], "additionalProperties": true }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0 }, "name": { "type": "string" }, "slug": { "type": "string" }, "responsive": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "banner": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "parent_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "slug", "responsive", "banner", "parent_category" ], "additionalProperties": true }, { "type": "null" } ] }, "creator": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0 }, "username": { "type": "string" }, "slug": { "type": "string", "minLength": 1 }, "profile_picture": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "username", "slug", "profile_picture" ], "additionalProperties": true }, { "type": "null" } ] }, "channel": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0 }, "username": { "type": "string" }, "slug": { "type": "string", "minLength": 1 }, "profile_picture": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "username", "slug", "profile_picture" ], "additionalProperties": true } }, "required": [ "id", "livestream_id", "category_id", "channel_id", "user_id", "title", "clip_url", "thumbnail_url", "privacy", "likes", "liked", "views", "duration", "started_at", "created_at", "is_mature", "video_url", "view_count", "likes_count", "category", "creator", "channel" ], "additionalProperties": true }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "const": "public_api" }, "complete": { "type": "boolean", "const": true }, "warnings": { "type": "array", "items": { "type": "string" }, "maxItems": 0 } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "clip", "sourceUrl", "fetchedAt", "coverage" ], "additionalProperties": false }, { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } ] }, "komiRequestSchema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true, "format": "uri", "description": "HTTPS .komi.io profile URL only. No credentials, ports or paths. Tracking parameters and fragments are removed." } }, "required": [ "url" ], "additionalProperties": false }, "komiResponseSchema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "username": { "type": "string", "minLength": 1 }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayNameImage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instagram": { "type": "string" }, "tiktok": { "type": "string" }, "youtube": { "type": "string" }, "twitter": { "type": "string" }, "facebook": { "type": "string" }, "snapchat": { "type": "string" }, "spotify": { "type": "string" }, "apple_music": { "type": "string" }, "deezer": { "type": "string" }, "soundcloud": { "type": "string" }, "twitch": { "type": "string" }, "discord": { "type": "string" }, "linkedin": { "type": "string" }, "email": { "type": "string" }, "links": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "type": { "type": "string", "minLength": 1 }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "order": { "type": "number" }, "visible": { "type": "boolean" }, "thumbnail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "moduleId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "versionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "additionalProperties": true }, "maxItems": 500 }, "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "const": "public_api" }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "metadata_unavailable", "social_links_unavailable", "unknown_social_type", "invalid_link", "modules_unavailable", "gated_links_omitted", "link_limit", "depth_limit", "node_limit" ] } }, "moduleFailure": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": false } }, "required": [ "id", "username", "avatar", "bio", "firstName", "lastName", "displayName", "displayNameImage", "website", "links", "requestId", "accounting", "success", "status", "sourceUrl", "fetchedAt", "coverage" ], "additionalProperties": false }, { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } ] }, "linkmeRequestSchema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true, "format": "uri", "description": "HTTPS link.me/ profile URL only. No credentials, ports or nested paths. www, case, tracking queries and fragments are canonicalized." } }, "required": [ "url" ], "additionalProperties": false }, "linkmeResponseSchema": { "anyOf": [ { "type": "object", "properties": { "profile": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "username": { "type": "string", "minLength": 1 }, "isPrivate": { "anyOf": [ { "type": "number", "const": 0 }, { "type": "boolean", "const": false } ] }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verifiedAccount": { "anyOf": [ { "type": "number" }, { "type": "boolean" } ] }, "isAmbassador": { "anyOf": [ { "type": "number" }, { "type": "boolean" } ] }, "friendStatus": { "anyOf": [ { "type": "number" }, { "type": "boolean" } ] }, "profileVisitCount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDefaultProfilePicture": { "type": "boolean" }, "profileImage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profileImageWebp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referralLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deeplink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logo": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoMetaData": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": {}, "required": [], "additionalProperties": true } ] }, { "type": "null" } ] }, "QRCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webTheme": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "linkmeCustomIcon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cover": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeStatus": { "anyOf": [ { "type": "object", "properties": { "tipsEnabled": { "anyOf": [ { "type": "number" }, { "type": "boolean" } ] }, "stripeAccountId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeEnabled": { "type": "boolean" } }, "required": [], "additionalProperties": true }, { "type": "null" } ] }, "killer": { "anyOf": [ { "type": "number" }, { "type": "boolean" } ] }, "hideBottomButtons": { "anyOf": [ { "type": "number" }, { "type": "boolean" } ] }, "customMailForm": { "anyOf": [ { "type": "number" }, { "type": "boolean" } ] }, "hideAddToContacts": { "anyOf": [ { "type": "number" }, { "type": "boolean" } ] }, "subscriptionFeature": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "showForm": { "type": "boolean" }, "subscriptionType": { "anyOf": [ { "type": "number" }, { "type": "boolean" } ] }, "displayNameOption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trackingPixels": { "type": "array", "items": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } }, "isMuteEnable": { "anyOf": [ { "type": "number" }, { "type": "boolean" } ] }, "totalLinks": { "type": "number", "minimum": 0 }, "chatID": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "infoLinks": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "linkId": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "isCustom": { "type": "boolean" }, "links": { "type": "array", "items": { "type": "object", "properties": { "webLinkId": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "linkValue": { "type": "string" }, "linkImage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "faceValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "baseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isCustom": { "type": "boolean" }, "isAdult": { "type": "boolean" }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "profileImage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "webLinkId", "linkValue" ], "additionalProperties": true }, "maxItems": 500 } }, "required": [ "title", "linkId", "links" ], "additionalProperties": true }, "maxItems": 100 }, "businessInfo": { "anyOf": [ { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, { "type": "null" } ] }, "webLinks": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "linkId": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "isCustom": { "type": "boolean" }, "links": { "type": "array", "items": { "type": "object", "properties": { "webLinkId": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "linkValue": { "type": "string" }, "linkImage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "faceValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "baseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isCustom": { "type": "boolean" }, "isAdult": { "type": "boolean" }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "profileImage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "webLinkId", "linkValue" ], "additionalProperties": true }, "maxItems": 500 } }, "required": [ "title", "linkId", "links" ], "additionalProperties": true }, "maxItems": 100 }, "customisedTheme": { "anyOf": [ { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, { "type": "null" } ] }, "totalFollowers": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "sectionSettings": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "sectionVisibility": { "type": "array", "items": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } } }, "required": [ "id", "username", "isPrivate" ], "additionalProperties": true }, "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "const": "public_page" }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "metadata_unavailable", "links_unavailable", "invalid_link", "gated_links_omitted", "link_limit", "group_limit" ] } } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": false } }, "required": [ "profile", "requestId", "accounting", "success", "status", "sourceUrl", "fetchedAt", "coverage" ], "additionalProperties": false }, { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } ] }, "linktreeRequestSchema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true, "format": "uri", "description": "An HTTPS linktr.ee URL with a single profile path. No credentials or explicit ports. Query and fragment are stripped." } }, "required": [ "url" ], "additionalProperties": false }, "linktreeResponseSchema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0 }, "username": { "type": "string", "minLength": 1 }, "profilePictureUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verticals": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "linkPlatforms": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "links": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0 }, "type": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "url": { "type": "string" }, "parentId": { "type": "integer", "minimum": 0 } }, "required": [ "id", "type", "title", "url" ], "additionalProperties": false }, "maxItems": 500 }, "socialLinks": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "url" ], "additionalProperties": false } }, "instagram": { "type": "string" }, "tiktok": { "type": "string" }, "spotify": { "type": "string" }, "youtube": { "type": "string" }, "soundcloud": { "type": "string" }, "apple_music": { "type": "string" }, "email_address": { "type": "string" }, "linkedin": { "type": "string" }, "discord": { "type": "string" }, "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "const": "public_page" }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "metadata_unavailable", "social_links_unavailable", "invalid_link", "unresolved_parent", "invalid_social_link", "gated_links_omitted", "link_limit", "depth_limit" ] } } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": false } }, "required": [ "id", "username", "profilePictureUrl", "description", "verticals", "linkPlatforms", "timezone", "links", "socialLinks", "requestId", "accounting", "success", "status", "sourceUrl", "fetchedAt", "coverage" ], "additionalProperties": false }, { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } ] }, "pillarRequestSchema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true, "format": "uri", "description": "HTTPS pillar.io/ profile URL only. No credentials, ports or nested paths. www, case, tracking queries and fragments are canonicalized." } }, "required": [ "url" ], "additionalProperties": false }, "pillarResponseSchema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email_primary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "links": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "clicks": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "order": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "type", "title", "url", "clicks", "order" ], "additionalProperties": false }, "maxItems": 500 }, "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "title", "price", "url", "name", "description", "image" ], "additionalProperties": false }, "maxItems": 500 }, "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "const": "public_api" }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "metadata_unavailable", "social_links_unavailable", "invalid_social_link", "social_limit", "links_unavailable", "products_unavailable", "invalid_link", "invalid_product", "gated_records_omitted", "record_limit" ] } } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": false } }, "required": [ "id", "first_name", "last_name", "email_primary", "location", "links", "products", "requestId", "accounting", "success", "status", "sourceUrl", "fetchedAt", "coverage" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "public_client_unavailable", "account_metadata_unavailable", "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } ] }, "pinterestBoardRequestSchema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true }, "cursor": { "type": "string", "minLength": 1, "maxLength": 16384, "pattern": "^[A-Za-z0-9_~+/=|.*%-]+$" }, "trim": { "type": "string", "enum": [ "true", "false" ] } }, "required": [ "url" ], "additionalProperties": false }, "pinterestBoardResponseSchema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "requestId": { "type": "string" }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "public_resource", "public_page" ] }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "restricted_records", "malformed_records", "record_limit", "pagination_unavailable", "missing_pin_counts" ] } } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "pins": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^\\d+$" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "images": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "pinner": { "anyOf": [ { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, { "type": "null" } ] } }, "required": [ "id", "description", "images", "pinner" ], "additionalProperties": true }, "maxItems": 100 }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "success", "status", "requestId", "sourceUrl", "fetchedAt", "coverage", "accounting", "pins", "cursor" ], "additionalProperties": true }, { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } ] }, "pinterestBoardsRequestSchema": { "type": "object", "properties": { "handle": { "type": "string", "pattern": "^[a-zA-Z0-9_]{1,60}$", "x-runtime-refinement": true }, "cursor": { "type": "string", "minLength": 1, "maxLength": 16384, "pattern": "^[A-Za-z0-9_~+/=|.*%-]+$" }, "trim": { "type": "string", "enum": [ "true", "false" ] } }, "required": [ "handle" ], "additionalProperties": false }, "pinterestBoardsResponseSchema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "requestId": { "type": "string" }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "public_resource", "public_page" ] }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "restricted_records", "malformed_records", "record_limit", "pagination_unavailable", "missing_pin_counts" ] } } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "boards": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^\\d+$" }, "name": { "type": "string" }, "url": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "url", "description" ], "additionalProperties": true }, "maxItems": 100 }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "success", "status", "requestId", "sourceUrl", "fetchedAt", "coverage", "accounting", "boards", "cursor" ], "additionalProperties": true }, { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } ] }, "pinterestPinRequestSchema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true }, "trim": { "type": "string", "enum": [ "true", "false" ] } }, "required": [ "url" ], "additionalProperties": false }, "pinterestPinResponseSchema": { "anyOf": [ { "type": "object", "properties": { "entityId": { "type": "string", "pattern": "^\\d+$" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pinner": { "anyOf": [ { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, { "type": "null" } ] }, "imageSpec_orig": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "width": { "type": "number", "minimum": 0 }, "height": { "type": "number", "minimum": 0 } }, "required": [ "url" ], "additionalProperties": true }, "createdAt": { "type": "string" }, "repinCount": { "type": "number", "minimum": 0 }, "shareCount": { "type": "number", "minimum": 0 }, "totalReactionCount": { "type": "number", "minimum": 0 }, "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "requestId": { "type": "string" }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "public_resource", "public_page" ] }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "restricted_records", "malformed_records", "record_limit", "pagination_unavailable", "missing_pin_counts" ] } } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true } }, "required": [ "entityId", "description", "pinner", "imageSpec_orig", "createdAt", "repinCount", "success", "status", "requestId", "sourceUrl", "fetchedAt", "coverage", "accounting" ], "additionalProperties": true }, { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } ] }, "pinterestSearchRequestSchema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1, "maxLength": 500 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 16384, "pattern": "^[A-Za-z0-9_~+/=|.*%-]+$" }, "trim": { "type": "string", "enum": [ "true", "false" ] } }, "required": [ "query" ], "additionalProperties": false }, "pinterestSearchResponseSchema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "requestId": { "type": "string" }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "public_resource", "public_page" ] }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "restricted_records", "malformed_records", "record_limit", "pagination_unavailable", "missing_pin_counts" ] } } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "pins": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^\\d+$" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "images": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "pinner": { "anyOf": [ { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, { "type": "null" } ] } }, "required": [ "id", "description", "images", "pinner" ], "additionalProperties": true }, "maxItems": 100 }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "success", "status", "requestId", "sourceUrl", "fetchedAt", "coverage", "accounting", "pins", "cursor" ], "additionalProperties": true }, { "type": "object", "properties": { "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "requestId": { "type": "string" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0, "maximum": 3 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": true }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "payload_too_complex", "busy" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "success", "status", "requestId", "accounting", "failure" ], "additionalProperties": true } ] }, "redditApiResponseSchema": { "anyOf": [ { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] } }, "required": [ "requestId", "coverage", "accounting", "success", "status" ], "additionalProperties": true }, { "type": "object", "properties": { "requestId": { "type": "string" }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "complete", "reasons" ], "additionalProperties": true }, "accounting": { "type": "object", "properties": { "httpRequests": { "type": "number" }, "proxyBytes": { "type": "number" }, "durationMs": { "type": "number" } }, "required": [ "httpRequests", "proxyBytes", "durationMs" ], "additionalProperties": true }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "error": { "type": "string" } }, "required": [ "requestId", "coverage", "accounting", "success", "status", "error" ], "additionalProperties": false } ] }, "redditCommentsRequestSchema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 50000, "pattern": "^[A-Za-z0-9_.-]+$" }, "trim": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ], "x-runtime-refinement": true } ], "default": false } }, "required": [ "url" ], "additionalProperties": false }, "redditDetailsRequestSchema": { "type": "object", "properties": { "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "cache_max_age": { "type": "string", "enum": [ "1d", "3d", "7d", "14d", "30d" ] } }, "required": [], "additionalProperties": false, "x-runtime-refinement": true }, "redditGlobalSearchRequestSchema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1, "maxLength": 500 }, "filter": { "type": "string", "enum": [ "posts", "comments" ], "default": "posts" }, "sort": { "type": "string", "enum": [ "relevance", "new", "top", "comment_count" ], "default": "relevance" }, "timeframe": { "type": "string", "enum": [ "all", "day", "week", "month", "year" ], "default": "all" }, "after": { "type": "string", "maxLength": 5000, "pattern": "^[A-Za-z0-9_.=-]+$" }, "trim": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ], "x-runtime-refinement": true } ], "default": false } }, "required": [ "query" ], "additionalProperties": false, "x-runtime-refinement": true }, "redditPostRequestSchema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2048 } }, "required": [ "url" ], "additionalProperties": false }, "redditPostsRequestSchema": { "type": "object", "properties": { "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "sort": { "type": "string", "enum": [ "best", "hot", "new", "top", "rising" ], "default": "hot" }, "timeframe": { "type": "string", "enum": [ "all", "day", "week", "month", "year" ], "default": "all" }, "after": { "type": "string", "maxLength": 5000, "pattern": "^[A-Za-z0-9_.=-]+$" }, "trim": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ], "x-runtime-refinement": true } ], "default": false }, "cache_max_age": { "type": "string", "enum": [ "1d", "3d", "7d", "14d", "30d" ] } }, "required": [ "subreddit" ], "additionalProperties": false }, "redditSearchRequestSchema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1, "maxLength": 200 }, "subreddits": { "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "maxItems": 5, "default": [] }, "sort": { "type": "string", "enum": [ "top", "new", "relevance" ], "default": "relevance" }, "timeWindow": { "type": "string", "enum": [ "day", "week", "month", "year" ], "default": "month" }, "maxPosts": { "type": "integer", "minimum": 1, "maximum": 50, "default": 25 } }, "required": [ "query" ], "additionalProperties": false }, "redditSearchResponseSchema": { "anyOf": [ { "type": "object", "properties": { "requestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "accounting": { "type": "object", "properties": { "pageLoads": { "type": "integer", "minimum": 0 }, "httpRequests": { "type": "integer", "minimum": 0 }, "proxyBytes": { "type": "integer", "minimum": 0 }, "challengeCount": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "proxySessionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "rssRequests": { "type": "integer", "minimum": 0 } }, "required": [ "pageLoads", "httpRequests", "proxyBytes", "challengeCount", "durationMs", "proxySessionId" ], "additionalProperties": false }, "status": { "type": "string", "const": "success" }, "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "title": { "type": "string", "minLength": 1, "maxLength": 1000 }, "permalink": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "url": { "type": "string", "maxLength": 4096, "format": "uri", "x-runtime-refinement": true }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "upvoteRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "flair": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "selftext": { "type": "string", "maxLength": 4000 }, "retrievalStatus": { "type": "string", "enum": [ "success", "partial", "challenged", "failed" ] } }, "required": [ "id", "subreddit", "title", "permalink", "url", "author", "createdAt", "score", "upvoteRatio", "commentCount", "flair", "selftext", "retrievalStatus" ], "additionalProperties": false }, "maxItems": 50 } }, "required": [ "requestId", "accounting", "status", "posts" ], "additionalProperties": false }, { "type": "object", "properties": { "requestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "accounting": { "type": "object", "properties": { "pageLoads": { "type": "integer", "minimum": 0 }, "httpRequests": { "type": "integer", "minimum": 0 }, "proxyBytes": { "type": "integer", "minimum": 0 }, "challengeCount": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "proxySessionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "rssRequests": { "type": "integer", "minimum": 0 } }, "required": [ "pageLoads", "httpRequests", "proxyBytes", "challengeCount", "durationMs", "proxySessionId" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "partial", "challenged", "failed" ] }, "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "title": { "type": "string", "minLength": 1, "maxLength": 1000 }, "permalink": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "url": { "type": "string", "maxLength": 4096, "format": "uri", "x-runtime-refinement": true }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "upvoteRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "flair": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "selftext": { "type": "string", "maxLength": 4000 }, "retrievalStatus": { "type": "string", "enum": [ "success", "partial", "challenged", "failed" ] } }, "required": [ "id", "subreddit", "title", "permalink", "url", "author", "createdAt", "score", "upvoteRatio", "commentCount", "flair", "selftext", "retrievalStatus" ], "additionalProperties": false }, "maxItems": 50 }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "challenge_detected", "breaker_open", "upstream_error", "timeout", "partial_results" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "status", "posts", "failure" ], "additionalProperties": false } ] }, "redditSubredditSearchRequestSchema": { "type": "object", "properties": { "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "query": { "type": "string", "maxLength": 500, "default": "" }, "sort": { "type": "string", "enum": [ "relevance", "hot", "top", "new", "comments" ], "default": "relevance" }, "timeframe": { "type": "string", "enum": [ "all", "year", "month", "week", "day", "hour" ], "default": "all" }, "cursor": { "type": "string", "minLength": 1, "maxLength": 50000, "pattern": "^[A-Za-z0-9_.-]+$" } }, "required": [ "subreddit" ], "additionalProperties": false }, "redditThreadRequestSchema": { "type": "object", "properties": { "permalinks": { "type": "array", "items": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "minItems": 1, "maxItems": 10 }, "maxCommentsPerThread": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "maxDepth": { "type": "integer", "minimum": 1, "maximum": 5, "default": 5 } }, "required": [ "permalinks" ], "additionalProperties": false }, "redditThreadResponseSchema": { "anyOf": [ { "type": "object", "properties": { "requestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "accounting": { "type": "object", "properties": { "pageLoads": { "type": "integer", "minimum": 0 }, "httpRequests": { "type": "integer", "minimum": 0 }, "proxyBytes": { "type": "integer", "minimum": 0 }, "challengeCount": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "proxySessionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "rssRequests": { "type": "integer", "minimum": 0 } }, "required": [ "pageLoads", "httpRequests", "proxyBytes", "challengeCount", "durationMs", "proxySessionId" ], "additionalProperties": false }, "status": { "type": "string", "const": "success" }, "threads": { "type": "array", "items": { "type": "object", "properties": { "post": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "title": { "type": "string", "minLength": 1, "maxLength": 1000 }, "permalink": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "url": { "type": "string", "maxLength": 4096, "format": "uri", "x-runtime-refinement": true }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "upvoteRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "flair": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "selftext": { "type": "string", "maxLength": 4000 }, "retrievalStatus": { "type": "string", "enum": [ "success", "partial", "challenged", "failed" ] } }, "required": [ "id", "subreddit", "title", "permalink", "url", "author", "createdAt", "score", "upvoteRatio", "commentCount", "flair", "selftext", "retrievalStatus" ], "additionalProperties": false }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "postId": { "type": "string", "minLength": 1, "maxLength": 128 }, "parentId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "depth": { "type": "integer", "minimum": 0, "maximum": 5 }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "body": { "type": "string", "maxLength": 2000 } }, "required": [ "id", "postId", "parentId", "depth", "author", "createdAt", "score", "body" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "post", "comments" ], "additionalProperties": false }, "maxItems": 10 } }, "required": [ "requestId", "accounting", "status", "threads" ], "additionalProperties": false }, { "type": "object", "properties": { "requestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "accounting": { "type": "object", "properties": { "pageLoads": { "type": "integer", "minimum": 0 }, "httpRequests": { "type": "integer", "minimum": 0 }, "proxyBytes": { "type": "integer", "minimum": 0 }, "challengeCount": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "proxySessionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "rssRequests": { "type": "integer", "minimum": 0 } }, "required": [ "pageLoads", "httpRequests", "proxyBytes", "challengeCount", "durationMs", "proxySessionId" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "partial", "challenged", "failed" ] }, "threads": { "type": "array", "items": { "type": "object", "properties": { "post": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "subreddit": { "type": "string", "pattern": "^[A-Za-z0-9_]{2,21}$" }, "title": { "type": "string", "minLength": 1, "maxLength": 1000 }, "permalink": { "type": "string", "maxLength": 2048, "format": "uri", "x-runtime-refinement": true }, "url": { "type": "string", "maxLength": 4096, "format": "uri", "x-runtime-refinement": true }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "upvoteRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "flair": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "selftext": { "type": "string", "maxLength": 4000 }, "retrievalStatus": { "type": "string", "enum": [ "success", "partial", "challenged", "failed" ] } }, "required": [ "id", "subreddit", "title", "permalink", "url", "author", "createdAt", "score", "upvoteRatio", "commentCount", "flair", "selftext", "retrievalStatus" ], "additionalProperties": false }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "postId": { "type": "string", "minLength": 1, "maxLength": 128 }, "parentId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "depth": { "type": "integer", "minimum": 0, "maximum": 5 }, "author": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "body": { "type": "string", "maxLength": 2000 } }, "required": [ "id", "postId", "parentId", "depth", "author", "createdAt", "score", "body" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "post", "comments" ], "additionalProperties": false }, "maxItems": 10 }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "challenge_detected", "breaker_open", "upstream_error", "timeout", "partial_results" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "status", "threads", "failure" ], "additionalProperties": false } ] }, "redditTranscriptRequestSchema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "language": { "type": "string", "pattern": "^[a-z]{2}$", "default": "en" }, "cache_max_age": { "type": "string", "enum": [ "1d", "3d", "7d", "14d", "30d" ] } }, "required": [ "url" ], "additionalProperties": false }, "twitchClipRequestSchema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048, "x-runtime-refinement": true } }, "required": [ "url" ], "additionalProperties": false }, "twitchClipResponseSchema": { "anyOf": [ { "type": "object", "properties": { "0": { "type": "object", "properties": { "data": { "type": "object", "properties": { "clip": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "slug": { "type": "string" }, "url": { "type": "string" }, "embedURL": { "type": "string" }, "title": { "type": "string" }, "viewCount": { "type": "integer", "minimum": 0 }, "language": { "type": "string" }, "isFeatured": { "type": "boolean" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "aspectRatio": { "type": "number" }, "type": { "type": "string" }, "createdAt": { "type": "string" }, "creationState": { "type": "string" }, "curator": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "login": { "type": "string" }, "displayName": { "type": "string" }, "__typename": { "type": "string" }, "profileImageURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "login", "displayName", "__typename", "profileImageURL" ], "additionalProperties": true }, "thumbnailURL": { "type": "string" }, "videoQualities": { "type": "array", "items": { "type": "object", "properties": { "sourceURL": { "type": "string" }, "__typename": { "type": "string" }, "frameRate": { "type": "number" }, "quality": { "type": "string" } }, "required": [ "sourceURL", "__typename", "frameRate", "quality" ], "additionalProperties": true }, "maxItems": 20 }, "portraitMetadata": { "x-runtime-refinement": true }, "__typename": { "type": "string" } }, "required": [ "id", "aspectRatio", "type", "createdAt", "creationState", "curator", "thumbnailURL", "videoQualities", "portraitMetadata", "__typename" ], "additionalProperties": true }, "maxItems": 20 }, "curator": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "login": { "type": "string" }, "displayName": { "type": "string" }, "__typename": { "type": "string" }, "profileImageURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "login", "displayName", "__typename", "profileImageURL" ], "additionalProperties": true }, { "type": "null" } ] }, "game": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "slug": { "type": "string" }, "name": { "type": "string" }, "__typename": { "type": "string" }, "displayName": { "type": "string" }, "boxArtURL": { "type": "string" } }, "required": [ "id", "slug", "name", "__typename", "displayName", "boxArtURL" ], "additionalProperties": true }, { "type": "null" } ] }, "broadcast": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "__typename": { "type": "string" } }, "required": [ "id", "title", "__typename" ], "additionalProperties": true }, { "type": "null" } ] }, "broadcaster": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "login": { "type": "string" }, "displayName": { "type": "string" }, "__typename": { "type": "string" }, "profileImageURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primaryColorHex": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isPartner": { "type": "boolean" }, "followers": { "type": "object", "properties": { "totalCount": { "type": "integer", "minimum": 0 }, "__typename": { "type": "string" } }, "required": [ "totalCount", "__typename" ], "additionalProperties": true }, "stream": { "x-runtime-refinement": true }, "lastBroadcast": { "x-runtime-refinement": true }, "self": { "x-runtime-refinement": true } }, "required": [ "id", "login", "displayName", "__typename", "profileImageURL", "primaryColorHex", "isPartner", "followers", "stream", "lastBroadcast", "self" ], "additionalProperties": true }, "thumbnailURL": { "type": "string" }, "createdAt": { "type": "string" }, "isPublished": { "type": "boolean" }, "durationSeconds": { "type": "number", "minimum": 0 }, "champBadge": { "x-runtime-refinement": true }, "playbackAccessToken": { "type": "object", "properties": { "signature": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 }, "__typename": { "type": "string" } }, "required": [ "signature", "value", "__typename" ], "additionalProperties": true }, "video": { "x-runtime-refinement": true }, "videoOffsetSeconds": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "videoQualities": { "type": "array", "items": { "type": "object", "properties": { "sourceURL": { "type": "string" }, "__typename": { "type": "string" } }, "required": [ "sourceURL", "__typename" ], "additionalProperties": true }, "minItems": 1, "maxItems": 20 }, "isViewerEditRestricted": { "type": "boolean" }, "suggestedCropping": { "x-runtime-refinement": true }, "__typename": { "type": "string" }, "videoURL": { "type": "string", "format": "uri" } }, "required": [ "id", "slug", "url", "embedURL", "title", "viewCount", "language", "isFeatured", "assets", "curator", "game", "broadcast", "broadcaster", "thumbnailURL", "createdAt", "isPublished", "durationSeconds", "champBadge", "playbackAccessToken", "video", "videoOffsetSeconds", "videoQualities", "isViewerEditRestricted", "suggestedCropping", "__typename", "videoURL" ], "additionalProperties": true } }, "required": [ "clip" ], "additionalProperties": true }, "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": true }, "maxItems": 100 }, "extensions": { "type": "object", "properties": { "operationName": { "type": "string" }, "durationMilliseconds": { "type": "number" }, "requestID": { "type": "string" } }, "required": [], "additionalProperties": true } }, "required": [ "data" ], "additionalProperties": true }, "1": { "type": "object", "properties": { "data": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": true }, "maxItems": 100 }, "extensions": { "type": "object", "properties": { "operationName": { "type": "string" }, "durationMilliseconds": { "type": "number" }, "requestID": { "type": "string" } }, "required": [], "additionalProperties": true } }, "required": [], "additionalProperties": true }, "2": { "type": "object", "properties": { "data": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": true }, "maxItems": 100 }, "extensions": { "type": "object", "properties": { "operationName": { "type": "string" }, "durationMilliseconds": { "type": "number" }, "requestID": { "type": "string" } }, "required": [], "additionalProperties": true } }, "required": [], "additionalProperties": true }, "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "const": "public_graphql" }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "auxiliary_graphql_error" ] }, "maxItems": 2 } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": false } }, "required": [ "0", "1", "2", "requestId", "accounting", "success", "status", "sourceUrl", "fetchedAt", "coverage" ], "additionalProperties": false }, { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } ] }, "twitchProfileRequestSchema": { "type": "object", "properties": { "handle": { "type": "string", "pattern": "^[a-zA-Z0-9_]{1,25}$", "x-runtime-refinement": true } }, "required": [ "handle" ], "additionalProperties": false }, "twitchProfileResponseSchema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "isLive": { "type": "boolean" }, "currentViewersCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "stream": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "handle": { "type": "string" }, "displayName": { "type": "string" }, "profileImageURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bannerImageURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followers": { "type": "integer", "minimum": 0 }, "isPartner": { "type": "boolean" }, "allVideos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "animatedPreviewURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lengthSeconds": { "type": "integer", "minimum": 0 }, "game": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "slug": { "type": "string" }, "name": { "type": "string" }, "__typename": { "type": "string" }, "displayName": { "type": "string" }, "boxArtURL": { "type": "string" } }, "required": [ "id", "slug", "name", "__typename", "displayName", "boxArtURL" ], "additionalProperties": true }, { "type": "null" } ] }, "owner": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "login": { "type": "string" }, "displayName": { "type": "string" }, "__typename": { "type": "string" }, "profileImageURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primaryColorHex": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "roles": { "type": "object", "properties": { "isPartner": { "type": "boolean" }, "__typename": { "type": "string" } }, "required": [ "isPartner", "__typename" ], "additionalProperties": true } }, "required": [ "id", "login", "displayName", "__typename", "profileImageURL", "primaryColorHex", "roles" ], "additionalProperties": true }, "previewThumbnailURL": { "type": "string" }, "publishedAt": { "type": "string" }, "title": { "type": "string" }, "viewCount": { "type": "integer", "minimum": 0 }, "contentTags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "isLanguageTag": { "type": "boolean" }, "tagName": { "type": "string" }, "localizedName": { "type": "string" }, "__typename": { "type": "string" } }, "required": [ "id", "isLanguageTag", "tagName", "localizedName", "__typename" ], "additionalProperties": true }, "maxItems": 100 }, "resourceRestriction": { "x-runtime-refinement": true }, "self": { "type": "object", "properties": { "isRestricted": { "type": "boolean" }, "viewingHistory": { "x-runtime-refinement": true }, "__typename": { "type": "string" } }, "required": [ "isRestricted", "viewingHistory", "__typename" ], "additionalProperties": true }, "__typename": { "type": "string" } }, "required": [ "id", "animatedPreviewURL", "lengthSeconds", "game", "owner", "previewThumbnailURL", "publishedAt", "title", "viewCount", "contentTags", "resourceRestriction", "self", "__typename" ], "additionalProperties": true }, "maxItems": 12 }, "recentBroadcasts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "animatedPreviewURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lengthSeconds": { "type": "integer", "minimum": 0 }, "game": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "slug": { "type": "string" }, "name": { "type": "string" }, "__typename": { "type": "string" }, "displayName": { "type": "string" }, "boxArtURL": { "type": "string" } }, "required": [ "id", "slug", "name", "__typename", "displayName", "boxArtURL" ], "additionalProperties": true }, { "type": "null" } ] }, "owner": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "login": { "type": "string" }, "displayName": { "type": "string" }, "__typename": { "type": "string" }, "profileImageURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primaryColorHex": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "login", "displayName", "__typename", "profileImageURL", "primaryColorHex" ], "additionalProperties": true }, "previewThumbnailURL": { "type": "string" }, "publishedAt": { "type": "string" }, "title": { "type": "string" }, "viewCount": { "type": "integer", "minimum": 0 }, "contentTags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "isLanguageTag": { "type": "boolean" }, "tagName": { "type": "string" }, "localizedName": { "type": "string" }, "__typename": { "type": "string" } }, "required": [ "id", "isLanguageTag", "tagName", "localizedName", "__typename" ], "additionalProperties": true }, "maxItems": 100 }, "resourceRestriction": { "x-runtime-refinement": true }, "self": { "type": "object", "properties": { "isRestricted": { "type": "boolean" }, "viewingHistory": { "x-runtime-refinement": true }, "__typename": { "type": "string" } }, "required": [ "isRestricted", "viewingHistory", "__typename" ], "additionalProperties": true }, "__typename": { "type": "string" } }, "required": [ "id", "animatedPreviewURL", "lengthSeconds", "game", "owner", "previewThumbnailURL", "publishedAt", "title", "viewCount", "contentTags", "resourceRestriction", "self", "__typename" ], "additionalProperties": true }, "maxItems": 100 }, "featuredClips": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "slug": { "type": "string" }, "clipTitle": { "type": "string" }, "clipViewCount": { "type": "integer", "minimum": 0 }, "curator": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "login": { "type": "string" }, "displayName": { "type": "string" }, "__typename": { "type": "string" } }, "required": [ "id", "login", "displayName", "__typename" ], "additionalProperties": true }, { "type": "null" } ] }, "clipGame": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "slug": { "type": "string" }, "name": { "type": "string" }, "__typename": { "type": "string" }, "displayName": { "type": "string" }, "boxArtURL": { "type": "string" } }, "required": [ "id", "slug", "name", "__typename", "displayName", "boxArtURL" ], "additionalProperties": true }, { "type": "null" } ] }, "broadcaster": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "login": { "type": "string" }, "displayName": { "type": "string" }, "__typename": { "type": "string" }, "profileImageURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primaryColorHex": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "roles": { "type": "object", "properties": { "isPartner": { "type": "boolean" }, "__typename": { "type": "string" } }, "required": [ "isPartner", "__typename" ], "additionalProperties": true } }, "required": [ "id", "login", "displayName", "__typename", "profileImageURL", "primaryColorHex", "roles" ], "additionalProperties": true }, "thumbnailURL": { "type": "string" }, "createdAt": { "type": "string" }, "durationSeconds": { "type": "number", "minimum": 0 }, "isFeatured": { "type": "boolean" }, "guestStarParticipants": { "x-runtime-refinement": true }, "__typename": { "type": "string" } }, "required": [ "id", "slug", "clipTitle", "clipViewCount", "curator", "clipGame", "broadcaster", "thumbnailURL", "createdAt", "durationSeconds", "isFeatured", "guestStarParticipants", "__typename" ], "additionalProperties": true }, "maxItems": 100 }, "similarStreamers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "login": { "type": "string" }, "displayName": { "type": "string" }, "__typename": { "type": "string" }, "profileImageURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primaryColorHex": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stream": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "viewersCount": { "type": "integer", "minimum": 0 }, "__typename": { "type": "string" } }, "required": [ "id", "viewersCount", "__typename" ], "additionalProperties": true }, { "type": "null" } ] } }, "required": [ "id", "login", "displayName", "__typename", "profileImageURL", "primaryColorHex", "stream" ], "additionalProperties": true }, "maxItems": 15 }, "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "const": "public_graphql" }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "auxiliary_graphql_error" ] }, "maxItems": 2 } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": false } }, "required": [ "id", "isLive", "currentViewersCount", "stream", "handle", "displayName", "profileImageURL", "bannerImageURL", "description", "followers", "isPartner", "allVideos", "similarStreamers", "requestId", "accounting", "success", "status", "sourceUrl", "fetchedAt", "coverage" ], "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } ] }, "twitchScheduleRequestSchema": { "type": "object", "properties": { "handle": { "type": "string", "pattern": "^[a-zA-Z0-9_]{1,25}$", "x-runtime-refinement": true } }, "required": [ "handle" ], "additionalProperties": false }, "twitchScheduleResponseSchema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "primaryColorHex": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastBroadcast": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "startedAt": { "type": "string" }, "__typename": { "type": "string" } }, "required": [ "id", "startedAt", "__typename" ], "additionalProperties": true }, { "type": "null" } ] }, "broadcastSettings": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "__typename": { "type": "string" } }, "required": [ "id", "title", "__typename" ], "additionalProperties": true }, "stream": { "x-runtime-refinement": true }, "videos": { "type": "object", "properties": { "edges": { "type": "array", "items": { "type": "object", "properties": { "node": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "createdAt": { "type": "string" }, "lengthSeconds": { "type": "integer", "minimum": 0 }, "viewCount": { "type": "integer", "minimum": 0 }, "previewThumbnailURL": { "type": "string" }, "game": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "slug": { "type": "string" }, "name": { "type": "string" }, "__typename": { "type": "string" } }, "required": [ "id", "slug", "name", "__typename" ], "additionalProperties": true }, { "type": "null" } ] }, "__typename": { "type": "string" } }, "required": [ "id", "title", "createdAt", "lengthSeconds", "viewCount", "previewThumbnailURL", "game", "__typename" ], "additionalProperties": true } }, "required": [ "node" ], "additionalProperties": true }, "maxItems": 30 } }, "required": [ "edges" ], "additionalProperties": true }, "channel": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "schedule": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "nextSegment": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "startAt": { "type": "string" }, "__typename": { "type": "string" } }, "required": [ "id", "startAt", "__typename" ], "additionalProperties": true }, { "type": "null" } ] }, "interruption": { "x-runtime-refinement": true }, "segments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "baseSegmentID": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "startAt": { "type": "string" }, "endAt": { "type": "string" }, "isCancelled": { "type": "boolean" }, "cancelledUntil": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hasReminder": { "type": "boolean" }, "repeatEndsAfterCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "slug": { "type": "string" }, "name": { "type": "string" }, "__typename": { "type": "string" } }, "required": [ "id", "slug", "name", "__typename" ], "additionalProperties": true }, "maxItems": 100 }, "__typename": { "type": "string" } }, "required": [ "id", "baseSegmentID", "title", "startAt", "endAt", "isCancelled", "cancelledUntil", "hasReminder", "repeatEndsAfterCount", "categories", "__typename" ], "additionalProperties": true }, "maxItems": 100 }, "__typename": { "type": "string" } }, "required": [ "id", "nextSegment", "interruption", "segments", "__typename" ], "additionalProperties": true }, { "type": "null" } ] }, "__typename": { "type": "string" } }, "required": [ "id", "schedule", "__typename" ], "additionalProperties": true }, "__typename": { "type": "string" }, "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "const": "public_graphql" }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "auxiliary_graphql_error" ] }, "maxItems": 2 } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": false } }, "required": [ "id", "primaryColorHex", "lastBroadcast", "broadcastSettings", "stream", "videos", "channel", "__typename", "requestId", "accounting", "success", "status", "sourceUrl", "fetchedAt", "coverage" ], "additionalProperties": true }, { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } ] }, "twitchVideosRequestSchema": { "type": "object", "properties": { "handle": { "type": "string", "pattern": "^[a-zA-Z0-9_]{1,25}$", "x-runtime-refinement": true }, "filter_by": { "type": "string", "enum": [ "HIGHLIGHT", "ARCHIVE", "UPLOAD" ] }, "sort_by": { "type": "string", "enum": [ "TIME", "VIEWS" ], "default": "TIME" } }, "required": [ "handle" ], "additionalProperties": false }, "twitchVideosResponseSchema": { "anyOf": [ { "type": "object", "properties": { "videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "animatedPreviewURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lengthSeconds": { "type": "integer", "minimum": 0 }, "game": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "slug": { "type": "string" }, "name": { "type": "string" }, "__typename": { "type": "string" }, "displayName": { "type": "string" }, "boxArtURL": { "type": "string" } }, "required": [ "id", "slug", "name", "__typename", "displayName", "boxArtURL" ], "additionalProperties": true }, { "type": "null" } ] }, "owner": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "login": { "type": "string" }, "displayName": { "type": "string" }, "__typename": { "type": "string" }, "profileImageURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primaryColorHex": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "roles": { "type": "object", "properties": { "isPartner": { "type": "boolean" }, "__typename": { "type": "string" } }, "required": [ "isPartner", "__typename" ], "additionalProperties": true } }, "required": [ "id", "login", "displayName", "__typename", "profileImageURL", "primaryColorHex", "roles" ], "additionalProperties": true }, "previewThumbnailURL": { "type": "string" }, "publishedAt": { "type": "string" }, "title": { "type": "string" }, "viewCount": { "type": "integer", "minimum": 0 }, "contentTags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "isLanguageTag": { "type": "boolean" }, "tagName": { "type": "string" }, "localizedName": { "type": "string" }, "__typename": { "type": "string" } }, "required": [ "id", "isLanguageTag", "tagName", "localizedName", "__typename" ], "additionalProperties": true }, "maxItems": 100 }, "broadcastIdentifier": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "__typename": { "type": "string" } }, "required": [ "id", "__typename" ], "additionalProperties": true }, { "type": "null" } ] } }, "required": [ "id", "animatedPreviewURL", "lengthSeconds", "game", "owner", "previewThumbnailURL", "publishedAt", "title", "viewCount", "contentTags", "broadcastIdentifier" ], "additionalProperties": true }, "maxItems": 100 }, "hasNextPage": { "type": "boolean" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "success", "partial" ] }, "sourceUrl": { "type": "string", "format": "uri" }, "fetchedAt": { "type": "string", "format": "date-time" }, "coverage": { "type": "object", "properties": { "source": { "type": "string", "const": "public_graphql" }, "complete": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "auxiliary_graphql_error" ] }, "maxItems": 2 } }, "required": [ "source", "complete", "warnings" ], "additionalProperties": false } }, "required": [ "videos", "hasNextPage", "cursor", "requestId", "accounting", "success", "status", "sourceUrl", "fetchedAt", "coverage" ], "additionalProperties": false }, { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "accounting": { "type": "object", "properties": { "upstreamRequests": { "type": "integer", "minimum": 0 }, "responseBytes": { "type": "integer", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "upstreamRequests", "responseBytes", "durationMs" ], "additionalProperties": false }, "success": { "type": "boolean", "const": false }, "status": { "type": "string", "enum": [ "failed", "challenged" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "not_found", "upstream_challenged", "upstream_rate_limited", "upstream_error", "upstream_graphql_error", "unsupported_page", "restricted_page", "response_too_large", "unsafe_redirect", "request_limit", "timeout", "busy", "payload_too_complex", "public_client_unavailable" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "requestId", "accounting", "success", "status", "failure" ], "additionalProperties": false } ] } } } }