Skip to content

docs(agents): rewrite Agents docs for the new agents service #33

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
sam2tom merged 1 commit into from
Oct 7, 2026
Merged

docs(agents): rewrite Agents docs for the new agents service #33

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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions .vitepress/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -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(/^\//, '')))
Expand All @@ -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' }],
Expand Down
104 changes: 62 additions & 42 deletions .vitepress/sidebar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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' },
],
},
{
Expand Down Expand Up @@ -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' },
],
},
{
Expand All @@ -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' },
],
},
{
Expand All @@ -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' },
],
},
{
Expand Down
28 changes: 14 additions & 14 deletions .vitepress/theme/HomePage.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<span class="map-index">01</span>
<div>
<strong>Use in my AI tool</strong>
<p>Choose Models, APIs, or published Agents. Run setup once. Use them in Codex, Claude, Cursor, or Kiro.</p>
<p>Choose Models, APIs, or Agent Services. Run setup once. Use them in Codex, Claude, Cursor, or Kiro.</p>
</div>
</div>
<div class="map-row">
Expand All @@ -31,7 +31,7 @@
<span class="map-index">03</span>
<div>
<strong>Build an Agent</strong>
<p>Define the Agent, test runs, then publish it for API access or schedule it.</p>
<p>Define the Agent, test it in a Session, then deploy it as a Service or Schedule.</p>
</div>
</div>
</div>
Expand Down Expand Up @@ -86,7 +86,7 @@
<a href="https://www.sandbase.ai/console/setup" target="_self" class="choose-card featured">
<div class="choose-card-icon">01</div>
<h3>Setup</h3>
<p>Add Models, APIs, and published Agents to the AI app you already use.</p>
<p>Add Models, APIs, and Agent Services to the AI app you already use.</p>
<ul class="choose-card-links">
<li>Choose tools</li>
<li>Run one setup command</li>
Expand All @@ -106,10 +106,10 @@
<a href="/docs/agents/" class="choose-card">
<div class="choose-card-icon">03</div>
<h3>Build an Agent</h3>
<p>Turn instructions, Models, APIs, and Skills into repeatable work.</p>
<p>Turn instructions, Models, Skills, and MCP tools into repeatable work.</p>
<ul class="choose-card-links">
<li>Define and test</li>
<li>Publish as an API</li>
<li>Deploy as a Service</li>
<li>Schedule recurring runs</li>
</ul>
</a>
Expand All @@ -120,7 +120,7 @@
<section class="journey-section">
<p class="section-label">CONSOLE FLOW</p>
<h2 class="section-title">Build the Agent first. Connect it when it is ready.</h2>
<p class="section-desc">Agents are where you define and test the work. Published Agents and Schedules are ways to make that work usable outside the builder.</p>
<p class="section-desc">Agents are where you define and test the work. Services and Schedules run a pinned Agent version outside the builder, and every Run is recorded as a Session.</p>

<div class="journey-steps">
<div class="journey-step">
Expand All @@ -132,17 +132,17 @@
</div>
</div>
<div class="journey-step">
<div><span class="step-num">2</span><h4>Publish Agent</h4></div>
<div><span class="step-num">2</span><h4>Deploy as a Service</h4></div>
<div class="step-links">
<a href="https://www.sandbase.ai/console/endpoints" target="_self">Services</a>
<a href="/docs/api-reference/endpoints/">Services API</a>
<a href="/docs/api-reference/services/">Services API</a>
</div>
</div>
<div class="journey-step">
<div><span class="step-num">3</span><h4>Schedule Agent</h4></div>
<div class="step-links">
<a href="https://www.sandbase.ai/console/deployments" target="_self">Schedules</a>
<a href="/docs/api-reference/deployments/">Schedule docs</a>
<a href="/docs/api-reference/schedules/">Schedules API</a>
<a href="https://www.sandbase.ai/console/runs" target="_self">Runs</a>
</div>
</div>
Expand All @@ -169,16 +169,16 @@
<code>/v1/models · /v1/chat/completions</code>
<p>List models, inspect pricing and capabilities, and call them directly.</p>
</a>
<a href="/docs/api-reference/endpoints/" class="model-card">
<a href="/docs/api-reference/services/" class="model-card">
<span class="model-badge">SERVICES</span>
<h3>Services</h3>
<code>/v1/endpoints</code>
<p>Publish a tested Agent so apps and API clients can invoke it.</p>
<code>/v1/services</code>
<p>Deploy a tested Agent version so apps and API clients can invoke it and track each Run.</p>
</a>
<a href="/docs/api-reference/deployments/" class="model-card">
<a href="/docs/api-reference/schedules/" class="model-card">
<span class="model-badge">SCHEDULES</span>
<h3>Schedules</h3>
<code>/v1/deployments</code>
<code>/v1/schedules</code>
<p>Run an existing Agent on a recurring schedule and review each result.</p>
</a>
</div>
Expand Down
4 changes: 2 additions & 2 deletions .vitepress/theme/SiteFooter.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ const footerSections = [
title: 'Build',
links: [
{ href: `${SITE}/console/agents`, label: 'Build Agent' },
{ href: `${SITE}/console/endpoints`, label: 'Published Agents' },
{ href: `${SITE}/console/endpoints`, label: 'Services' },
{ href: `${SITE}/console/deployments`, label: 'Schedules' },
{ href: `${SITE}/console/sessions`, label: 'Runs' },
{ href: `${SITE}/console/sessions`, label: 'Sessions' },
],
},
{
Expand Down
Loading
Loading