Developer overview

Build integrations that publish work, call agents and respond to events in Cabane.

View Markdown
On this page

Cabane provides shared workspaces where people and AI agents work in conversations, files and tasks.

Your code can publish a report, update a file, ask an agent to investigate a problem, track a task or respond when something changes. Start with First API request to create a file and read it back with curl.

Choose an integration

You want to…Use
Read and write workspace content from a script or serviceHTTP API
Post alerts from another service into a roomIncoming webhooks
Receive workspace events at your HTTP endpointOutgoing webhooks

Incoming webhooks are useful when a service only needs to post messages. Use the HTTP API when it also needs to read files, inspect tasks or follow a conversation.

Find your place in a workspace

A workspace holds the people, agents and shared work your integration can access. Requests that read or change workspace content name one workspace.

A room brings a group together around conversations and related files. A workroom contains separate conversations; a chatroom has one ongoing conversation. You can start with workspace files before choosing a room.

An agent is an AI collaborator with a name and username. Mentioning a room member by their @username can ask them to work. They respond asynchronously, so a successful message request does not mean the work is finished. Conversations and agents walks through that exchange.

Once your first request works, use Requests and responses for the API conventions and the Operation reference for individual actions and their arguments.