# Coconut ## Docs - [AI chat](https://docs.coconut.dev/api-reference/ai/ai-chat.md): Send a message to the AI assistant. The server uses Claude Sonnet 4.5 (default) via the Vercel AI SDK. The system prompt is built from the shared Coconut assistant prompt plus, when present on disk, `.nut/context/role.md` and `.nut/context/memory.md` (appended as instance context). Tools (tasks, kno… - [Create chat](https://docs.coconut.dev/api-reference/chats/create-chat.md): Create a new chat - [Delete chat](https://docs.coconut.dev/api-reference/chats/delete-chat.md): Delete a chat - [Get chat](https://docs.coconut.dev/api-reference/chats/get-chat.md): Retrieve a specific chat - [List chats](https://docs.coconut.dev/api-reference/chats/list-chats.md): Retrieve all chat histories - [Update chat](https://docs.coconut.dev/api-reference/chats/update-chat.md): Update an existing chat by ID. Merges provided fields with the existing chat data and updates the timestamp. - [Get configuration](https://docs.coconut.dev/api-reference/configuration/get-configuration.md): Retrieve current project configuration - [Get global configuration](https://docs.coconut.dev/api-reference/configuration/get-global-configuration.md): Retrieve global (user-level) configuration - [Update configuration](https://docs.coconut.dev/api-reference/configuration/update-configuration.md): Update project configuration. At least one of `coconut` or `scripts` must be provided. - `coconut` - Merges into existing coconut identity - `scripts` - Replaces the scripts section (named commands, e.g. dev, build, test) - [Update control plane settings](https://docs.coconut.dev/api-reference/configuration/update-control-plane-settings.md): Admin-only setter for control plane secrets stored in `auth.json`. - [Update global configuration](https://docs.coconut.dev/api-reference/configuration/update-global-configuration.md): Update global (user-level) configuration - [Get agents context](https://docs.coconut.dev/api-reference/context/get-agents-context.md): Retrieve agents definitions and configurations - [Get memory context](https://docs.coconut.dev/api-reference/context/get-memory-context.md): Retrieve persistent memory and learned context - [Get role context](https://docs.coconut.dev/api-reference/context/get-role-context.md): Retrieve role definition and guidelines - [Get team context](https://docs.coconut.dev/api-reference/context/get-team-context.md): Retrieve team structure and member information - [Update agents context](https://docs.coconut.dev/api-reference/context/update-agents-context.md): Update agents definitions and configurations - [Update memory context](https://docs.coconut.dev/api-reference/context/update-memory-context.md): Update persistent memory and learned context - [Update role context](https://docs.coconut.dev/api-reference/context/update-role-context.md): Update role definition and guidelines - [Update team context](https://docs.coconut.dev/api-reference/context/update-team-context.md): Update team structure and member information - [Checkout branch](https://docs.coconut.dev/api-reference/git/checkout-branch.md): Checkout a Git branch - [Clear credentials](https://docs.coconut.dev/api-reference/git/clear-credentials.md): Clear stored Git credentials - [Create branch](https://docs.coconut.dev/api-reference/git/create-branch.md): Create a new Git branch - [Create commit](https://docs.coconut.dev/api-reference/git/create-commit.md): Create a new Git commit - [Create worktree](https://docs.coconut.dev/api-reference/git/create-worktree.md): Create a new Git worktree - [Delete branch](https://docs.coconut.dev/api-reference/git/delete-branch.md): Delete a Git branch - [Delete worktree](https://docs.coconut.dev/api-reference/git/delete-worktree.md): Delete a Git worktree - [Discard changes](https://docs.coconut.dev/api-reference/git/discard-changes.md): Discard uncommitted changes - [Get auth status](https://docs.coconut.dev/api-reference/git/get-auth-status.md): Retrieve Git authentication status - [Get commit](https://docs.coconut.dev/api-reference/git/get-commit.md): Retrieve a specific commit - [Get commit diff](https://docs.coconut.dev/api-reference/git/get-commit-diff.md): Retrieve the diff for a specific commit - [Get credentials](https://docs.coconut.dev/api-reference/git/get-credentials.md): Retrieve stored Git credentials - [Get diff](https://docs.coconut.dev/api-reference/git/get-diff.md): Retrieve current working directory diff - [Get file at commit](https://docs.coconut.dev/api-reference/git/get-file-at-commit.md): Retrieve file content at a specific commit - [Get Git settings](https://docs.coconut.dev/api-reference/git/get-git-settings.md): Retrieve Git configuration settings - [Get Git status](https://docs.coconut.dev/api-reference/git/get-git-status.md): Retrieve current Git repository status - [Get instruction files](https://docs.coconut.dev/api-reference/git/get-instruction-files.md): Retrieve the contents of instruction/guidance files (README.md, CLAUDE.md, GEMINI.md, AGENTS.md) from all directories in the repository. Returns a nested object keyed by directory path, where each value maps filenames to their content. - [GitHub OAuth authorize](https://docs.coconut.dev/api-reference/git/github-oauth-authorize.md): Initiate GitHub OAuth authorization flow - [GitHub OAuth token](https://docs.coconut.dev/api-reference/git/github-oauth-token.md): Exchange authorization code for GitHub access token - [List branches](https://docs.coconut.dev/api-reference/git/list-branches.md): Retrieve all Git branches - [List commits](https://docs.coconut.dev/api-reference/git/list-commits.md): Retrieve commit history - [List tracked files](https://docs.coconut.dev/api-reference/git/list-tracked-files.md): List all files tracked by Git in the current HEAD using `git ls-tree -r --name-only HEAD`. - [List worktrees](https://docs.coconut.dev/api-reference/git/list-worktrees.md): Retrieve all Git worktrees - [Pull changes](https://docs.coconut.dev/api-reference/git/pull-changes.md): Pull changes from remote repository - [Push changes](https://docs.coconut.dev/api-reference/git/push-changes.md): Push commits to remote repository - [Stage files](https://docs.coconut.dev/api-reference/git/stage-files.md): Stage files for commit - [Unstage files](https://docs.coconut.dev/api-reference/git/unstage-files.md): Unstage files from commit - [Update Git settings](https://docs.coconut.dev/api-reference/git/update-git-settings.md): Update Git configuration settings - [Get agent card](https://docs.coconut.dev/api-reference/identity/get-agent-card.md): Retrieve the agent card (A2A identity) - [Update agent card](https://docs.coconut.dev/api-reference/identity/update-agent-card.md): Update the agent card - [Introduction](https://docs.coconut.dev/api-reference/introduction.md): Explore the Coconut API - [Create job](https://docs.coconut.dev/api-reference/jobs/create-job.md): Create a new scheduled job - [Delete job](https://docs.coconut.dev/api-reference/jobs/delete-job.md): Delete a scheduled job - [Get job](https://docs.coconut.dev/api-reference/jobs/get-job.md): Retrieve a specific job - [Get job runs](https://docs.coconut.dev/api-reference/jobs/get-job-runs.md): Retrieve run history for a job - [List jobs](https://docs.coconut.dev/api-reference/jobs/list-jobs.md): Retrieve all scheduled jobs - [Run job](https://docs.coconut.dev/api-reference/jobs/run-job.md): Manually trigger a job run - [Update job](https://docs.coconut.dev/api-reference/jobs/update-job.md): Update a scheduled job - [Create knowledge document](https://docs.coconut.dev/api-reference/knowledge/create-knowledge-document.md): Create a new knowledge document - [Delete knowledge document](https://docs.coconut.dev/api-reference/knowledge/delete-knowledge-document.md): Delete a knowledge document - [Get knowledge document](https://docs.coconut.dev/api-reference/knowledge/get-knowledge-document.md): Retrieve a specific knowledge document - [List knowledge documents](https://docs.coconut.dev/api-reference/knowledge/list-knowledge-documents.md): Retrieve knowledge documents with optional search and pagination. By default returns lightweight summaries (content truncated to ~200 chars). Use `full=true` to include the full markdown content. When `q` is provided, results include a `snippet` field with context around matches, `matchedIn` listing… - [Update knowledge document](https://docs.coconut.dev/api-reference/knowledge/update-knowledge-document.md): Update an existing knowledge document - [Delete email](https://docs.coconut.dev/api-reference/mail/delete-email.md): Delete an email from a folder - [Get email](https://docs.coconut.dev/api-reference/mail/get-email.md): Retrieve a specific email from a folder - [List emails in folder](https://docs.coconut.dev/api-reference/mail/list-emails-in-folder.md): Retrieve all emails in a specific folder (inbox, read, sent) - [Receive inbound email](https://docs.coconut.dev/api-reference/mail/receive-inbound-email.md): Webhook endpoint for receiving inbound emails from Resend. Expects the Resend `email.received` webhook payload format. - [Reply to email](https://docs.coconut.dev/api-reference/mail/reply-to-email.md): Reply to an email (stores reply in sent folder) - [Send email](https://docs.coconut.dev/api-reference/mail/send-email.md): Send an email (coming soon) - [Set email status](https://docs.coconut.dev/api-reference/mail/set-email-status.md): Set an email's read/unread status (moves between inbox and read folders) - [Execute MCP tool](https://docs.coconut.dev/api-reference/mcp/execute-mcp-tool.md): Execute an MCP tool - [List MCP servers](https://docs.coconut.dev/api-reference/mcp/list-mcp-servers.md): Retrieve all configured MCP servers - [List MCP tools](https://docs.coconut.dev/api-reference/mcp/list-mcp-tools.md): Retrieve all available MCP tools - [Delete resource](https://docs.coconut.dev/api-reference/resources/delete-resource.md): Delete a resource - [Generate audio](https://docs.coconut.dev/api-reference/resources/generate-audio.md): Generate audio using AI (text-to-speech) - [Generate image](https://docs.coconut.dev/api-reference/resources/generate-image.md): Generate an image using AI - [Generate video](https://docs.coconut.dev/api-reference/resources/generate-video.md): Generate video using AI - [Get resource](https://docs.coconut.dev/api-reference/resources/get-resource.md): Retrieve resource metadata or download the file - [Get resource thumbnail](https://docs.coconut.dev/api-reference/resources/get-resource-thumbnail.md): Get a thumbnail for image/video resources - [List resources](https://docs.coconut.dev/api-reference/resources/list-resources.md): Retrieve all uploaded resources - [Update resource](https://docs.coconut.dev/api-reference/resources/update-resource.md): Update resource metadata - [Upload resource](https://docs.coconut.dev/api-reference/resources/upload-resource.md): Upload a new resource file - [Create skill](https://docs.coconut.dev/api-reference/skills/create-skill.md): Create a new skill. The skill is stored as `.nut/skills//SKILL.md` with YAML frontmatter following the Agent Skills specification. Optionally supply `archiveUrl` to download and extract a zip archive from a trusted registry host. - [Delete skill](https://docs.coconut.dev/api-reference/skills/delete-skill.md): Delete a skill and its entire directory - [Get skill](https://docs.coconut.dev/api-reference/skills/get-skill.md): Retrieve a specific skill by its directory name (id) - [List skills](https://docs.coconut.dev/api-reference/skills/list-skills.md): Retrieve all configured skills. Each skill is stored as a directory under `.nut/skills//SKILL.md` following the Agent Skills specification (https://agentskills.io/specification). - [Update skill](https://docs.coconut.dev/api-reference/skills/update-skill.md): Update an existing skill. Supports partial updates — only provided fields are changed. If `name` is changed, the skill directory is renamed accordingly. - [Get Slack configuration](https://docs.coconut.dev/api-reference/slack/get-slack-configuration.md): Returns the current Slack configuration with tokens masked for display - [List Slack channels](https://docs.coconut.dev/api-reference/slack/list-slack-channels.md): Lists available Slack channels the bot can post to. Includes both public and private channels if the bot has the necessary scopes. - [Send example notification](https://docs.coconut.dev/api-reference/slack/send-example-notification.md): Sends an example notification for a specific notification type. Bypasses the enabled check so users can preview notifications before enabling them. - [Send test notification](https://docs.coconut.dev/api-reference/slack/send-test-notification.md): Sends a generic test notification to the configured Slack channel - [Test Slack connection](https://docs.coconut.dev/api-reference/slack/test-slack-connection.md): Tests the Slack connection using the configured bot token - [Update Slack configuration](https://docs.coconut.dev/api-reference/slack/update-slack-configuration.md): Updates Slack configuration. Only provided fields are updated. - [Create task](https://docs.coconut.dev/api-reference/tasks/create-task.md): Create a new task - [Delete task](https://docs.coconut.dev/api-reference/tasks/delete-task.md): Delete a task - [Discard task](https://docs.coconut.dev/api-reference/tasks/discard-task.md): Discard a task and optionally revert its changes - [Get task](https://docs.coconut.dev/api-reference/tasks/get-task.md): Retrieve a specific task by ID - [Get task changes](https://docs.coconut.dev/api-reference/tasks/get-task-changes.md): Retrieve all file changes associated with a task - [List tasks](https://docs.coconut.dev/api-reference/tasks/list-tasks.md): Retrieve a list of tasks with optional filtering, search, and pagination. By default returns lightweight summaries (content truncated, comments omitted). Use `full=true` to include full content, planSteps, and comments. When `q` is provided, results include a `snippet` field with context around matc… - [Update a plan step](https://docs.coconut.dev/api-reference/tasks/update-a-plan-step.md): Update an existing plan step on a task (e.g. change status, description, or other fields) - [Update task](https://docs.coconut.dev/api-reference/tasks/update-task.md): Partially update an existing task - [Create terminal session](https://docs.coconut.dev/api-reference/terminal/create-terminal-session.md): Create a new terminal session for a task - [Destroy terminal session](https://docs.coconut.dev/api-reference/terminal/destroy-terminal-session.md): Destroy an existing terminal session - [List terminal sessions](https://docs.coconut.dev/api-reference/terminal/list-terminal-sessions.md): Retrieve active terminal sessions, optionally filtered by task or session ID. - [Resize terminal](https://docs.coconut.dev/api-reference/terminal/resize-terminal.md): Resize a terminal session - [Start a code session](https://docs.coconut.dev/api-reference/terminal/start-a-code-session.md): Create a terminal session for a task, build the pipeline command for the selected AI agent, and send it to the terminal. Returns the session ID so callers can connect via the WebSocket endpoint to monitor progress. - [Terminal Preview WebSocket](https://docs.coconut.dev/api-reference/terminal/terminal-preview-websocket.md): Read-only WebSocket endpoint for viewing terminal output. - [Terminal WebSocket](https://docs.coconut.dev/api-reference/terminal/terminal-websocket.md): WebSocket endpoint for interactive terminal I/O. - [Get user info](https://docs.coconut.dev/api-reference/user/get-user-info.md): Retrieve current user information - [Get user settings](https://docs.coconut.dev/api-reference/user/get-user-settings.md): Retrieve user settings - [Update user settings](https://docs.coconut.dev/api-reference/user/update-user-settings.md): Update user settings - [Get API version](https://docs.coconut.dev/api-reference/version/get-api-version.md): Retrieve API version information - [nut auth](https://docs.coconut.dev/cli/auth.md): Manage authentication for Coconut - [nut coconut](https://docs.coconut.dev/cli/coconut.md): Call peer Coconut MCP tools from the CLI - [nut code](https://docs.coconut.dev/cli/code.md): AI-assisted task implementation - [nut config](https://docs.coconut.dev/cli/config.md): Manage Coconut configuration and API keys - [nut connect](https://docs.coconut.dev/cli/connect.md): Access third-party services through Coconut connectors - [nut context](https://docs.coconut.dev/cli/context.md): Manage context documents - [nut events](https://docs.coconut.dev/cli/events.md): View activity events - [nut init](https://docs.coconut.dev/cli/init.md): Initialize Coconut in your repository - [nut knowledge](https://docs.coconut.dev/cli/knowledge.md): Manage knowledge base documents - [CLI Overview](https://docs.coconut.dev/cli/overview.md): Command-line interface for Coconut - [nut resource](https://docs.coconut.dev/cli/resource.md): Generate images, audio, and video with AI - [nut schema](https://docs.coconut.dev/cli/schema.md): Manage Coconut schema reference files - [nut serve](https://docs.coconut.dev/cli/serve.md): Launch the Coconut web interface - [nut skill](https://docs.coconut.dev/cli/skill.md): Manage AI skills (agents) - [nut task](https://docs.coconut.dev/cli/task.md): Manage tasks (change proposals) - [Creating a Coconut](https://docs.coconut.dev/control-plane/create.md): Explore your configuration options when creating a new Coconut instance - [Control Plane](https://docs.coconut.dev/control-plane/overview.md): Manage your cloud of coconuts - [Settings](https://docs.coconut.dev/control-plane/settings.md): Manage your coconut instances - [Introduction](https://docs.coconut.dev/index.md): Welcome to Coconut - [Connectors & MCP](https://docs.coconut.dev/integrations/connectors.md): Securely extend AI assistants with your Coconut instances using the Model Context Protocol - [Integrations](https://docs.coconut.dev/integrations/overview.md): Connect Coconut to AI assistants, agents, and reusable skills - [Skills](https://docs.coconut.dev/integrations/skills.md): Install and author reusable Coconut skills via the Claude Code plugin marketplace - [.nut Directory](https://docs.coconut.dev/nut/overview.md): Understanding the .nut directory structure - [Custom Skills](https://docs.coconut.dev/studio/agents.md): Skills at your service - [Code](https://docs.coconut.dev/studio/code.md): Build with Coconuts - [Overview](https://docs.coconut.dev/studio/overview.md): The powerful interface to work with your Coconuts - [Schedule](https://docs.coconut.dev/studio/schedule.md): Automate recurring Coconut tasks with the built-in scheduler - [Settings](https://docs.coconut.dev/studio/settings.md): Configure and manage your coconut instance - [Source Control](https://docs.coconut.dev/studio/source-control.md): Managing your source code with Git and Github - [Tasks](https://docs.coconut.dev/studio/tasks.md): Create tasks for your coding agents - [Terminal](https://docs.coconut.dev/studio/terminal.md): Use Coconut's built-in terminal - [Content Creation](https://docs.coconut.dev/use-cases/content-creation.md): Create content for your website, next social post, or product documentation - [Intelligence Gathering](https://docs.coconut.dev/use-cases/intelligence-gathering.md): Turn information gathered from diverse sources into actionable intelligence - [Resource Generation](https://docs.coconut.dev/use-cases/resource-generation.md): Generate compelling images, audio and video assets on-demand - [Software Development](https://docs.coconut.dev/use-cases/software-development.md): Use the latest coding agents to build something new or experiment with a new feature ## OpenAPI Specs - [openapi](https://docs.coconut.dev/api-reference/openapi.yaml) ## Optional - [Control Plane](https://app.coconut.dev) - [Blog](https://www.coconut.dev/blog)