Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.shinzo.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Shinzo Platform allows you to deploy and manage autonomous AI agents that can execute complex tasks. Agents run in isolated Kubernetes environments with persistent storage and can interact with external services via MCP servers.

​
Features

  • Isolated Environments: Each agent runs in its own container with dedicated resources and persistent storage
  • Messaging: Send messages to agents and receive responses via the API or connected channels
  • Schedules & Triggers: Automate agent tasks with recurring cron schedules and event-driven webhook triggers
  • Channel Integrations: Connect agents to Discord, Slack, and Telegram. WhatsApp support coming soon
  • Filesystem API: Read, write, and manage files in the agent’s workspace
  • MCP Support: Connect agents to MCP servers for external service integration
  • Webhooks: Receive notifications when messages complete, fail, or when errors occur

​
Authentication

All agent endpoints accept either:
  • JWT Token: Authorization: Bearer <jwt_token>
  • Platform API Key: Authorization: Bearer <api_key>

​
Feature Flag

AI Agents must be enabled for your account. If you receive a 403 Forbidden error, contact support to enable this feature.

​
Endpoints

​
Agent Management

MethodEndpointDescription
POST/v1/agent/createDeploy a new AI agent
GET/v1/agent/listList all your agents
GET/v1/agent/{id}Get agent details and configuration
GET/v1/agent/{id}/summaryGet agent summary (status, tokens, metadata)
GET/v1/agent/{id}/readyCheck if agent is ready to receive messages
POST/v1/agent/update/{id}Update agent configuration
POST/v1/agent/delete/{id}Delete an agent
POST/v1/agent/{id}/pausePause an agent
POST/v1/agent/{id}/resumeResume a paused agent
POST/v1/agent/{id}/stopStop an agent (shuts down pod)
POST/v1/agent/{id}/statusSet agent status directly
POST/v1/agent/{id}/balanceUpdate agent token balance

​
Messaging

MethodEndpointDescription
POST/v1/agent/{id}/messagesSend a message to an agent
GET/v1/agent/{id}/messagesList agent messages
GET/v1/agent/{id}/conversationsList conversations grouped by counterparty

​
Channel Integrations

MethodEndpointDescription
GET/v1/agent/{id}/channelsList active channel bindings
POST/v1/agent/{id}/discord/linkGenerate Discord link code
GET/v1/agent/{id}/discord/statusCheck Discord link status
DELETE/v1/agent/{id}/discord/unlinkUnlink Discord account
POST/v1/agent/{id}/slack/linkGenerate Slack link code
GET/v1/agent/{id}/slack/statusCheck Slack link status
DELETE/v1/agent/{id}/slack/unlinkUnlink Slack account
POST/v1/agent/{id}/telegram/linkGenerate Telegram link code
GET/v1/agent/{id}/telegram/statusCheck Telegram link status
DELETE/v1/agent/{id}/telegram/unlinkUnlink Telegram account

​
Schedules & Triggers

MethodEndpointDescription
POST/v1/agent/{id}/schedulesCreate a cron schedule
GET/v1/agent/{id}/schedulesList all schedules
PATCH/v1/agent/{id}/schedules/{scheduleId}Update a schedule
POST/v1/agent/{id}/schedules/{scheduleId}/toggleToggle schedule enabled state
DELETE/v1/agent/{id}/schedules/{scheduleId}Delete a schedule
GET/v1/agent/{id}/schedules/{scheduleId}/executionsGet schedule execution history
POST/v1/agent/{id}/triggersCreate a webhook trigger
GET/v1/agent/{id}/triggersList all triggers
PATCH/v1/agent/{id}/triggers/{triggerId}Update a trigger
DELETE/v1/agent/{id}/triggers/{triggerId}Delete a trigger
POST/v1/webhooks/triggers/{triggerId}Inbound webhook endpoint (no auth header)
See Schedules & Triggers Overview for detailed documentation and usage examples.

​
Filesystem

See Filesystem Overview for complete filesystem API documentation.

​
Agent States

StateDescription
activeAgent is running and accepting messages
pausedAgent is paused and will not process new messages
stoppedAgent has been stopped
errorAgent encountered an error