# Shinzo Platform

## Docs

- [Agent Configuration](https://docs.shinzo.ai/agents/configuration.md): Learn how to configure and deploy AI agents on the Shinzo Platform.
- [Filesystem Management](https://docs.shinzo.ai/agents/filesystem.md): Manage files and directories in agent workspaces programmatically.
- [MCP Server Management](https://docs.shinzo.ai/agents/mcp-management.md): Register, configure, and manage remote MCP servers for your AI agents.
- [Agent Messaging & Channels](https://docs.shinzo.ai/agents/messaging.md): Send messages to agents, manage conversations, and connect channels like Discord.
- [Agent Schedules & Triggers](https://docs.shinzo.ai/agents/schedules-triggers.md): Automate agent workflows with cron schedules and webhook triggers.
- [Anthropic SDK](https://docs.shinzo.ai/ai-tools/anthropic-sdk.md): Configure Shinzo analytics and observability for the Anthropic SDK to track AI usage, conversations, tool calls, performance, and costs in your applications.
- [Claude Code](https://docs.shinzo.ai/ai-tools/claude-code.md): Configure Shinzo analytics and observability for Claude Code to track AI usage, conversations, tool calls, performance, and costs.
- [Agent Channels Overview](https://docs.shinzo.ai/api/agents/channels-overview.md): Manage channel integrations for agent messaging.
- [Create Agent](https://docs.shinzo.ai/api/agents/create.md): Deploy a new AI agent on the Shinzo Platform.
- [Delete Agent](https://docs.shinzo.ai/api/agents/delete.md): Permanently delete an agent and all associated data.
- [Create Discord Link Code](https://docs.shinzo.ai/api/agents/discord-link.md): Generate a code to pair a Discord account with an agent.
- [Get Discord Status](https://docs.shinzo.ai/api/agents/discord-status.md): Check if a Discord account is linked to an agent.
- [Unlink Discord](https://docs.shinzo.ai/api/agents/discord-unlink.md): Remove a Discord channel binding from an agent.
- [Agent Filesystem Overview](https://docs.shinzo.ai/api/agents/filesystem-overview.md): Programmatic access to agent workspace files and directories.
- [Copy Files](https://docs.shinzo.ai/api/agents/filesystem/copy.md): Copy files or directories within an agent's workspace.
- [Create Archive](https://docs.shinzo.ai/api/agents/filesystem/create-archive.md): Create a compressed archive from files in an agent's workspace.
- [Create Directory](https://docs.shinzo.ai/api/agents/filesystem/create-directory.md): Create a new directory in an agent's workspace.
- [Create File](https://docs.shinzo.ai/api/agents/filesystem/create-file.md): Create a new file in an agent's workspace.
- [Delete Directory](https://docs.shinzo.ai/api/agents/filesystem/delete-directory.md): Delete a directory from an agent's workspace.
- [Delete File](https://docs.shinzo.ai/api/agents/filesystem/delete-file.md): Delete a file from an agent's workspace.
- [Extract Archive](https://docs.shinzo.ai/api/agents/filesystem/extract-archive.md): Extract a compressed archive in an agent's workspace.
- [Get File Metadata](https://docs.shinzo.ai/api/agents/filesystem/get-metadata.md): Get metadata about a file or directory in an agent's workspace.
- [List Directory](https://docs.shinzo.ai/api/agents/filesystem/list-directory.md): List the contents of a directory in an agent's workspace.
- [Move Files](https://docs.shinzo.ai/api/agents/filesystem/move.md): Move or rename files and directories within an agent's workspace.
- [Patch File](https://docs.shinzo.ai/api/agents/filesystem/patch-file.md): Apply a partial update to a file in an agent's workspace.
- [Read File](https://docs.shinzo.ai/api/agents/filesystem/read-file.md): Read the contents of a file from an agent's workspace.
- [Search Files](https://docs.shinzo.ai/api/agents/filesystem/search.md): Search for files by name or content within an agent's workspace.
- [Update File](https://docs.shinzo.ai/api/agents/filesystem/update-file.md): Replace the contents of an existing file in an agent's workspace.
- [Update File Metadata](https://docs.shinzo.ai/api/agents/filesystem/update-metadata.md): Update metadata for a file in an agent's workspace.
- [Get Agent](https://docs.shinzo.ai/api/agents/get.md): Retrieve detailed information about a specific agent.
- [List Agents](https://docs.shinzo.ai/api/agents/list.md): Retrieve a list of all your AI agents.
- [List Channel Bindings](https://docs.shinzo.ai/api/agents/list-channels.md): List all active channel bindings for an agent.
- [List Messages](https://docs.shinzo.ai/api/agents/list-messages.md): Retrieve messages for an agent with cursor-based pagination.
- [Agent Messaging Overview](https://docs.shinzo.ai/api/agents/messaging-overview.md): Send messages to agents and retrieve conversation history.
- [AI Agents Overview](https://docs.shinzo.ai/api/agents/overview.md): Deploy and manage autonomous AI agents on the Shinzo Platform.
- [Pause Agent](https://docs.shinzo.ai/api/agents/pause.md): Temporarily pause an agent to prevent it from processing new messages.
- [Resume Agent](https://docs.shinzo.ai/api/agents/resume.md): Resume a paused agent to restore message processing.
- [Create Schedule](https://docs.shinzo.ai/api/agents/schedule-create.md): Create a recurring cron schedule for an agent
- [Delete Schedule](https://docs.shinzo.ai/api/agents/schedule-delete.md): Delete a cron schedule
- [List Schedules](https://docs.shinzo.ai/api/agents/schedule-list.md): List all cron schedules for an agent
- [Agent Schedules & Triggers](https://docs.shinzo.ai/api/agents/schedules-triggers-overview.md): Automate agent tasks with recurring cron schedules and event-driven webhook triggers
- [Send Message](https://docs.shinzo.ai/api/agents/send-message.md): Send a message to an agent.
- [Generate Slack Link Code](https://docs.shinzo.ai/api/agents/slack-link.md): Generate a link code to pair a Slack account with an agent.
- [Get Slack Status](https://docs.shinzo.ai/api/agents/slack-status.md): Check if a Slack account is linked to an agent and get binding details.
- [Unlink Slack Account](https://docs.shinzo.ai/api/agents/slack-unlink.md): Remove the Slack account binding from an agent.
- [Create Telegram Link Code](https://docs.shinzo.ai/api/agents/telegram-link.md): Generate a code to pair a Telegram account with an agent.
- [Get Telegram Status](https://docs.shinzo.ai/api/agents/telegram-status.md): Check if a Telegram account is linked to an agent.
- [Unlink Telegram](https://docs.shinzo.ai/api/agents/telegram-unlink.md): Disconnect a Telegram account from an agent.
- [Create Trigger](https://docs.shinzo.ai/api/agents/trigger-create.md): Create a webhook trigger for an agent
- [Delete Trigger](https://docs.shinzo.ai/api/agents/trigger-delete.md): Delete a webhook trigger
- [List Triggers](https://docs.shinzo.ai/api/agents/trigger-list.md): List all webhook triggers for an agent
- [Update Agent](https://docs.shinzo.ai/api/agents/update.md): Update an existing agent's configuration.
- [Get User Quota](https://docs.shinzo.ai/api/auth/fetch-quota.md): Retrieve the authenticated user's usage quota and limits.
- [Get Current User](https://docs.shinzo.ai/api/auth/fetch-user.md): Retrieve the authenticated user's profile information.
- [Login](https://docs.shinzo.ai/api/auth/login.md): Authenticate with email and password to receive a JWT token.
- [GitHub OAuth - Get Authorization URL](https://docs.shinzo.ai/api/auth/oauth-github.md): Get the GitHub OAuth authorization URL to initiate sign-in.
- [GitHub OAuth - Handle Callback](https://docs.shinzo.ai/api/auth/oauth-github-callback.md): Complete GitHub OAuth authentication with the authorization code.
- [Google OAuth - Get Authorization URL](https://docs.shinzo.ai/api/auth/oauth-google.md): Get the Google OAuth authorization URL to initiate sign-in.
- [Google OAuth - Handle Callback](https://docs.shinzo.ai/api/auth/oauth-google-callback.md): Complete Google OAuth authentication with the authorization code.
- [Authentication Overview](https://docs.shinzo.ai/api/auth/overview.md): User registration, login, email verification, and OAuth flows.
- [Register User](https://docs.shinzo.ai/api/auth/register.md): Create a new user account on the Shinzo Platform.
- [Resend Verification Email](https://docs.shinzo.ai/api/auth/resend-verification.md): Request a new email verification link.
- [Verify Email](https://docs.shinzo.ai/api/auth/verify.md): Verify a user's email address using the verification token.
- [Authentication](https://docs.shinzo.ai/api/authentication.md): API authentication methods, token types, and security best practices for the Shinzo Platform API.
- [Health Check](https://docs.shinzo.ai/api/health.md): Verify connectivity and health of the Shinzo Platform API.
- [Create MCP Server](https://docs.shinzo.ai/api/mcp-servers/create.md): Register a new MCP server for use with your agents.
- [Delete MCP Server](https://docs.shinzo.ai/api/mcp-servers/delete.md): Delete an MCP server registration.
- [Get MCP Server](https://docs.shinzo.ai/api/mcp-servers/get.md): Retrieve detailed information about a specific MCP server.
- [Grant Agent Access](https://docs.shinzo.ai/api/mcp-servers/grant-access.md): Grant an agent access to an MCP server's tools.
- [Health Check](https://docs.shinzo.ai/api/mcp-servers/health.md): Check the health and connectivity of an MCP server.
- [List MCP Servers](https://docs.shinzo.ai/api/mcp-servers/list.md): Retrieve all registered MCP servers.
- [List Agent Access](https://docs.shinzo.ai/api/mcp-servers/list-access.md): List all agents that have access to an MCP server.
- [MCP Servers Overview](https://docs.shinzo.ai/api/mcp-servers/overview.md): Register, configure, and manage remote MCP servers for your agents.
- [Refresh Tools](https://docs.shinzo.ai/api/mcp-servers/refresh-tools.md): Refresh the list of available tools from an MCP server.
- [Revoke Agent Access](https://docs.shinzo.ai/api/mcp-servers/revoke-access.md): Revoke an agent's access to an MCP server.
- [Update MCP Server](https://docs.shinzo.ai/api/mcp-servers/update.md): Update an existing MCP server's configuration.
- [API Reference Overview](https://docs.shinzo.ai/api/overview.md): Complete reference for the Shinzo Platform REST API for authentication, telemetry ingestion, AI agents, and analytics.
- [Delete Provider Key](https://docs.shinzo.ai/api/provider-keys/delete.md): Delete a stored AI provider API key.
- [List Provider Keys](https://docs.shinzo.ai/api/provider-keys/list.md): Retrieve all stored AI provider API keys.
- [Provider Keys Overview](https://docs.shinzo.ai/api/provider-keys/overview.md): Manage AI provider API keys for use with Spotlight model proxy.
- [Save Provider Key](https://docs.shinzo.ai/api/provider-keys/save.md): Store an encrypted AI provider API key.
- [Test Provider Key](https://docs.shinzo.ai/api/provider-keys/test.md): Test an AI provider API key without storing it.
- [Update Provider Key](https://docs.shinzo.ai/api/provider-keys/update.md): Update an existing AI provider API key.
- [Count Tokens](https://docs.shinzo.ai/api/spotlight/count-tokens.md): Count tokens for a request without sending it to the model.
- [Create Share Link](https://docs.shinzo.ai/api/spotlight/create-share.md): Create a shareable link for a session.
- [Get Session Details](https://docs.shinzo.ai/api/spotlight/get-session.md): Get detailed information about a specific session including all interactions.
- [Get Share Status](https://docs.shinzo.ai/api/spotlight/get-share-status.md): Check if a session is shared and get the share token.
- [List Sessions](https://docs.shinzo.ai/api/spotlight/list-sessions.md): Get a paginated list of sessions with aggregated metrics.
- [Send Messages](https://docs.shinzo.ai/api/spotlight/messages.md): Proxy requests to Anthropic's Messages API with analytics tracking.
- [Spotlight Overview](https://docs.shinzo.ai/api/spotlight/overview.md): AI model proxy with built-in analytics, token tracking, and session management.
- [Remove Sharing](https://docs.shinzo.ai/api/spotlight/remove-share.md): Remove the shareable link for a session.
- [Token Usage Analytics](https://docs.shinzo.ai/api/spotlight/token-analytics.md): Get aggregated token usage metrics.
- [View Shared Session](https://docs.shinzo.ai/api/spotlight/view-shared.md): View a shared session using the share token. This endpoint is public.
- [Fetch Metrics](https://docs.shinzo.ai/api/telemetry/fetch-metrics.md): Get metrics data with optional filtering.
- [Fetch Resources](https://docs.shinzo.ai/api/telemetry/fetch-resources.md): Get all telemetry resources (services) that have sent data.
- [Fetch Spans](https://docs.shinzo.ai/api/telemetry/fetch-spans.md): Get individual spans with optional filtering.
- [Fetch Traces](https://docs.shinzo.ai/api/telemetry/fetch-traces.md): Get traces with optional filtering.
- [Ingest Metrics](https://docs.shinzo.ai/api/telemetry/ingest-metrics.md): Send OpenTelemetry metrics using OTLP/HTTP protocol
- [Ingest Traces](https://docs.shinzo.ai/api/telemetry/ingest-traces.md): Send OpenTelemetry traces using OTLP/HTTP protocol
- [Telemetry Overview](https://docs.shinzo.ai/api/telemetry/overview.md): Send and retrieve OpenTelemetry data from your MCP servers.
- [Create Platform API Key](https://docs.shinzo.ai/api/tokens/create-platform-key.md): Create a new platform API key for programmatic access.
- [Delete Platform API Key](https://docs.shinzo.ai/api/tokens/delete-platform-key.md): Delete an existing platform API key.
- [Generate Ingest Token](https://docs.shinzo.ai/api/tokens/generate-ingest-token.md): Create a new ingest token for telemetry data ingestion.
- [List Ingest Tokens](https://docs.shinzo.ai/api/tokens/list-ingest-tokens.md): Retrieve all ingest tokens associated with your account.
- [List Platform API Keys](https://docs.shinzo.ai/api/tokens/list-platform-keys.md): Retrieve all platform API keys associated with your account.
- [Tokens Overview](https://docs.shinzo.ai/api/tokens/overview.md): Manage ingest tokens and platform API keys for authentication.
- [Revoke Ingest Token](https://docs.shinzo.ai/api/tokens/revoke-ingest-token.md): Revoke an existing ingest token to prevent further use.
- [Model Context Protocol (MCP)](https://docs.shinzo.ai/concepts/mcp.md): Understanding Model Context Protocol and how the Shinzo Platform is purpose-built for MCP developers.
- [OpenTelemetry Foundation](https://docs.shinzo.ai/concepts/opentelemetry.md): Understanding OpenTelemetry and why it's the foundation of Shinzo's analytics services.
- [Welcome to the Shinzo Platform](https://docs.shinzo.ai/index.md): Easy-to-use, reliable agent infrastructure and observability for developers.
- [Agent Analytics Dashboard](https://docs.shinzo.ai/platform/agent-analytics.md): Explore your AI agent conversations, tool usage, token consumption, and performance metrics in the Shinzo agent analytics dashboard.
- [Analytics Dashboard](https://docs.shinzo.ai/platform/dashboard.md): Overview of the Shinzo Platform dashboard for monitoring user statistics, system performance, and product telemetry.
- [Quick Start Guide](https://docs.shinzo.ai/quickstart.md): Get your MCP server instrumented and sending data to Shinzo in under 5 minutes.
- [Configuration](https://docs.shinzo.ai/sdk/python/configuration.md): Complete configuration guide for the Shinzo Python SDK
- [Installation](https://docs.shinzo.ai/sdk/python/installation.md): Install and set up the Shinzo Python SDK for MCP server instrumentation.
- [Configuration](https://docs.shinzo.ai/sdk/typescript/configuration.md): Complete configuration guide for the Shinzo TypeScript SDK
- [Installation](https://docs.shinzo.ai/sdk/typescript/installation.md): Install and set up the Shinzo TypeScript SDK for MCP server instrumentation.
- [Shinzo Agents](https://docs.shinzo.ai/shinzo-agents.md): Managed AI agent deployment and orchestration platform
- [Shinzo MCP Server](https://docs.shinzo.ai/shinzo-mcp-server.md): Connect your MCP client to the Shinzo platform to deploy and manage AI agents

## OpenAPI Specs

- [openapi](https://docs.shinzo.ai/api/openapi.json)

## Optional

- [GitHub](https://github.com/shinzo-labs)
- [Platform](https://app.shinzo.ai)