From 1f63ac0cd8c383fc04932573ba18c25c03d6fa22 Mon Sep 17 00:00:00 2001 From: sam Date: Wed, 7 Oct 2026 09:44:23 +0800 Subject: [PATCH] docs(agents): rewrite Agents docs for the new agents service Rewrite Agents guides, API reference and OpenAPI against sandbase-agents on main; add Services, Schedules, MCP Connections, Secrets, Session turns/items/files and Skill versions; add an OpenAI SDK compatibility page verified against the test environment; archive retired Deployments, Embeds, Endpoints and Environments pages. --- .vitepress/config.ts | 11 +- .vitepress/sidebar.ts | 104 +- .vitepress/theme/HomePage.vue | 28 +- .vitepress/theme/SiteFooter.vue | 4 +- .../theme/generatedApiReferenceSpecs.ts | 1443 +---- .../api-reference}/deployments/archive.md | 0 .../api-reference}/deployments/create.md | 0 .../api-reference}/deployments/delete.md | 0 .../deployments/get-global-run.md | 0 .../api-reference}/deployments/get-run.md | 0 .../api-reference}/deployments/get.md | 0 .../deployments/list-all-runs.md | 0 .../api-reference}/deployments/list-runs.md | 0 .../api-reference}/deployments/list.md | 0 .../api-reference}/deployments/pause.md | 0 .../api-reference}/deployments/run.md | 0 .../deployments/test-feishu-notification.md | 0 .../api-reference}/deployments/unpause.md | 0 .../api-reference}/deployments/update.md | 0 .../api-reference}/embeds/create.md | 0 .../api-reference}/embeds/delete.md | 0 .../api-reference}/embeds/get.md | 0 .../api-reference}/embeds/index.md | 0 .../api-reference}/embeds/list.md | 0 .../api-reference}/embeds/update.md | 0 .../api-reference}/embeds/usage.md | 0 .../api-reference}/endpoints/acp.md | 0 .../api-reference}/endpoints/mcp.md | 0 .../api-reference}/environments/index.md | 0 .../guides}/site-agent-integration.md | 0 {use-cases => _archived/use-cases}/index.md | 0 .../use-cases}/site-agent-copilot.md | 0 agents/agent-api.md | 106 +- agents/api-credentials.md | 65 +- agents/deployments.md | 12 +- agents/index.md | 84 +- agents/mcp-tools.md | 106 +- agents/openai-compatibility.md | 269 + agents/schedules.md | 73 +- agents/services.md | 69 +- agents/sessions.md | 136 +- api-reference/agents/archive.md | 124 +- api-reference/agents/catalog.md | 47 + api-reference/agents/create.md | 260 +- api-reference/agents/delete.md | 74 + api-reference/agents/get-version.md | 75 +- api-reference/agents/get.md | 147 +- api-reference/agents/index.md | 52 +- api-reference/agents/list.md | 151 +- api-reference/agents/replace.md | 179 + api-reference/agents/restore.md | 128 + api-reference/agents/unarchive.md | 121 + api-reference/agents/update.md | 200 +- api-reference/agents/versions.md | 95 +- api-reference/authentication.md | 20 +- api-reference/credentials/index.md | 88 +- api-reference/deployments/index.md | 73 +- api-reference/endpoints/index.md | 161 +- api-reference/errors.md | 34 +- api-reference/index.md | 46 +- api-reference/mcp-connections/index.md | 88 + api-reference/schedules/create.md | 144 + api-reference/schedules/get.md | 77 + api-reference/schedules/index.md | 65 + api-reference/schedules/lifecycle.md | 94 + api-reference/schedules/list.md | 99 + api-reference/schedules/run.md | 101 + api-reference/schedules/runs.md | 111 + api-reference/schedules/timing.md | 114 + api-reference/schedules/update.md | 118 + api-reference/secrets/index.md | 77 + api-reference/services/create.md | 119 + api-reference/services/get.md | 72 + api-reference/services/index.md | 67 + api-reference/services/invoke.md | 107 + api-reference/services/lifecycle.md | 90 + api-reference/services/list.md | 94 + api-reference/services/runs.md | 110 + api-reference/services/update.md | 113 + api-reference/sessions/archive.md | 119 +- api-reference/sessions/cancel.md | 77 + api-reference/sessions/create.md | 197 +- api-reference/sessions/delete-file.md | 67 + api-reference/sessions/delete.md | 59 +- api-reference/sessions/download-file.md | 62 + api-reference/sessions/get-turn.md | 70 + api-reference/sessions/get.md | 146 +- api-reference/sessions/index.md | 100 +- api-reference/sessions/items.md | 83 + api-reference/sessions/list-events.md | 9 - api-reference/sessions/list-files.md | 88 + api-reference/sessions/list.md | 138 +- api-reference/sessions/reconnect.md | 109 + api-reference/sessions/rename.md | 129 + api-reference/sessions/send-events.md | 148 +- api-reference/sessions/stream-snapshot.md | 68 + api-reference/sessions/stream.md | 79 +- api-reference/sessions/turns.md | 83 + api-reference/sessions/unarchive.md | 122 + api-reference/sessions/update.md | 132 +- api-reference/sessions/upload-file.md | 93 + api-reference/skills/catalog.md | 91 + api-reference/skills/create.md | 99 +- api-reference/skills/delete.md | 70 +- api-reference/skills/get.md | 80 +- api-reference/skills/index.md | 239 +- api-reference/skills/list.md | 98 +- api-reference/skills/update.md | 110 +- api-reference/skills/versions.md | 114 + api-reference/webhooks.md | 2 +- faq.md | 16 +- for-agents/errors.md | 35 +- for-agents/full.md | 327 +- for-agents/index.md | 17 +- getting-started/api-keys.md | 5 +- getting-started/index.md | 8 +- getting-started/quickstart-cn.md | 6 +- getting-started/quickstart.md | 8 +- index.md | 14 +- models/index.md | 2 +- public/llms-full.txt | 126 +- public/llms.txt | 41 +- public/openapi.yaml | 5722 +++++++++-------- sandbox/index.md | 4 + scripts/validate-ai-readable.mjs | 13 + scripts/validate-api-reference-contract.mjs | 6 +- scripts/validate-built-public-surface.mjs | 11 +- scripts/validate-doc-content.mjs | 22 +- scripts/validate-http-references.mjs | 7 - scripts/validate-public-api-surface.mjs | 644 +- scripts/validate-seo.mjs | 3 - store/agents.md | 20 +- store/apis.md | 9 +- store/index.md | 21 +- 134 files changed, 10407 insertions(+), 6206 deletions(-) rename {api-reference => _archived/api-reference}/deployments/archive.md (100%) rename {api-reference => _archived/api-reference}/deployments/create.md (100%) rename {api-reference => _archived/api-reference}/deployments/delete.md (100%) rename {api-reference => _archived/api-reference}/deployments/get-global-run.md (100%) rename {api-reference => _archived/api-reference}/deployments/get-run.md (100%) rename {api-reference => _archived/api-reference}/deployments/get.md (100%) rename {api-reference => _archived/api-reference}/deployments/list-all-runs.md (100%) rename {api-reference => _archived/api-reference}/deployments/list-runs.md (100%) rename {api-reference => _archived/api-reference}/deployments/list.md (100%) rename {api-reference => _archived/api-reference}/deployments/pause.md (100%) rename {api-reference => _archived/api-reference}/deployments/run.md (100%) rename {api-reference => _archived/api-reference}/deployments/test-feishu-notification.md (100%) rename {api-reference => _archived/api-reference}/deployments/unpause.md (100%) rename {api-reference => _archived/api-reference}/deployments/update.md (100%) rename {api-reference => _archived/api-reference}/embeds/create.md (100%) rename {api-reference => _archived/api-reference}/embeds/delete.md (100%) rename {api-reference => _archived/api-reference}/embeds/get.md (100%) rename {api-reference => _archived/api-reference}/embeds/index.md (100%) rename {api-reference => _archived/api-reference}/embeds/list.md (100%) rename {api-reference => _archived/api-reference}/embeds/update.md (100%) rename {api-reference => _archived/api-reference}/embeds/usage.md (100%) rename {api-reference => _archived/api-reference}/endpoints/acp.md (100%) rename {api-reference => _archived/api-reference}/endpoints/mcp.md (100%) rename {api-reference => _archived/api-reference}/environments/index.md (100%) rename {guides => _archived/guides}/site-agent-integration.md (100%) rename {use-cases => _archived/use-cases}/index.md (100%) rename {use-cases => _archived/use-cases}/site-agent-copilot.md (100%) create mode 100644 agents/openai-compatibility.md create mode 100644 api-reference/agents/catalog.md create mode 100644 api-reference/agents/delete.md create mode 100644 api-reference/agents/replace.md create mode 100644 api-reference/agents/restore.md create mode 100644 api-reference/agents/unarchive.md create mode 100644 api-reference/mcp-connections/index.md create mode 100644 api-reference/schedules/create.md create mode 100644 api-reference/schedules/get.md create mode 100644 api-reference/schedules/index.md create mode 100644 api-reference/schedules/lifecycle.md create mode 100644 api-reference/schedules/list.md create mode 100644 api-reference/schedules/run.md create mode 100644 api-reference/schedules/runs.md create mode 100644 api-reference/schedules/timing.md create mode 100644 api-reference/schedules/update.md create mode 100644 api-reference/secrets/index.md create mode 100644 api-reference/services/create.md create mode 100644 api-reference/services/get.md create mode 100644 api-reference/services/index.md create mode 100644 api-reference/services/invoke.md create mode 100644 api-reference/services/lifecycle.md create mode 100644 api-reference/services/list.md create mode 100644 api-reference/services/runs.md create mode 100644 api-reference/services/update.md create mode 100644 api-reference/sessions/cancel.md create mode 100644 api-reference/sessions/delete-file.md create mode 100644 api-reference/sessions/download-file.md create mode 100644 api-reference/sessions/get-turn.md create mode 100644 api-reference/sessions/items.md delete mode 100644 api-reference/sessions/list-events.md create mode 100644 api-reference/sessions/list-files.md create mode 100644 api-reference/sessions/reconnect.md create mode 100644 api-reference/sessions/rename.md create mode 100644 api-reference/sessions/stream-snapshot.md create mode 100644 api-reference/sessions/turns.md create mode 100644 api-reference/sessions/unarchive.md create mode 100644 api-reference/sessions/upload-file.md create mode 100644 api-reference/skills/catalog.md create mode 100644 api-reference/skills/versions.md diff --git a/.vitepress/config.ts b/.vitepress/config.ts index 29042de2..99be4071 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -244,13 +244,9 @@ export default defineConfig({ 'README.md', 'CONTRIBUTING.md', 'DEPLOYMENT.md', + // Retired Embed, Environment, Endpoint, Deployment, and Site Agent pages live here. '_archived/**', - // This legacy guide uses dashboard-only /default/v1 routes and an unpublished embed API. - 'guides/site-agent-integration.md', - 'use-cases/**', 'api-reference/webhooks.md', - 'api-reference/embeds/**', - 'api-reference/environments/**', 'agents/endpoint-quickstart.md', 'admin/api-keys.md', 'setup/cli.md', @@ -284,6 +280,9 @@ export default defineConfig({ // canonicalized/noindexed in favor of Official Native API. .filter((item) => ![ 'agents/deployments', + 'api-reference/endpoints/', + 'api-reference/deployments/', + 'api-reference/credentials/', 'store/models', 'api-reference/volcengine-contents-generations', ].includes(item.url.replace(/^\//, ''))) @@ -303,7 +302,7 @@ export default defineConfig({ ['link', { rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: '' }], ['link', { rel: 'stylesheet', href: 'https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@400;500&display=swap' }], ['meta', { property: 'og:title', content: 'SandBase Docs - Connect Your Agent to the Real World' }], - ['meta', { property: 'og:description', content: 'Learn how to use Setup, call Models and APIs, build Agents, publish Services, create Schedules, and review Sessions in SandBase.' }], + ['meta', { property: 'og:description', content: 'Learn how to use Setup, call Models and APIs, build Agents, deploy Services, create Schedules, and review Sessions in SandBase.' }], ['meta', { property: 'og:type', content: 'website' }], ['meta', { property: 'og:site_name', content: 'SandBase' }], ['meta', { property: 'og:image', content: 'https://www.sandbase.ai/og-default.png' }], diff --git a/.vitepress/sidebar.ts b/.vitepress/sidebar.ts index 5eafafcd..4aa5ba44 100644 --- a/.vitepress/sidebar.ts +++ b/.vitepress/sidebar.ts @@ -79,8 +79,9 @@ export const docsSidebar: DefaultTheme.SidebarItem[] = [ items: [ { text: 'Overview', link: '/agents/' }, { text: 'Define agent', link: '/agents/agent-api' }, - { text: 'Tools & credentials', link: '/agents/mcp-tools' }, - { text: 'Credentials for tools', link: '/agents/api-credentials' }, + { text: 'Skills & MCP tools', link: '/agents/mcp-tools' }, + { text: 'MCP credentials', link: '/agents/api-credentials' }, + { text: 'OpenAI compatibility', link: '/agents/openai-compatibility' }, ], }, { @@ -123,9 +124,14 @@ export const apiReferenceSidebar: DefaultTheme.SidebarItem[] = [ { text: 'List Agents', link: '/api-reference/agents/list' }, { text: 'Get Agent', link: '/api-reference/agents/get' }, { text: 'Update Agent', link: '/api-reference/agents/update' }, + { text: 'Replace Agent (CAS)', link: '/api-reference/agents/replace' }, + { text: 'Delete Agent', link: '/api-reference/agents/delete' }, { text: 'Archive Agent', link: '/api-reference/agents/archive' }, + { text: 'Unarchive Agent', link: '/api-reference/agents/unarchive' }, + { text: 'Restore Agent Version', link: '/api-reference/agents/restore' }, { text: 'List Agent Versions', link: '/api-reference/agents/versions' }, { text: 'Get Agent Version', link: '/api-reference/agents/get-version' }, + { text: 'Agent Catalog', link: '/api-reference/agents/catalog' }, ], }, { @@ -136,54 +142,53 @@ export const apiReferenceSidebar: DefaultTheme.SidebarItem[] = [ { text: 'Create Session', link: '/api-reference/sessions/create' }, { text: 'List Sessions', link: '/api-reference/sessions/list' }, { text: 'Get Session', link: '/api-reference/sessions/get' }, - { text: 'Update Session', link: '/api-reference/sessions/update' }, + { text: 'Update Metadata', link: '/api-reference/sessions/update' }, + { text: 'Rename Session', link: '/api-reference/sessions/rename' }, { text: 'Delete Session', link: '/api-reference/sessions/delete' }, - { text: 'Send Events', link: '/api-reference/sessions/send-events' }, + { text: 'Send Input', link: '/api-reference/sessions/send-events' }, { text: 'Stream Events', link: '/api-reference/sessions/stream' }, - { text: 'List Events', link: '/api-reference/sessions/list-events' }, + { text: 'List Items', link: '/api-reference/sessions/items' }, + { text: 'List Turns', link: '/api-reference/sessions/turns' }, + { text: 'Get Turn', link: '/api-reference/sessions/get-turn' }, + { text: 'Cancel Turn', link: '/api-reference/sessions/cancel' }, { text: 'Archive Session', link: '/api-reference/sessions/archive' }, + { text: 'Unarchive Session', link: '/api-reference/sessions/unarchive' }, + { text: 'Reconnect', link: '/api-reference/sessions/reconnect' }, + { text: 'Snapshot Stream', link: '/api-reference/sessions/stream-snapshot' }, + { text: 'Upload File', link: '/api-reference/sessions/upload-file' }, + { text: 'List Files', link: '/api-reference/sessions/list-files' }, + { text: 'Download File', link: '/api-reference/sessions/download-file' }, + { text: 'Delete File', link: '/api-reference/sessions/delete-file' }, ], }, { text: 'Services', collapsed: true, items: [ - { text: 'Overview', link: '/api-reference/endpoints/' }, - { text: 'Create Service', link: '/api-reference/endpoints/#create-a-service' }, - { text: 'List Services', link: '/api-reference/endpoints/#list-services' }, - { text: 'Get Service', link: '/api-reference/endpoints/#get-a-service' }, - { text: 'Update Service', link: '/api-reference/endpoints/#update-a-service' }, - { text: 'Delete Service', link: '/api-reference/endpoints/#delete-a-service' }, - { text: 'Invoke with REST', link: '/api-reference/endpoints/#invoke-with-rest' }, - { text: 'Invoke through MCP', link: '/api-reference/endpoints/mcp' }, - { text: 'Invoke with ACP', link: '/api-reference/endpoints/acp' }, + { text: 'Overview', link: '/api-reference/services/' }, + { text: 'Create Service', link: '/api-reference/services/create' }, + { text: 'List Services', link: '/api-reference/services/list' }, + { text: 'Get Service', link: '/api-reference/services/get' }, + { text: 'Update Service', link: '/api-reference/services/update' }, + { text: 'Pause, Resume, Archive', link: '/api-reference/services/lifecycle' }, + { text: 'Invoke Service', link: '/api-reference/services/invoke' }, + { text: 'Runs', link: '/api-reference/services/runs' }, + { text: 'Notifications', link: '/api-reference/services/#notifications' }, ], }, { text: 'Schedules', collapsed: true, items: [ - { text: 'Overview', link: '/api-reference/deployments/' }, - { text: 'Create Schedule', link: '/api-reference/deployments/create' }, - { text: 'List Schedules', link: '/api-reference/deployments/list' }, - { text: 'Get Schedule', link: '/api-reference/deployments/get' }, - { text: 'Update Schedule', link: '/api-reference/deployments/update' }, - { text: 'Delete Schedule', link: '/api-reference/deployments/delete' }, - { text: 'Archive Schedule', link: '/api-reference/deployments/archive' }, - { text: 'Pause Schedule', link: '/api-reference/deployments/pause' }, - { text: 'Resume Schedule', link: '/api-reference/deployments/unpause' }, - { text: 'Test Feishu Notification', link: '/api-reference/deployments/test-feishu-notification' }, - { - text: 'Schedule runs', - collapsed: true, - items: [ - { text: 'Trigger Schedule', link: '/api-reference/deployments/run' }, - { text: 'List Runs for Schedule', link: '/api-reference/deployments/list-runs' }, - { text: 'Get Run for Schedule', link: '/api-reference/deployments/get-run' }, - { text: 'List All Schedule Runs', link: '/api-reference/deployments/list-all-runs' }, - { text: 'Get Schedule Run by ID', link: '/api-reference/deployments/get-global-run' }, - ], - }, + { text: 'Overview', link: '/api-reference/schedules/' }, + { text: 'Create Schedule', link: '/api-reference/schedules/create' }, + { text: 'List Schedules', link: '/api-reference/schedules/list' }, + { text: 'Get Schedule', link: '/api-reference/schedules/get' }, + { text: 'Update Schedule', link: '/api-reference/schedules/update' }, + { text: 'Update Timing', link: '/api-reference/schedules/timing' }, + { text: 'Pause, Resume, Archive', link: '/api-reference/schedules/lifecycle' }, + { text: 'Trigger Run', link: '/api-reference/schedules/run' }, + { text: 'Runs', link: '/api-reference/schedules/runs' }, ], }, { @@ -196,18 +201,33 @@ export const apiReferenceSidebar: DefaultTheme.SidebarItem[] = [ { text: 'Get Skill', link: '/api-reference/skills/get' }, { text: 'Update Skill', link: '/api-reference/skills/update' }, { text: 'Delete Skill', link: '/api-reference/skills/delete' }, + { text: 'Skill Versions', link: '/api-reference/skills/versions' }, + { text: 'Skill Catalog', link: '/api-reference/skills/catalog' }, ], }, { - text: 'Credentials', + text: 'MCP Connections', collapsed: true, items: [ - { text: 'Overview', link: '/api-reference/credentials/' }, - { text: 'Create Credential', link: '/api-reference/credentials/#create-a-credential' }, - { text: 'List Credentials', link: '/api-reference/credentials/#list-credentials' }, - { text: 'Get Credential', link: '/api-reference/credentials/#get-a-credential' }, - { text: 'Update Credential', link: '/api-reference/credentials/#update-a-credential' }, - { text: 'Rotate Credential', link: '/api-reference/credentials/#rotate-a-credential' }, + { text: 'Overview', link: '/api-reference/mcp-connections/' }, + { text: 'Create Connection', link: '/api-reference/mcp-connections/#create-a-connection' }, + { text: 'List Connections', link: '/api-reference/mcp-connections/#list-connections' }, + { text: 'Get Connection', link: '/api-reference/mcp-connections/#get-a-connection' }, + { text: 'Replace Connection', link: '/api-reference/mcp-connections/#replace-a-connection' }, + { text: 'Enable Connection', link: '/api-reference/mcp-connections/#enable-a-connection' }, + { text: 'Disable Connection', link: '/api-reference/mcp-connections/#disable-a-connection' }, + ], + }, + { + text: 'Secrets', + collapsed: true, + items: [ + { text: 'Overview', link: '/api-reference/secrets/' }, + { text: 'Create Secret', link: '/api-reference/secrets/#create-a-secret' }, + { text: 'List Secrets', link: '/api-reference/secrets/#list-secrets' }, + { text: 'Get Secret', link: '/api-reference/secrets/#get-a-secret' }, + { text: 'Rotate Secret', link: '/api-reference/secrets/#rotate-a-secret' }, + { text: 'Revoke Secret', link: '/api-reference/secrets/#revoke-a-secret' }, ], }, { diff --git a/.vitepress/theme/HomePage.vue b/.vitepress/theme/HomePage.vue index 5b06b0bc..bcea924f 100644 --- a/.vitepress/theme/HomePage.vue +++ b/.vitepress/theme/HomePage.vue @@ -17,7 +17,7 @@ 01
Use in my AI tool -

Choose Models, APIs, or published Agents. Run setup once. Use them in Codex, Claude, Cursor, or Kiro.

+

Choose Models, APIs, or Agent Services. Run setup once. Use them in Codex, Claude, Cursor, or Kiro.

@@ -31,7 +31,7 @@ 03
Build an Agent -

Define the Agent, test runs, then publish it for API access or schedule it.

+

Define the Agent, test it in a Session, then deploy it as a Service or Schedule.

@@ -86,7 +86,7 @@
01

Setup

-

Add Models, APIs, and published Agents to the AI app you already use.

+

Add Models, APIs, and Agent Services to the AI app you already use.