# Whirl

> Connect your AI assistant to Whirl over MCP, or build on Whirl with the API.

- [Whirl MCP and API](https://docs.whirl.sh/index.md): Connect your AI assistant to Whirl over MCP, or build on Whirl with the API.
- [Quickstart](https://docs.whirl.sh/quickstart.md): Add Whirl to an MCP client, or make your first API call.
- [OAuth](https://docs.whirl.sh/authentication/index.md): Register your app, get a user's approval with PKCE, and manage tokens.
- [Client registration](https://docs.whirl.sh/authentication/client-metadata.md): Metadata documents, dynamic registration, redirect rules and signing keys.
- [Private key JWT](https://docs.whirl.sh/authentication/private-key-jwt.md): Authenticate a server-side app by signing a JWT with your private key, instead of sending a secret.
- [Scopes and permissions](https://docs.whirl.sh/permissions.md): Scopes let you control what your AI agents have access to do in Whirl. These are set when connecting to an MCP client on the consent screen.
- [Connect with MCP](https://docs.whirl.sh/connect.md): Add Whirl to an AI assistant that supports MCP.
- [Tool reference](https://docs.whirl.sh/tool-reference.md): What the Whirl MCP connection can do.
- [API](https://docs.whirl.sh/api/index.md): Request format, pagination and retries.
- [Errors and retries](https://docs.whirl.sh/api/errors.md): Status codes, rate limits, and how to retry without repeating a write.
- [Endpoint reference](https://docs.whirl.sh/api/reference.md): Every API route, grouped by what it does.
- [List workspaces](https://docs.whirl.sh/api/reference/list_workspaces.md): The workspaces this connection can open.
- [List workspace members](https://docs.whirl.sh/api/reference/list_workspace_members.md): The people in a workspace.
- [List task statuses](https://docs.whirl.sh/api/reference/list_workspace_statuses.md): The columns on a workspace's task board.
- [Create workspace](https://docs.whirl.sh/api/reference/create_workspace.md): Create a workspace, with its own agent.
- [Rename workspace](https://docs.whirl.sh/api/reference/rename_workspace.md): Change a workspace's name.
- [Archive workspace](https://docs.whirl.sh/api/reference/archive_workspace.md): Hide a workspace and pause its agents and automations.
- [List tasks](https://docs.whirl.sh/api/reference/list_tasks.md): Tasks in one column of a workspace.
- [Search tasks](https://docs.whirl.sh/api/reference/search_tasks.md): Find tasks by words in the title or description.
- [Get task](https://docs.whirl.sh/api/reference/get_task.md): A task's status, people, tags, due date and notes.
- [List task activity](https://docs.whirl.sh/api/reference/list_task_events.md): What has happened on a task.
- [List task chat](https://docs.whirl.sh/api/reference/list_task_messages.md): The chat with the agent on a task.
- [List source conversation](https://docs.whirl.sh/api/reference/list_task_conversation_messages.md): The email or chat thread a task came from.
- [Update task](https://docs.whirl.sh/api/reference/update_task.md): Change a task's title, status or due date.
- [Mark task done](https://docs.whirl.sh/api/reference/complete_task.md): Mark a task done.
- [Assign task](https://docs.whirl.sh/api/reference/assign_task.md): Choose who a task is assigned to.
- [Set task tags](https://docs.whirl.sh/api/reference/set_task_tags.md): Set the tags on a task.
- [Add note](https://docs.whirl.sh/api/reference/add_task_note.md): Add a note the team and the agent can see.
- [Delete task](https://docs.whirl.sh/api/reference/delete_task.md): Delete a task that is already done.
- [List agents](https://docs.whirl.sh/api/reference/list_agents.md): The agents in your workspaces.
- [Give an agent a task](https://docs.whirl.sh/api/reference/submit_task.md): Create a task and have an agent start on it.
- [Message the agent on a task](https://docs.whirl.sh/api/reference/send_task_message.md): Send the agent a follow-up on a task.
- [List agent runs on a task](https://docs.whirl.sh/api/reference/list_task_runs.md): Each time an agent worked on a task.
- [Get agent run](https://docs.whirl.sh/api/reference/get_run.md): What an agent run produced, and the actions it proposed.
- [List pending actions](https://docs.whirl.sh/api/reference/list_pending_actions.md): Actions an agent is waiting for someone to decide on.
- [Get pending action](https://docs.whirl.sh/api/reference/get_pending_action.md): The full draft of one proposed action.
- [Approve pending action](https://docs.whirl.sh/api/reference/approve_pending_action.md): Let Whirl carry out a proposed action, such as sending a message.
- [Reject pending action](https://docs.whirl.sh/api/reference/reject_pending_action.md): Stop a proposed action, a task for a person, or a question.
- [Edit pending action](https://docs.whirl.sh/api/reference/update_pending_action.md): Change a draft before it is approved.
- [Complete human task](https://docs.whirl.sh/api/reference/complete_human_task.md): Mark done something an agent asked a person to do.
- [Answer agent question](https://docs.whirl.sh/api/reference/answer_agent_question.md): Reply to a question an agent asked.
- [List reminders](https://docs.whirl.sh/api/reference/list_reminders.md): Reminders set on a task.
- [Set reminder](https://docs.whirl.sh/api/reference/create_reminder.md): Wake the agent on a task at a set time.
- [Change reminder](https://docs.whirl.sh/api/reference/update_reminder.md): Change a reminder's message or time.
- [Cancel reminder](https://docs.whirl.sh/api/reference/cancel_reminder.md): Cancel a reminder.
- [Read a company handbook entry](https://docs.whirl.sh/api/reference/read_company_handbook_section.md): The full text of one company handbook entry.
- [List an agent's handbook](https://docs.whirl.sh/api/reference/list_agent_instructions.md): The entries in an agent's handbook.
- [Edit a handbook entry](https://docs.whirl.sh/api/reference/update_agent_instruction_section.md): Edit an entry in an agent's handbook.
- [Reorder an agent's handbook](https://docs.whirl.sh/api/reference/reorder_agent_instruction_sections.md): Change the order of an agent's handbook.
- [List the company handbook](https://docs.whirl.sh/api/reference/list_company_handbook_sections.md): The handbook every agent in the organization follows.
- [Read a handbook entry](https://docs.whirl.sh/api/reference/read_agent_instruction_section.md): The full text of one handbook entry.
- [Edit a company handbook entry](https://docs.whirl.sh/api/reference/update_company_handbook_section.md): Edit an entry that applies to every agent.
- [Reorder the company handbook](https://docs.whirl.sh/api/reference/reorder_company_handbook_sections.md): Change the order of the company handbook.
- [List knowledge sources](https://docs.whirl.sh/api/reference/list_knowledge_sources.md): Links and files an agent can consult.
- [Read a knowledge source](https://docs.whirl.sh/api/reference/read_knowledge_source.md): Details of one knowledge source.
- [Add a knowledge link](https://docs.whirl.sh/api/reference/add_knowledge_link.md): Add a web page an agent can read.
- [Update a knowledge source](https://docs.whirl.sh/api/reference/update_knowledge_source.md): Change a knowledge source's name, note or address.
- [Remove a knowledge source](https://docs.whirl.sh/api/reference/remove_knowledge_source.md): Remove a link or file from an agent's knowledge.
- [Get scheduled task](https://docs.whirl.sh/api/reference/get_scheduled_task.md): A scheduled task's prompt, schedule and next run.
- [List scheduled tasks](https://docs.whirl.sh/api/reference/list_scheduled_tasks.md): Prompts an agent runs on a schedule.
- [Create scheduled task](https://docs.whirl.sh/api/reference/create_scheduled_task.md): Have an agent run a prompt on a repeating schedule.
- [Update scheduled task](https://docs.whirl.sh/api/reference/update_scheduled_task.md): Change a scheduled task's prompt, schedule or agent.
- [List scheduled task runs](https://docs.whirl.sh/api/reference/list_scheduled_task_runs.md): Past runs of a scheduled task.
- [Pause scheduled task](https://docs.whirl.sh/api/reference/pause_scheduled_task.md): Stop a scheduled task until it is resumed.
- [Delete scheduled task](https://docs.whirl.sh/api/reference/delete_scheduled_task.md): Delete a scheduled task. Earlier runs stay.
- [Run scheduled task now](https://docs.whirl.sh/api/reference/run_scheduled_task_now.md): Run a scheduled task once, outside its schedule.
- [Resume scheduled task](https://docs.whirl.sh/api/reference/resume_scheduled_task.md): Start a paused scheduled task again.
- [Tasks and approvals](https://docs.whirl.sh/workflows.md): Start agent tasks, approve the actions agents propose, and check on progress.
- [Deploying the API](https://docs.whirl.sh/deployment.md): Environment variables and release checks for running Whirl's API. For Whirl maintainers.

## OpenAPI Specs

- [openapi](https://api.whirl.sh/api/v1/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.