{ "id": "public-api-catalog", "version": "2026-10-16", "description": "Public API catalog used by AI integration prompts. It includes published endpoints plus model-family guide metadata; model guides are not separate endpoints.", "baseUrl": "https://api.requestbeam.com", "auth": { "type": "Bearer API Key", "header": "Authorization", "format": "Bearer ${apiKey}" }, "modelCatalog": { "asOf": "2026-08-22", "source": "Static reference list. GET /v1/models remains authoritative for each API Key. deepseek-v4.1-flash is a distinct model ID and is available only after deployment and enablement; its inclusion here does not confirm production availability.", "dynamicEndpoint": "/v1/models", "textChat": [ "gpt-5.4", "gpt-5.5", "gpt-5.6-sol", "gpt-5.6-terra", "gpt-6-astra", "claude-fable-5", "claude-fable-5-1", "claude-haiku-4-5", "claude-opus-4-5", "claude-opus-4-6", "claude-opus-4-7", "claude-opus-4-8", "claude-opus-5", "claude-opus-5-5", "claude-sonnet-4-5", "claude-sonnet-4-6", "claude-sonnet-5", "deepseek-v4-flash", "deepseek-v4-pro", "deepseek-v4.1-flash", "gemini-3.6-flash", "gemini-3.7-flash", "gemini-3.8-flash", "gemini-3.5-flash-lite", "kimi-k3", "minimax-m3" ], "responses": [ "gpt-5.4", "gpt-5.5", "gpt-5.6-sol", "gpt-5.6-terra", "gpt-6-astra" ], "claudeMessages": [ "claude-fable-5", "claude-fable-5-1", "claude-haiku-4-5", "claude-opus-4-5", "claude-opus-4-6", "claude-opus-4-7", "claude-opus-4-8", "claude-opus-5", "claude-opus-5-5", "claude-sonnet-4-5", "claude-sonnet-4-6", "claude-sonnet-5" ], "images": [ "gpt-image-2", "gpt-image-2.5-flare", "gpt-image-2.5-sunburst" ], "videos": [ "seedance-2.0", "seedance-2.5" ], "dataApis": [ "twitterapi", "similarwebapi" ], "textFamilyGuides": [ { "family": "deepseek", "models": [ "deepseek-v4-flash", "deepseek-v4-pro", "deepseek-v4.1-flash" ], "endpointIds": [ "common-chat-completions" ], "docSlugs": { "zh": "zh/api-reference/DeepSeek/models", "en": "en/api-reference/DeepSeek/models" } }, { "family": "gemini", "models": [ "gemini-3.6-flash", "gemini-3.7-flash", "gemini-3.8-flash", "gemini-3.5-flash-lite" ], "endpointIds": [ "common-chat-completions" ], "docSlugs": { "zh": "zh/api-reference/Gemini/models", "en": "en/api-reference/Gemini/models" } }, { "family": "kimi", "models": [ "kimi-k3" ], "endpointIds": [ "common-chat-completions" ], "docSlugs": { "zh": "zh/api-reference/Kimi/models", "en": "en/api-reference/Kimi/models" } }, { "family": "minimax", "models": [ "minimax-m3" ], "endpointIds": [ "common-chat-completions" ], "docSlugs": { "zh": "zh/api-reference/MiniMax/models", "en": "en/api-reference/MiniMax/models" } } ] }, "endpoints": [ { "id": "similarweb-keyword-suggestions", "title": "Keyword suggestions", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/keywords/suggestions", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keyword", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "sort", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "asc", "type": "boolean", "description": "boolean string: true or false" }, { "name": "page", "type": "integer", "description": "integer string; 1-1000" }, { "name": "rowsPerPage", "type": "integer", "description": "integer string; 1-1000" }, { "name": "type", "type": "string", "description": "Allowed values: Broad, Phrase, Exact, Related", "enum": [ "Broad", "Phrase", "Exact", "Related" ] }, { "name": "websource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "rangeFilter", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults: country 999, latest 28d, rowsPerPage 100, type Broad, websource Total, and windowVolume descending. Optional page is 1-based. rangeFilter uses native syntax, for example volume,100,10000|difficulty,0,40. Matching-type and filter availability depend on the data source.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": true, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keyword": "analytics" } }, "url": "https://api.requestbeam.com/v1/similarweb/keywords/suggestions" }, { "id": "similarweb-backlinks", "title": "Backlinks", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/backlinks", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "Key", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "Page", "type": "integer", "description": "integer string; 1-1000" }, { "name": "PageSize", "type": "integer", "description": "integer string; 1-1000" }, { "name": "Status", "type": "string", "description": "Allowed values: All, Active, New, Lost", "enum": [ "All", "Active", "New", "Lost" ] }, { "name": "FollowType", "type": "string", "description": "Allowed values: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow", "enum": [ "All", "DoFollowOnly", "NoFollowOnly", "DoFollow", "NoFollow" ] }, { "name": "DomainScoreFrom", "type": "integer", "description": "integer string; 0-100" }, { "name": "DomainScoreTo", "type": "integer", "description": "integer string; 0-100" }, { "name": "sort", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "asc", "type": "boolean", "description": "boolean string: true or false" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults: Page 1, PageSize 100, Status All, FollowType All, and DomainScore descending. Key is capitalized; do not use key or keys.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": true, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "Key": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/backlinks" }, { "id": "similarweb-website-keywords", "title": "Website keywords", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/keywords", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Daily, Monthly", "enum": [ "Daily", "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "sort", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "asc", "type": "boolean", "description": "boolean string: true or false" }, { "name": "iso", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "isDaily", "type": "boolean", "description": "boolean string: true or false" }, { "name": "IncludeBranded", "type": "boolean", "description": "boolean string: true or false" }, { "name": "IncludeNoneBranded", "type": "boolean", "description": "boolean string: true or false" }, { "name": "page", "type": "integer", "description": "integer string; 1-1000" }, { "name": "pageSize", "type": "integer", "description": "integer string; 1-1000" }, { "name": "sourceType", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "pageFilterJson", "type": "string", "description": "string containing a JSON array" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults: page 1, pageSize 100, sourceType all, and both branded flags false. pageFilterJson is one URL-encoded JSON array string; when omitted it targets keys as a domain. latest=1m selects the one-month overview mode with pageSize 5 and isWindow=false unless explicitly provided. Use sourceType=organic or paid with IncludeNoneBranded=true and IncludeBranded=false for non-branded keyword views.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": true, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/keywords" }, { "id": "similarweb-keyword-websites", "title": "Keyword ranking websites", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/keywords/websites", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Daily, Monthly", "enum": [ "Daily", "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "sort", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "asc", "type": "boolean", "description": "boolean string: true or false" }, { "name": "iso", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "isDaily", "type": "boolean", "description": "boolean string: true or false" }, { "name": "tab", "type": "integer", "description": "nonnegative integer string" }, { "name": "mtd", "type": "boolean", "description": "boolean string: true or false" }, { "name": "selectedPageTab", "type": "string", "description": "Allowed values: Organic, Paid", "enum": [ "Organic", "Paid" ] }, { "name": "graphDuration", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "graphType", "type": "integer", "description": "integer string; 1-1000" }, { "name": "isDurationChanged", "type": "boolean", "description": "boolean string: true or false" }, { "name": "ignoreFilterConsistency", "type": "boolean", "description": "boolean string: true or false" }, { "name": "Device", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "sourceType", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "page", "type": "integer", "description": "integer string; 1-1000" }, { "name": "pageSize", "type": "integer", "description": "integer string; 1-1000" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. keys is a keyword, not a website domain. Defaults include selectedPageTab=Organic, sourceType=organic, Device=Total, and graphDuration=28d. Optional page and pageSize use 1-based/positive integers.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": true, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "analytics" } }, "url": "https://api.requestbeam.com/v1/similarweb/keywords/websites" }, { "id": "similarweb-traffic-sources", "title": "Traffic sources", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/traffic-sources", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Daily, Monthly", "enum": [ "Daily", "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "sourceType", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "ignoreFilterConsistency", "type": "boolean", "description": "boolean string: true or false" }, { "name": "page", "type": "integer", "description": "integer string; 1-1000" }, { "name": "orderBy", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults: sourceType=Referral, page=1, orderBy=Share desc, and timeGranularity=Daily. This table is distinct from the incoming-referrals endpoint.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": true, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/traffic-sources" }, { "id": "similarweb-outgoing-traffic", "title": "Outgoing traffic", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/outgoing-traffic", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "key", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "isWWW", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "orderby", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "orderBy", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "sort", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "asc", "type": "boolean", "description": "boolean string: true or false" }, { "name": "page", "type": "integer", "description": "integer string; 1-1000" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. from and to are required. Singular key only. Defaults: country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby and orderBy are distinct and forwarded independently; keep them consistent. No latest, pageSize, rowsPerPage, includeSubDomains, or timeGranularity. Rows are in Records; TotalCount is the upstream total, not the current page length.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": true, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "key": "example.com", "from": "2026-07-01", "to": "2026-07-31" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/outgoing-traffic" }, { "id": "similarweb-incoming-referrals", "title": "Incoming referrals", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/incoming-referrals", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "key", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "isWWW", "type": "boolean", "description": "boolean string: true or false" }, { "name": "iso", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isDaily", "type": "boolean", "description": "boolean string: true or false" }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "selectedTab", "type": "string", "description": "Allowed values: incomingTraffic", "enum": [ "incomingTraffic" ] }, { "name": "orderBy", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "ignoreFilterConsistency", "type": "boolean", "description": "boolean string: true or false" }, { "name": "page", "type": "integer", "description": "integer string; 1-1000" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Singular key only. Defaults: country=999, latest=28d, isWWW=false, isWindow=true, isDaily=false, webSource=Total, selectedTab=incomingTraffic, orderBy=TotalShare desc, ignoreFilterConsistency=false, page=1. No keys, pageSize, rowsPerPage, includeSubDomains, or timeGranularity. Rows are in Records; native fields may include SiteOrigins and TotalShare.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": true, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "key": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/incoming-referrals" }, { "id": "similarweb-branded-keywords", "title": "Branded keyword share", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/branded-keywords", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Daily, Monthly", "enum": [ "Daily", "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "duration", "type": "string", "description": "Allowed values: 1m", "enum": [ "1m" ] } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults to the previous complete UTC month. duration is fixed to 1m.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/branded-keywords" }, { "id": "similarweb-geography", "title": "Traffic geography", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/geography", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Daily, Monthly", "enum": [ "Daily", "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "pageSize", "type": "integer", "description": "integer string; 1-1000" }, { "name": "orderBy", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults to the previous three complete UTC months, pageSize=5 and orderBy=TotalShare desc.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/geography" }, { "id": "similarweb-device-distribution", "title": "Device distribution", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/devices", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Daily, Monthly", "enum": [ "Daily", "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "ShouldGetVerifiedData", "type": "boolean", "description": "boolean string: true or false" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults to the previous three complete UTC months and ShouldGetVerifiedData=false.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/devices" }, { "id": "similarweb-search-performance", "title": "Search performance", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/search-performance", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Daily, Monthly", "enum": [ "Daily", "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "pageSize", "type": "integer", "description": "integer string; 1-1000" }, { "name": "duration", "type": "string", "description": "Allowed values: 1m", "enum": [ "1m" ] }, { "name": "SourceType", "type": "string", "description": "Allowed values: Organic, Paid", "enum": [ "Organic", "Paid" ] } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults to the previous complete UTC month, pageSize=5, duration=1m and SourceType=Organic. Use SourceType=Paid for paid keywords; do not substitute sourceType.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/search-performance" }, { "id": "similarweb-social-traffic", "title": "Social traffic", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/social-traffic", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Daily, Monthly", "enum": [ "Daily", "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults to the previous three complete UTC months. webSource is not accepted.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/social-traffic" }, { "id": "similarweb-engagement", "title": "Engagement overview", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/engagement", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Daily, Monthly", "enum": [ "Daily", "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "ShouldGetVerifiedData", "type": "boolean", "description": "boolean string: true or false" }, { "name": "includeLeaders", "type": "boolean", "description": "boolean string: true or false" }, { "name": "unBounced", "type": "boolean", "description": "boolean string: true or false" }, { "name": "beta", "type": "boolean", "description": "boolean string: true or false" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults include ShouldGetVerifiedData=false, includeLeaders=true and unBounced=false. Native Data rows may contain AvgMonthVisits, BounceRate, PagesPerVisit and AvgVisitDuration.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/engagement" }, { "id": "similarweb-visits", "title": "Total visits", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/visits", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Monthly", "enum": [ "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "compareFrom", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "compareTo", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "ShouldGetVerifiedData", "type": "boolean", "description": "boolean string: true or false" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. compareFrom and compareTo must be supplied together as valid ordered dates. timeGranularity is Monthly. Native fields may include TotalVisits, Change and ShareOfVisits; a rolling total is not necessarily a complete-calendar-month total.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/visits" }, { "id": "similarweb-visits-table", "title": "Visits table", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/visits/table", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Monthly", "enum": [ "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "compareFrom", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "compareTo", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "ShouldGetVerifiedData", "type": "boolean", "description": "boolean string: true or false" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. compareFrom and compareTo must be supplied together as valid ordered dates. timeGranularity is Monthly; the response retains the native table shape.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/visits/table" }, { "id": "similarweb-visits-trend", "title": "Visits trend", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/visits/trend", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Daily, Weekly, Monthly", "enum": [ "Daily", "Weekly", "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" }, { "name": "ShouldGetVerifiedData", "type": "boolean", "description": "boolean string: true or false" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults to the rolling 28-day daily window. timeGranularity accepts Daily, Weekly or Monthly.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/visits/trend" }, { "id": "similarweb-ranks", "title": "Website ranks", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/ranks", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Monthly", "enum": [ "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. timeGranularity is Monthly. Native response uses distinct GlobalRank, CountryRank and CategoryRank objects.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/ranks" }, { "id": "similarweb-country-ranks", "title": "Country ranks", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/ranks/country", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Monthly", "enum": [ "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. timeGranularity is Monthly. This is the explicit country-rank table, not the combined ranks response.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/ranks/country" }, { "id": "similarweb-global-ranks", "title": "Global ranks", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/ranks/global", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Monthly", "enum": [ "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. timeGranularity is Monthly. This returns the separate global-rank table.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/ranks/global" }, { "id": "similarweb-category-ranks", "title": "Category ranks", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/ranks/category", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Monthly", "enum": [ "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. timeGranularity is Monthly. This returns the separate industry/category-rank table.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/ranks/category" }, { "id": "similarweb-channels", "title": "Traffic channels", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/channels", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Daily, Monthly", "enum": [ "Daily", "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults to the rolling 28-day daily window. Native channel values are visit counts; derive shares only when their sum is positive.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/channels" }, { "id": "similarweb-similar-sites", "title": "Similar sites", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/similar-sites", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Monthly", "enum": [ "Monthly" ] }, { "name": "orderBy", "type": "string", "description": "Allowed values: Affinity desc", "enum": [ "Affinity desc" ] } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults to the previous three complete UTC months. isWindow must be false, timeGranularity is Monthly, and orderBy is fixed to Affinity desc. No latest or webSource.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/similar-sites" }, { "id": "similarweb-similar-site-suggestions", "title": "Similar site suggestions", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/similar-sites/suggestions", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "key", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "limit", "type": "integer", "description": "integer string; 1-20" }, { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Singular key; limit defaults to 20 and must be 1-20. country defaults to 999 and webSource to Total.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "key": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/similar-sites/suggestions" }, { "id": "similarweb-visits-history", "title": "Monthly visits history", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/history/visits", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Monthly", "enum": [ "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults to the previous six complete UTC months. Only country=999, isWindow=false and timeGranularity=Monthly are supported. latest accepts 1m through 6m; explicit dates must be complete months inside that rolling six-month window. Native series may appear under Data.. with Key/Value points; source names, including MobileWeb or Mobile Web, are preserved. Values represent estimated visits.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/history/visits" }, { "id": "similarweb-bounce-rate-history", "title": "Monthly bounce rate history", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/history/bounce-rate", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Monthly", "enum": [ "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults to the previous six complete UTC months. Only country=999, isWindow=false and timeGranularity=Monthly are supported. latest accepts 1m through 6m; explicit dates must be complete months inside that rolling six-month window. Native series may appear under Data.. with Key/Value points; source names, including MobileWeb or Mobile Web, are preserved. Values represent bounce-rate fractions.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/history/bounce-rate" }, { "id": "similarweb-visit-duration-history", "title": "Monthly visit duration history", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/history/visit-duration", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Monthly", "enum": [ "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults to the previous six complete UTC months. Only country=999, isWindow=false and timeGranularity=Monthly are supported. latest accepts 1m through 6m; explicit dates must be complete months inside that rolling six-month window. Native series may appear under Data.. with Key/Value points; source names, including MobileWeb or Mobile Web, are preserved. Values represent seconds per visit.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/history/visit-duration" }, { "id": "similarweb-pages-per-visit-history", "title": "Monthly pages per visit history", "category": "SimilarwebAPI", "method": "GET", "path": "/v1/similarweb/websites/history/pages-per-visit", "auth": "Bearer API Key", "docSlug": "zh/api-reference/similarweb/reference", "parameters": { "path": [], "query": { "required": [ { "name": "keys", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ], "optional": [ { "name": "country", "type": "integer", "description": "nonnegative integer string" }, { "name": "from", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "to", "type": "string", "description": "string; valid YYYY-MM-DD or YYYY\\|MM\\|DD" }, { "name": "includeSubDomains", "type": "boolean", "description": "boolean string: true or false" }, { "name": "isWindow", "type": "boolean", "description": "boolean string: true or false" }, { "name": "webSource", "type": "string", "description": "Allowed values: Total, Desktop, MobileWeb", "enum": [ "Total", "Desktop", "MobileWeb" ] }, { "name": "timeGranularity", "type": "string", "description": "Allowed values: Monthly", "enum": [ "Monthly" ] }, { "name": "latest", "type": "string", "description": "string; 1-2048 UTF-8 bytes after trimming" } ] }, "body": null }, "responseSummary": "Returns the original native JSON without a platform success/data wrapper; preserves unknown fields and numeric precision. Defaults to the previous six complete UTC months. Only country=999, isWindow=false and timeGranularity=Monthly are supported. latest accepts 1m through 6m; explicit dates must be complete months inside that rolling six-month window. Native series may appear under Data.. with Key/Value points; source names, including MobileWeb or Mobile Web, are preserved. Values represent pages per visit.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Query names are case-sensitive. Unknown and duplicate fields, request bodies, invalid date pairs and invalid values are rejected. Do not send a model parameter. Keep X-Request-Id for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false, "billingUnit": "request" }, "minimalExample": { "query": { "keys": "example.com" } }, "url": "https://api.requestbeam.com/v1/similarweb/websites/history/pages-per-visit" }, { "id": "models-list", "title": "Model Catalog", "category": "Models", "method": "GET", "path": "/v1/models", "auth": "Bearer API Key", "docSlug": "zh/api-reference/models", "parameters": { "path": [], "query": [], "body": null }, "responseSummary": "Returns the active models visible to the current API Key. Each item contains uid, name, version, type, and public platform pricing. API Key model permissions may reduce the list.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "For APIs that define model, pass data[].uid in the request body's model field. Use only IDs returned by this endpoint." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false }, "minimalExample": {}, "url": "https://api.requestbeam.com/v1/models" }, { "id": "common-chat-completions", "title": "Common Chat Completions", "category": "OpenAI compatible text", "method": "POST", "path": "/v1/chat-completions", "auth": "Bearer API Key", "docSlug": "zh/api-reference/common-chat-completions", "parameters": { "path": [], "query": [], "body": { "required": [ { "name": "model", "type": "string", "description": "Model ID, for example gpt-5.4." }, { "name": "messages", "type": "object[]", "description": "OpenAI Chat Completions style messages with role and content." } ], "optional": [ { "name": "stream", "type": "boolean", "default": false, "description": "Whether to use SSE streaming. Defaults to false; set true explicitly for streaming." }, { "name": "temperature", "type": "number", "default": 1 }, { "name": "max_tokens", "type": "integer" }, { "name": "max_completion_tokens", "type": "integer", "description": "Compatibility alternative to max_tokens. Support is model-dependent." }, { "name": "top_p", "type": "number", "default": 1 }, { "name": "frequency_penalty", "type": "number", "default": 0 }, { "name": "presence_penalty", "type": "number", "default": 0 }, { "name": "stop", "type": "string | string[]" }, { "name": "n", "type": "integer", "default": 1 } ] } }, "responseSummary": "Non-streaming responses use OpenAI Chat Completions fields: id, object, created, model, choices, and usage. Streaming responses return SSE chat completion chunks.", "errorSummary": { "shape": { "code": "number", "message": "string", "type": "string" }, "notes": "Chat Completions HTTP errors are flat objects with a numeric platform business code and type=api_error, including upstream HTTP errors before SSE starts. code is not the HTTP status or a string. requestId is optional. Missing or invalid messages return HTTP 400/code 10000 before provider invocation; Gemini internal model aliases return HTTP 403/code 20001 before job creation or billing. Errors inside an already-started SSE stream and other protocols have their own contracts." }, "behavior": { "stream": { "supported": true, "default": false, "format": "SSE" }, "pagination": false, "asyncJob": false }, "minimalExample": { "body": { "model": "gpt-5.4", "messages": [ { "role": "user", "content": "Hello, introduce yourself in one sentence." } ], "stream": false } }, "url": "https://api.requestbeam.com/v1/chat-completions" }, { "id": "openai-responses", "title": "OpenAI Multimodal Responses", "category": "OpenAI compatible text", "method": "POST", "path": "/openai/responses", "auth": "Bearer API Key", "docSlug": "zh/api-reference/OpenAI/responses", "parameters": { "path": [], "query": [], "body": { "required": [ { "name": "model", "type": "string", "description": "Model ID, for example gpt-5.4." }, { "name": "input", "type": "string | object[]", "description": "Responses API input. Use string for simple text, or message/content arrays for multimodal input." } ], "optional": [ { "name": "stream", "type": "boolean", "default": false, "description": "When true, returns OpenAI Responses style SSE events." }, { "name": "instructions", "type": "string" }, { "name": "max_output_tokens", "type": "integer" }, { "name": "temperature", "type": "number", "default": 1 }, { "name": "top_p", "type": "number", "default": 1 }, { "name": "text", "type": "object" }, { "name": "tools", "type": "object[]" }, { "name": "tool_choice", "type": "string | object" }, { "name": "parallel_tool_calls", "type": "boolean" }, { "name": "reasoning", "type": "object" }, { "name": "include", "type": "string[]" }, { "name": "prompt_cache_key", "type": "string" }, { "name": "prompt_cache_retention", "type": "string" }, { "name": "safety_identifier", "type": "string" }, { "name": "store", "type": "boolean" } ] } }, "responseSummary": "Non-streaming responses use OpenAI Responses style fields: id, object, created_at, model, output, and usage. Output may contain messages, function calls, or tool related items.", "errorSummary": { "shape": { "code": "number", "message": "string", "type": "string" }, "notes": "Platform errors are flat objects, not wrapped in an error object." }, "behavior": { "stream": { "supported": true, "default": false, "format": "SSE", "completionSignals": [ "response.completed", "connection closed" ] }, "pagination": false, "asyncJob": false }, "minimalExample": { "body": { "model": "gpt-5.4", "input": "Hello, reply with one short sentence." } }, "url": "https://api.requestbeam.com/openai/responses" }, { "id": "openai-images-generations", "title": "GPT Image Generation", "category": "OpenAI compatible images", "method": "POST", "path": "/openai/v1/images/generations", "auth": "Bearer API Key", "docSlug": "zh/api-reference/OpenAI/gpt-image-2", "parameters": { "path": [], "query": [], "body": { "required": [ { "name": "model", "type": "string", "description": "Use gpt-image-2, gpt-image-2.5-flare, or gpt-image-2.5-sunburst. Check GET /v1/models for availability. GPT Image 2.5 documentation: /zh/api-reference/OpenAI/gpt-image-2.5." }, { "name": "prompt", "type": "string", "description": "Image generation prompt." } ], "optional": [ { "name": "n", "type": "integer", "default": 1, "description": "gpt-image-2 supports one image; GPT Image 2.5 supports 1 through 4 images per request." }, { "name": "size", "type": "string", "default": "auto", "description": "Use an aspect ratio such as 1:1, 4:3, 16:9, or 9:16, or direct pixel dimensions such as 1024x1024 and 2048x1152." }, { "name": "quality", "type": "string", "default": "auto", "description": "low, medium, high, or auto; GPT Image 2.5 additionally supports xhigh and max." }, { "name": "resolution", "type": "string", "default": "1k", "description": "Output resolution tier: 1k, 2k, or 4k." }, { "name": "image_urls", "type": "array", "description": "Up to 16 references. GPT Image 2.5 requires publicly accessible HTTP(S) URLs. gpt-image-2 also accepts base64 data URIs, with 20 MB per image and 256 MB total." }, { "name": "output_format", "type": "string", "default": "png", "description": "png, jpeg, or webp." }, { "name": "stream", "type": "boolean", "default": false, "description": "Whether to use SSE image generation events." } ] } }, "responseSummary": "Non-streaming responses return created, data array entries with image url, and usage. Streaming responses emit image_generation.completed with final image URLs, then [DONE].", "errorSummary": { "shape": { "code": "number", "message": "string", "type": "string" }, "notes": "Common HTTP causes include 400 missing parameters, 401 auth failure, 402 insufficient balance, 404 unavailable model, 429 rate limit, and 5xx generation failure." }, "behavior": { "stream": { "supported": true, "default": false, "format": "SSE", "completionSignals": [ "image_generation.completed", "[DONE]" ] }, "pagination": false, "asyncJob": false }, "minimalExample": { "body": { "model": "gpt-image-2", "prompt": "A clean studio product photo of a transparent glass cup on a light gray background, no text.", "n": 1, "size": "1024x1024", "quality": "low", "output_format": "png" } }, "url": "https://api.requestbeam.com/openai/v1/images/generations" }, { "id": "seedance-video-generation", "title": "Seedance Video Generation", "category": "Native asynchronous video", "method": "POST", "path": "/v1/video/seedance", "auth": "Bearer API Key", "docSlug": "zh/api-reference/BytePlus/seedance-2-0", "parameters": { "path": [], "query": [], "body": { "required": [ { "name": "model", "type": "string", "description": "Video model selector. Use seedance-2.0 (alias seedance-2-0) or seedance-2.5. See the separate version-specific documentation." } ], "optional": [ { "name": "prompt", "type": "string", "description": "Required for text-only generation; may be omitted with image/video input. Omit for 2.5 draft_task reuse. metadata.content text items are discarded." }, { "name": "duration", "type": "number", "default": 5, "description": "2.0 supports 4-15 seconds. 2.5 supports 4-30 seconds or -1 for automatic duration." }, { "name": "seconds", "type": "string", "default": "5", "description": "Native duration as an integer string, using the selected version's limits. Omit duration controls for draft_task reuse." }, { "name": "size", "type": "string", "description": "Native output resolution. 2.5 also retains legacy aspect-ratio values in size. metadata.resolution takes precedence." }, { "name": "resolution", "type": "string", "default": "720p", "description": "2.0 supports 480p, 720p, 1080p, and 4k. 2.5 supports 480p, 720p, and 1080p." }, { "name": "aspectRatio", "type": "string", "description": "Aspect ratio; aspect_ratio is an alias and metadata.ratio is accepted. 2.5 first/last-frame input requires adaptive." }, { "name": "generateAudio", "type": "boolean", "description": "Generated audio control for both models. generate_audio and metadata.generate_audio are aliases. Omit for draft_task reuse." }, { "name": "metadata", "type": "object", "description": "Both versions: resolution, ratio, content, generate_audio. 2.5 additionally accepts duration and output_format. Typed content supports image_url, video_url, audio_url; text items are discarded. draft_task is exclusive to 2.5 and must be the only content item." }, { "name": "images", "type": "string[]", "description": "Native image shorthand; first/second images are first/last frames. Media URLs accept HTTP(S) or existing asset:// identifiers." }, { "name": "imageUrls", "type": "string[]", "description": "2.0 image shorthand retains first/last-frame semantics; 2.5 uses reference-image semantics. Limits: 2.0 9 images, 2.5 30 images." }, { "name": "imageWithRoles", "type": "object[]", "description": "Both versions: url and first_frame, last_frame, or reference_image role. Explicit roles are also supported in metadata.content." }, { "name": "videoUrls", "type": "string[]", "description": "Reference videos; at most 3 for 2.0 or 10 for 2.5." }, { "name": "audioUrls", "type": "string[]", "description": "Reference audio requires an image or video. At most 3 for 2.0 or 10 for 2.5; 2.5 media total at most 50." }, { "name": "callback_url", "type": "string", "description": "Optional native callback URL for both versions; availability depends on the selected channel. Poll the job endpoint for authoritative status." }, { "name": "outputFormat", "type": "string", "default": "mp4", "description": "Seedance 2.5 only: mp4. output_format and metadata.output_format are aliases; mov and watermark are rejected." } ] } }, "responseSummary": "Returns success, requestId, and data containing only jobId, status, model, and message. A successful submission is not a completed video.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Common failures include an unsupported model value or invalid parameters, inaccessible reference URLs, insufficient balance, rate limiting, and temporary service unavailability." }, "behavior": { "stream": false, "pagination": false, "asyncJob": { "supported": true, "jobIdResponsePath": "data.jobId", "statusEndpoint": "GET /v1/jobs/{id}", "terminalStatuses": [ "COMPLETED", "FAILED", "CANCELLED" ] } }, "minimalExample": { "body": { "model": "seedance-2.0", "prompt": "A quiet city street at dawn, slow forward camera movement.", "duration": 5, "resolution": "720p", "aspectRatio": "16:9", "generateAudio": false } }, "url": "https://api.requestbeam.com/v1/video/seedance" }, { "id": "jobs-get", "title": "Get Async Job", "category": "Asynchronous jobs", "method": "GET", "path": "/v1/jobs/{id}", "auth": "Bearer API Key", "docSlug": "zh/api-reference/jobs", "parameters": { "path": [ { "name": "id", "type": "string", "required": true, "description": "Numeric jobId returned by an asynchronous creation endpoint." } ], "query": [], "body": null }, "responseSummary": "Returns id, status, inputParams, outputResult, and timestamps. Read outputResult only after status is COMPLETED.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Returns 400 for a non-numeric ID, 403 when the job is not accessible to the current API Key, and 404 when the job does not exist." }, "behavior": { "stream": false, "pagination": false, "asyncJob": { "supported": true, "pollIntervalSeconds": "5-10", "terminalStatuses": [ "COMPLETED", "FAILED", "CANCELLED" ] } }, "minimalExample": { "pathParams": { "id": "123456789012345678" } }, "url": "https://api.requestbeam.com/v1/jobs/{id}" }, { "id": "claude-messages", "title": "Claude Messages", "category": "Claude compatible text", "method": "POST", "path": "/anthropic/v1/messages", "auth": "x-api-key or Bearer API Key", "docSlug": "zh/api-reference/Claude/messages", "headers": { "required": [ { "name": "anthropic-version", "type": "string", "description": "Anthropic API version, for example 2023-06-01." } ] }, "parameters": { "path": [], "query": [], "body": { "required": [ { "name": "model", "type": "string", "description": "Claude model ID, for example claude-sonnet-4-6." }, { "name": "max_tokens", "type": "integer", "description": "Maximum output tokens." }, { "name": "messages", "type": "object[]", "description": "Anthropic Messages style conversation messages." } ], "optional": [ { "name": "system", "type": "string | object[]" }, { "name": "stream", "type": "boolean", "default": false, "description": "When true, returns Anthropic Messages SSE events." }, { "name": "temperature", "type": "number" }, { "name": "top_p", "type": "number" }, { "name": "top_k", "type": "integer" }, { "name": "stop_sequences", "type": "string[]" }, { "name": "tools", "type": "object[]" }, { "name": "tool_choice", "type": "object" }, { "name": "thinking", "type": "object", "description": "Anthropic extended thinking configuration." }, { "name": "metadata", "type": "object" } ] } }, "responseSummary": "Non-streaming responses keep the Anthropic Message shape: id, type, role, model, native content blocks, stop_reason, stop_sequence, and usage. Streaming responses return Anthropic SSE events such as message_start, content_block_delta, message_delta, and message_stop. Tool use, thinking signatures, and prompt-cache usage remain in Anthropic-native fields when present.", "errorSummary": { "shape": { "type": "error", "error": { "type": "string", "message": "string" } }, "notes": "Anthropic-compatible errors are wrapped in type=error with an error object." }, "behavior": { "stream": { "supported": true, "default": false, "format": "SSE", "completionSignals": [ "message_stop", "connection closed" ] }, "pagination": false, "asyncJob": false }, "minimalExample": { "headers": { "anthropic-version": "2023-06-01" }, "body": { "model": "claude-sonnet-4-6", "max_tokens": 128, "messages": [ { "role": "user", "content": "Hello, introduce yourself in one sentence." } ], "stream": false } }, "url": "https://api.requestbeam.com/anthropic/v1/messages" }, { "id": "twitter-get-user-by-username", "title": "Get Twitter User By Username", "category": "Twitter API", "method": "GET", "path": "/v1/twitter/users", "auth": "Bearer API Key", "docSlug": "zh/api-reference/twitter/get-user-by-username", "parameters": { "path": [], "query": { "required": [ { "name": "username", "type": "string", "description": "Twitter username, with or without leading @." } ], "optional": [ { "name": "user.fields", "type": "string", "description": "Comma-separated fields such as created_at,description,public_metrics,verified." } ] }, "body": null }, "responseSummary": "Returns data with normalized X API v2 style user fields such as id, name, username, created_at, description, profile_image_url, public_metrics, verified, and verified_type.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Keep requestId for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false }, "minimalExample": { "query": { "username": "elonmusk", "user.fields": "created_at,description,public_metrics,verified" } }, "url": "https://api.requestbeam.com/v1/twitter/users" }, { "id": "twitter-get-user-by-id", "title": "Get Twitter User By ID", "category": "Twitter API", "method": "GET", "path": "/v1/twitter/users/{id}", "auth": "Bearer API Key", "docSlug": "zh/api-reference/twitter/get-user-by-id", "parameters": { "path": [ { "name": "id", "type": "string", "required": true, "description": "Twitter user ID, for example 44196397." } ], "query": { "required": [], "optional": [ { "name": "user.fields", "type": "string", "description": "Comma-separated fields such as verified,public_metrics,profile_image_url." } ] }, "body": null }, "responseSummary": "Returns data with normalized X API v2 style user fields such as id, name, username, profile_image_url, public_metrics, and verified.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Keep requestId for troubleshooting." }, "behavior": { "stream": false, "pagination": false, "asyncJob": false }, "minimalExample": { "pathParams": { "id": "44196397" }, "query": { "user.fields": "verified,public_metrics,profile_image_url" } }, "url": "https://api.requestbeam.com/v1/twitter/users/{id}" }, { "id": "twitter-get-user-tweets", "title": "Get Twitter User Timeline", "category": "Twitter API", "method": "GET", "path": "/v1/twitter/users/{id}/tweets", "auth": "Bearer API Key", "docSlug": "zh/api-reference/twitter/get-user-tweets", "parameters": { "path": [ { "name": "id", "type": "string", "required": true, "description": "Twitter user ID, for example 44196397." } ], "query": { "required": [], "optional": [ { "name": "max_results", "type": "integer", "default": 10, "description": "Number of tweets to return, 1-100." }, { "name": "pagination_token", "type": "string", "description": "Cursor from the previous response meta.next_token." }, { "name": "exclude", "type": "string", "description": "Comma-separated values, currently replies and retweets." }, { "name": "expansions", "type": "string", "description": "Comma-separated expansions. Use author_id to receive includes.users." }, { "name": "tweet.fields", "type": "string", "description": "Comma-separated tweet fields such as created_at,public_metrics,attachments,source." }, { "name": "user.fields", "type": "string", "description": "Fields for includes.users when expansions includes author_id." } ] }, "body": null }, "responseSummary": "Returns data tweet array, optional includes.users, and required meta with newest_id, oldest_id, next_token, and result_count.", "errorSummary": { "shape": { "success": false, "error": { "code": "number", "message": "string" }, "requestId": "string" }, "notes": "Keep requestId for troubleshooting." }, "behavior": { "stream": false, "pagination": { "supported": true, "cursorResponsePath": "meta.next_token", "cursorRequestQuery": "pagination_token" }, "asyncJob": false }, "minimalExample": { "pathParams": { "id": "44196397" }, "query": { "max_results": 5, "exclude": "retweets,replies", "expansions": "author_id", "tweet.fields": "created_at,public_metrics,attachments,author_id,conversation_id", "user.fields": "public_metrics" } }, "url": "https://api.requestbeam.com/v1/twitter/users/{id}/tweets" } ] }