Skip to content

docs(model-api): sync generated references with the public catalog #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liyangbing merged 1 commit into from
Oct 13, 2026
Merged

docs(model-api): sync generated references with the public catalog #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1,880 changes: 241 additions & 1,639 deletions .vitepress/modelApiReferenceSidebar.generated.ts
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions .vitepress/theme/generatedApiReferenceSpecs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ export const generatedApiReferenceSpecs: Record<string, any> = {
"name": "model",
"type": "string",
"required": true,
"description": "Current model identifier, for example kwaivgi/kling-video/3.0/turbo/standard/text-to-video."
"description": "Current model identifier, for example kwaivgi/kling-video/v3/standard/text-to-video."
},
{
"name": "prompt",
Expand Down Expand Up @@ -449,15 +449,15 @@ export const generatedApiReferenceSpecs: Record<string, any> = {
{
"label": "cURL",
"language": "bash",
"code": "curl -X POST https://api.sandbase.ai/v1/run \\\n -H \"Authorization: Bearer $SANDBASE_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"model\":\"kwaivgi/kling-video/3.0/turbo/standard/text-to-video\",\"prompt\":\"A cat playing piano\",\"duration\":5}'"
"code": "curl -X POST https://api.sandbase.ai/v1/run \\\n -H \"Authorization: Bearer $SANDBASE_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"model\":\"kwaivgi/kling-video/v3/standard/text-to-video\",\"prompt\":\"A cat playing piano\",\"duration\":5}'"
},
{
"label": "Python",
"language": "python",
"code": "# 1. Submit generation request\nresponse = client.post(\"/v1/run\", json={\n \"model\": \"kwaivgi/kling-video/3.0/turbo/standard/text-to-video\",\n \"prompt\": \"A cat playing piano\",\n \"duration\": 5,\n \"webhook_url\": \"https://hooks.example.com/sandbase/task?token=opaque-token\"\n})\ngeneration_id = response.json()[\"id\"]\n\n# 2. SandBase posts the terminal event to webhook_url.\n# You may still poll the existing result endpoint as a fallback.\nimport time\nwhile True:\n result = client.get(f\"/v1/run/{generation_id}\").json()\n if result[\"status\"] in (\"completed\", \"failed\", \"timeout\"):\n print(result)\n break\n time.sleep(5)"
"code": "# 1. Submit generation request\nresponse = client.post(\"/v1/run\", json={\n \"model\": \"kwaivgi/kling-video/v3/standard/text-to-video\",\n \"prompt\": \"A cat playing piano\",\n \"duration\": 5,\n \"webhook_url\": \"https://hooks.example.com/sandbase/task?token=opaque-token\"\n})\ngeneration_id = response.json()[\"id\"]\n\n# 2. SandBase posts the terminal event to webhook_url.\n# You may still poll the existing result endpoint as a fallback.\nimport time\nwhile True:\n result = client.get(f\"/v1/run/{generation_id}\").json()\n if result[\"status\"] in (\"completed\", \"failed\", \"timeout\"):\n print(result)\n break\n time.sleep(5)"
}
],
"response": { "status": "202 Accepted", "code": "{\n \"id\": \"run_01...\",\n \"status\": \"pending\",\n \"model\": \"kwaivgi/kling-video/3.0/turbo/standard/text-to-video\"\n}" }
"response": { "status": "202 Accepted", "code": "{\n \"id\": \"run_01...\",\n \"status\": \"pending\",\n \"model\": \"kwaivgi/kling-video/v3/standard/text-to-video\"\n}" }
},
"images/generations": {
"title": "Generate Image",
Expand Down
26 changes: 7 additions & 19 deletions .vitepress/theme/platform-api-sidebars/agentbody.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
export default {
"platform": "Agent Body",
"slug": "agentbody",
"operationCount": 9,
"operationCount": 6,
"groups": [
{
"key": "users",
"label": "Users & Accounts",
"operations": [
{
"text": "LinkedIn Profile",
"text": "Agent Body LinkedIn Profile Lookup",
"link": "/model-api-reference/platform-apis/agentbody/linkedin-profile"
},
{
"text": "YouTube Channel Email",
"text": "Agent Body YouTube Channel Email",
"link": "/model-api-reference/platform-apis/agentbody/youtube-channel-email"
}
]
Expand All @@ -23,31 +23,19 @@ export default {
"label": "Other",
"operations": [
{
"text": "YouTube Transcript",
"text": "Agent Body YouTube Transcript",
"link": "/model-api-reference/platform-apis/agentbody/youtube-transcript"
},
{
"text": "TikTok Transcript",
"link": "/model-api-reference/platform-apis/agentbody/tiktok-transcript"
},
{
"text": "TikTok Transcribe",
"link": "/model-api-reference/platform-apis/agentbody/tiktok-transcribe"
},
{
"text": "Document Parse",
"text": "Agent Body Document Parser",
"link": "/model-api-reference/platform-apis/agentbody/document-parse"
},
{
"text": "Humanize Writing",
"link": "/model-api-reference/platform-apis/agentbody/humanize-writing"
},
{
"text": "LinkedIn Email",
"text": "Agent Body LinkedIn Email",
"link": "/model-api-reference/platform-apis/agentbody/linkedin-email"
},
{
"text": "LinkedIn Phone",
"text": "Agent Body LinkedIn Phone Lookup",
"link": "/model-api-reference/platform-apis/agentbody/linkedin-phone"
}
]
Expand Down
156 changes: 69 additions & 87 deletions .vitepress/theme/platform-api-sidebars/bilibili.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,35 @@
export default {
"platform": "Bilibili",
"slug": "bilibili",
"operationCount": 41,
"operationCount": 38,
"groups": [
{
"key": "search",
"label": "Search & Discovery",
"operations": [
{
"text": "Get general search data",
"link": "/model-api-reference/platform-apis/bilibili/web/general-search"
},
{
"text": "Get home feed",
"text": "Bilibili App Home Feed",
"link": "/model-api-reference/platform-apis/bilibili/app/home-feed"
},
{
"text": "Get hot search data",
"link": "/model-api-reference/platform-apis/bilibili/web/hot-search"
},
{
"text": "Get popular feed",
"text": "Bilibili App Popular Feed",
"link": "/model-api-reference/platform-apis/bilibili/app/popular-feed"
},
{
"text": "search all",
"text": "Bilibili App Search All",
"link": "/model-api-reference/platform-apis/bilibili/app/search-all"
},
{
"text": "search by type",
"text": "Bilibili Hot Searches",
"link": "/model-api-reference/platform-apis/bilibili/web/hot-search"
},
{
"text": "Bilibili Search by Type",
"link": "/model-api-reference/platform-apis/bilibili/app/search-by-type"
},
{
"text": "Bilibili Web General Search",
"link": "/model-api-reference/platform-apis/bilibili/web/general-search"
}
]
},
Expand All @@ -39,20 +39,16 @@ export default {
"label": "Comments & Engagement",
"operations": [
{
"text": "Get comments on the specified video",
"link": "/model-api-reference/platform-apis/bilibili/web/video-comments"
},
{
"text": "Get reply detail",
"link": "/model-api-reference/platform-apis/bilibili/app/reply-detail"
},
{
"text": "Get reply to the specified comment",
"text": "Bilibili Comment Replies",
"link": "/model-api-reference/platform-apis/bilibili/web/comment-reply"
},
{
"text": "Get video comments",
"text": "Bilibili Video Comments (App)",
"link": "/model-api-reference/platform-apis/bilibili/app/video-comments"
},
{
"text": "Bilibili Video Comments (Web)",
"link": "/model-api-reference/platform-apis/bilibili/web/video-comments"
}
]
},
Expand All @@ -61,20 +57,16 @@ export default {
"label": "Live",
"operations": [
{
"text": "Get a list of all live areas",
"link": "/model-api-reference/platform-apis/bilibili/web/all-live-areas"
},
{
"text": "Get information of specified live room",
"text": "Bilibili Live Room Details",
"link": "/model-api-reference/platform-apis/bilibili/web/live-room-detail"
},
{
"text": "Get live streamers of specified live area",
"link": "/model-api-reference/platform-apis/bilibili/web/live-streamers"
"text": "Bilibili Room Stream Data",
"link": "/model-api-reference/platform-apis/bilibili/web/live-videos"
},
{
"text": "Get live video data of specified room",
"link": "/model-api-reference/platform-apis/bilibili/web/live-videos"
"text": "Bilibili Streaming Areas",
"link": "/model-api-reference/platform-apis/bilibili/web/all-live-areas"
}
]
},
Expand All @@ -83,64 +75,60 @@ export default {
"label": "Content & Video",
"operations": [
{
"text": "Get comprehensive popular video information",
"link": "/model-api-reference/platform-apis/bilibili/web/com-popular"
},
{
"text": "Get single video data",
"text": "Bilibili App Single Video Details",
"link": "/model-api-reference/platform-apis/bilibili/app/one-video"
},
{
"text": "Get single video data",
"link": "/model-api-reference/platform-apis/bilibili/web/one-video"
},
{
"text": "Get single video data V2",
"link": "/model-api-reference/platform-apis/bilibili/web/one-video-v2"
"text": "Bilibili Comprehensive Popular Videos",
"link": "/model-api-reference/platform-apis/bilibili/web/com-popular"
},
{
"text": "Get single video data V3",
"text": "Bilibili Single Video Details",
"link": "/model-api-reference/platform-apis/bilibili/web/one-video-v3"
},
{
"text": "Get single video detail",
"link": "/model-api-reference/platform-apis/bilibili/web/video-detail"
"text": "Bilibili Single Video Play Info",
"link": "/model-api-reference/platform-apis/bilibili/web/video-play-info"
},
{
"text": "Get single video play info",
"link": "/model-api-reference/platform-apis/bilibili/web/video-play-info"
"text": "Bilibili User Collection Folder Videos",
"link": "/model-api-reference/platform-apis/bilibili/web/user-collection-videos"
},
{
"text": "Get user homepage video data",
"text": "Bilibili User Post Videos",
"link": "/model-api-reference/platform-apis/bilibili/web/user-post-videos"
},
{
"text": "Get user videos",
"text": "Bilibili User Videos",
"link": "/model-api-reference/platform-apis/bilibili/app/user-videos"
},
{
"text": "Get Video Danmaku",
"text": "Bilibili Video Danmaku",
"link": "/model-api-reference/platform-apis/bilibili/web/video-danmaku"
},
{
"text": "Get Video Parts By bvid",
"text": "Bilibili Video Details",
"link": "/model-api-reference/platform-apis/bilibili/web/one-video"
},
{
"text": "Bilibili Video Details (V2)",
"link": "/model-api-reference/platform-apis/bilibili/web/one-video-v2"
},
{
"text": "Bilibili Video Parts",
"link": "/model-api-reference/platform-apis/bilibili/web/video-parts"
},
{
"text": "Get video playurl",
"text": "Bilibili Video Playback URL",
"link": "/model-api-reference/platform-apis/bilibili/web/video-playurl"
},
{
"text": "Get video subtitle info",
"text": "Bilibili Video Subtitle Details",
"link": "/model-api-reference/platform-apis/bilibili/web/video-subtitle"
},
{
"text": "Get VIP video playurl",
"link": "/model-api-reference/platform-apis/bilibili/web/vip-video-playurl"
},
{
"text": "Gets video data from a collection folder",
"link": "/model-api-reference/platform-apis/bilibili/web/user-collection-videos"
"text": "Bilibili Web Video Details",
"link": "/model-api-reference/platform-apis/bilibili/web/video-detail"
}
]
},
Expand All @@ -149,63 +137,57 @@ export default {
"label": "Users & Accounts",
"operations": [
{
"text": "Extract user ID",
"link": "/model-api-reference/platform-apis/bilibili/web/get-user-id"
"text": "Bilibili App User Info",
"link": "/model-api-reference/platform-apis/bilibili/app/user-info"
},
{
"text": "Get dynamic information of specified user",
"link": "/model-api-reference/platform-apis/bilibili/web/user-dynamic"
"text": "Bilibili Creator View and Like Statistics",
"link": "/model-api-reference/platform-apis/bilibili/web/user-up-stat"
},
{
"text": "Get information of specified user",
"link": "/model-api-reference/platform-apis/bilibili/web/user-profile"
"text": "Bilibili User Collection Folders",
"link": "/model-api-reference/platform-apis/bilibili/web/collect-folders"
},
{
"text": "Get UP stat (total views and likes)",
"link": "/model-api-reference/platform-apis/bilibili/web/user-up-stat"
"text": "Bilibili User Dynamics",
"link": "/model-api-reference/platform-apis/bilibili/web/user-dynamic"
},
{
"text": "Get user collection folders",
"link": "/model-api-reference/platform-apis/bilibili/web/collect-folders"
"text": "Bilibili User ID Extraction",
"link": "/model-api-reference/platform-apis/bilibili/web/get-user-id"
},
{
"text": "Get user info",
"link": "/model-api-reference/platform-apis/bilibili/app/user-info"
"text": "Bilibili User Profile",
"link": "/model-api-reference/platform-apis/bilibili/web/user-profile"
},
{
"text": "Get user relation stat (following and followers)",
"text": "Bilibili User Relation Statistics",
"link": "/model-api-reference/platform-apis/bilibili/web/user-relation-stat"
}
]
},
{
"key": "utilities",
"label": "Utilities",
"operations": [
{
"text": "Generate aid by bvid",
"link": "/model-api-reference/platform-apis/bilibili/web/bv-to-aid"
}
]
},
{
"key": "other",
"label": "Other",
"operations": [
{
"text": "Get bangumi tab",
"text": "Bilibili App Bangumi Tab",
"link": "/model-api-reference/platform-apis/bilibili/app/bangumi-tab"
},
{
"text": "Get cinema tab",
"text": "Bilibili App Cinema Tab",
"link": "/model-api-reference/platform-apis/bilibili/app/cinema-tab"
},
{
"text": "Get dynamic detail",
"text": "Bilibili BV to AID Converter",
"link": "/model-api-reference/platform-apis/bilibili/web/bv-to-aid"
},
{
"text": "Bilibili Dynamic Detail",
"link": "/model-api-reference/platform-apis/bilibili/web/dynamic-detail"
},
{
"text": "Get dynamic detail v2",
"text": "Bilibili Dynamic Details (V2)",
"link": "/model-api-reference/platform-apis/bilibili/web/dynamic-detail-v2"
}
]
Expand Down
2 changes: 1 addition & 1 deletion .vitepress/theme/platform-api-sidebars/cloudsway.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export default {
"label": "Search & Discovery",
"operations": [
{
"text": "Cloudsway Search",
"text": "Cloudsway Web Search",
"link": "/model-api-reference/platform-apis/cloudsway/search"
}
]
Expand Down
Loading
Loading