Endpoint reference - Whirl

Workspaces

Endpoint	What it does
List workspaces `GET /api/v1/workspaces`	The workspaces this connection can open.
List workspace members `GET /api/v1/workspaces/{workspaceId}/members`	The people in a workspace.
List task statuses `GET /api/v1/workspaces/{workspaceId}/statuses`	The columns on a workspace’s task board.
Create workspace `POST /api/v1/workspaces`	Create a workspace, with its own agent.
Rename workspace `PATCH /api/v1/workspaces/{workspaceId}`	Change a workspace’s name.
Archive workspace `POST /api/v1/workspaces/{workspaceId}/archive`	Hide a workspace and pause its agents and automations.

Tasks

Endpoint	What it does
List tasks `GET /api/v1/workspaces/{workspaceId}/tasks`	Tasks in one column of a workspace.
Search tasks `GET /api/v1/workspaces/{workspaceId}/tasks/search`	Find tasks by words in the title or description.
Get task `GET /api/v1/tasks/{taskId}`	A task’s status, people, tags, due date and notes.
List task activity `GET /api/v1/tasks/{taskId}/events`	What has happened on a task.
List task chat `GET /api/v1/tasks/{taskId}/messages`	The chat with the agent on a task.
List source conversation `GET /api/v1/tasks/{taskId}/conversation`	The email or chat thread a task came from.
Update task `PATCH /api/v1/tasks/{taskId}`	Change a task’s title, status or due date.
Mark task done `POST /api/v1/tasks/{taskId}/complete`	Mark a task done.
Assign task `POST /api/v1/tasks/{taskId}/assignees`	Choose who a task is assigned to.
Set task tags `POST /api/v1/tasks/{taskId}/tags`	Set the tags on a task.
Add note `POST /api/v1/tasks/{taskId}/notes`	Add a note the team and the agent can see.
Delete task `DELETE /api/v1/tasks/{taskId}`	Delete a task that is already done.

Agents

Endpoint	What it does
List agents `GET /api/v1/agents`	The agents in your workspaces.
Give an agent a task `POST /api/v1/agents/{agentId}/tasks`	Create a task and have an agent start on it.
Message the agent on a task `POST /api/v1/tasks/{taskId}/messages`	Send the agent a follow-up on a task.
List agent runs on a task `GET /api/v1/tasks/{taskId}/runs`	Each time an agent worked on a task.
Get agent run `GET /api/v1/runs/{runId}`	What an agent run produced, and the actions it proposed.

Approvals

Endpoint	What it does
List pending actions `GET /api/v1/tasks/{taskId}/pending-actions`	Actions an agent is waiting for someone to decide on.
Get pending action `GET /api/v1/pending-actions/{actionId}`	The full draft of one proposed action.
Approve pending action `POST /api/v1/pending-actions/{actionId}/approve`	Let Whirl carry out a proposed action, such as sending a message.
Reject pending action `POST /api/v1/pending-actions/{actionId}/reject`	Stop a proposed action, a task for a person, or a question.
Edit pending action `PATCH /api/v1/pending-actions/{actionId}`	Change a draft before it is approved.
Complete human task `POST /api/v1/pending-actions/{actionId}/complete`	Mark done something an agent asked a person to do.
Answer agent question `POST /api/v1/pending-actions/{actionId}/answer`	Reply to a question an agent asked.

Reminders

Endpoint	What it does
List reminders `GET /api/v1/tasks/{taskId}/reminders`	Reminders set on a task.
Set reminder `POST /api/v1/tasks/{taskId}/reminders`	Wake the agent on a task at a set time.
Change reminder `PATCH /api/v1/reminders/{reminderId}`	Change a reminder’s message or time.
Cancel reminder `DELETE /api/v1/reminders/{reminderId}`	Cancel a reminder.

Handbook

Endpoint	What it does
List an agent’s handbook `GET /api/v1/agents/{agentId}/instructions`	The entries in an agent’s handbook.
Read a handbook entry `GET /api/v1/agent-instructions/{sectionId}`	The full text of one handbook entry.
Edit a handbook entry `PATCH /api/v1/agent-instructions/{sectionId}`	Edit an entry in an agent’s handbook.
Reorder an agent’s handbook `POST /api/v1/agents/{agentId}/instructions/reorder`	Change the order of an agent’s handbook.
List the company handbook `GET /api/v1/company-handbook`	The handbook every agent in the organization follows.
Read a company handbook entry `GET /api/v1/company-handbook/{sectionId}`	The full text of one company handbook entry.
Edit a company handbook entry `PATCH /api/v1/company-handbook/{sectionId}`	Edit an entry that applies to every agent.
Reorder the company handbook `POST /api/v1/company-handbook/reorder`	Change the order of the company handbook.

Knowledge

Endpoint	What it does
List knowledge sources `GET /api/v1/knowledge-sources`	Links and files an agent can consult.
Read a knowledge source `GET /api/v1/knowledge-sources/{sourceId}`	Details of one knowledge source.
Add a knowledge link `POST /api/v1/knowledge-sources`	Add a web page an agent can read.
Update a knowledge source `PATCH /api/v1/knowledge-sources/{sourceId}`	Change a knowledge source’s name, note or address.
Remove a knowledge source `DELETE /api/v1/knowledge-sources/{sourceId}`	Remove a link or file from an agent’s knowledge.

Scheduled tasks

Endpoint	What it does
List scheduled tasks `GET /api/v1/scheduled-tasks`	Prompts an agent runs on a schedule.
Get scheduled task `GET /api/v1/scheduled-tasks/{scheduledTaskId}`	A scheduled task’s prompt, schedule and next run.
List scheduled task runs `GET /api/v1/scheduled-tasks/{scheduledTaskId}/runs`	Past runs of a scheduled task.
Create scheduled task `POST /api/v1/scheduled-tasks`	Have an agent run a prompt on a repeating schedule.
Update scheduled task `PATCH /api/v1/scheduled-tasks/{scheduledTaskId}`	Change a scheduled task’s prompt, schedule or agent.
Pause scheduled task `POST /api/v1/scheduled-tasks/{scheduledTaskId}/pause`	Stop a scheduled task until it is resumed.
Resume scheduled task `POST /api/v1/scheduled-tasks/{scheduledTaskId}/resume`	Start a paused scheduled task again.
Delete scheduled task `DELETE /api/v1/scheduled-tasks/{scheduledTaskId}`	Delete a scheduled task. Earlier runs stay.
Run scheduled task now `POST /api/v1/scheduled-tasks/{scheduledTaskId}/run`	Run a scheduled task once, outside its schedule.