API reference
Chats
The /v1/chats resource — a chat is the durable container for an app's full edit history. Every prompt, build event, and skill run lives on a chat.
#The Chat object
| Field | Type | Description |
|---|---|---|
| id | string | chat_xxx |
| workspaceId | string | Owner workspace. |
| title | string | Auto-generated from the first prompt; editable. |
| appId | string | null | The app currently associated with the chat (if any). |
| createdAt | ISO 8601 | |
| updatedAt | ISO 8601 |
#List chats
GET/v1/chats
#Get a chat
GET/v1/chats/:id
#List messages
GET/v1/chats/:id/messages
Paginated. Returns messages oldest → newest.
#Send a message
POST/v1/chats/:id/messages
Streaming endpoint. The same message router used by the workbench: prose triggers the build pipeline, /+@ trigger skills.
| Field | Type | Description |
|---|---|---|
| promptrequired | string | Message body. |
| mode | "build" | "chat" | "skill" | Force routing. Defaults to auto-detect. |
| augmenters | string[] | Augmenters to queue after the build. |
for await (const ev of client.chats.sendStream({
chatId: 'chat_abc',
prompt: 'Add a FAQ section',
})) {
console.log(ev.type, ev);
}#Rename a chat
PATCH/v1/chats/:id
#Delete a chat
DELETE/v1/chats/:id
Cascades to delete the associated app.
#Where to go next
PromptFloe developer docs