> ## Documentation Index
> Fetch the complete documentation index at: https://docs.worksong.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Worksong API

> How the Worksong API is organised, and where its generated reference is.

The Worksong API is the HTTP API behind the Worksong apps. The pages under **Worksong API reference** list every public operation: its method and path, its path and query parameters, the JSON body it takes and the JSON it returns.

## How to read the reference

* **Base URL:** `https://app.worksong.ai`. Paths start with `/api`.
* **Authentication:** send `Authorization: Bearer <token>`. A few operations (sign-in, a routine's webhook, a shared file link) need no token and say so.
* **Shapes come from the code.** The request and response shapes are generated from the same schemas the apps are built with, at the commit named in the file. Where a handler returns a file, a stream or nothing, the page says that instead of showing a JSON body.
* **Some operations show less.** If the generator could not tie a handler to a schema, the operation has no response shape and is listed as an open gap in the file (`x-gaps`). Those are fixed in the generator or in the product, not guessed here.

## Areas

Bootstrap, Agents, Conversations and messages, Groups, Files, Memory, Projects, Contacts, Skills, Tasks, Routines, Approvals, Connections, WhatsApp, phone calls, Tool servers, Audit, notifications, usage and What's new.

## Streaming

`POST` and `GET` on `/api/conversations/{conversationId}/stream` return a server-sent event stream. A stream that ends without a final `run.completed`, `run.failed` or `run.error` event means "reconnect and read the conversation again", not "finished".

<sub>Source: `worksong-ai/worksong:packages/shared/src/api.ts@042e65d`, `worksong-ai/worksong:apps/api/src/routes/index.ts@042e65d`, `worksong-ai/worksong:CLAUDE.md@042e65d`. Docs version: Worksong 2.0 with Work 1.2.</sub>


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