Skip to content
Docs

Ask Front Desk

POST
/api/workspaces/{ws}/assistant/conversations/{id}/messages

Answers as Server-Sent Events while it works: message (each stored message), text (the answer as it's written), step (what it's doing), onboarding (it finished the onboarding), error and done. Letting a hire go, removing things and anything that moves money stop at a confirm card instead of running.

Authorization

session
cookiebetter-auth.session_token<token>

Set by POST /api/auth/sign-in/email.

Path Parameters

ws*string

The workspace id (from GET /api/me).

id*string

The id of what the path names: a hire, a connection, a skill, a shared file, a department, a position, a goal or an approval.

Request Body

application/json
  1. body
text*string
Length1 <= length <= 4000

Response Body

An event stream (text/event-stream).

Example Request
curl -X POST 'https://app.useroster.work/api/workspaces/string/assistant/conversations/string/messages' \  -H 'Content-Type: application/json' \  -d '{  "text": "string"}'
Example Response
Empty

Delete a conversation DELETE

Only the conversation goes; what the assistant set up stays.

Answer a confirm card POST

`confirm` runs exactly the change the card holds, with your rights; `cancel` drops it. A card is answered once (409 after). Answers as the same event stream as asking.