Post a message to a work session

POST

https://api.cloudraker.com/v1/work-sessions/:id/entries

POST

/v1/work-sessions/:id/entries

curl -X POST https://api.cloudraker.com/v1/work-sessions/id/entries \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "text": "string"
}'

{
  "data": {
    "entry": {
      "seq": 1,
      "id": "string",
      "kind": "comment",
      "at": "2024-01-15T09:30:00Z",
      "role": "user",
      "author": {
        "kind": "user",
        "id": "string",
        "name": "string",
        "avatarUrl": "string",
        "source": "web"
      },
      "threadId": "string",
      "turnId": "string",
      "parts": [
        {}
      ],
      "startedTurnIds": [
        "string"
      ],
      "updatedSeq": 1
    },
    "startedTurnIds": [
      "string"
    ],
    "unresolvedMentions": [
      "string"
    ],
    "failedMentions": [
      "string"
    ]
  }
}

Writes your message onto the timeline and starts one turn per agent you mention.

mentions takes agent handles or ids. A handle that resolves to no published agent is returned in unresolvedMentions and starts nothing — it is never an error; an agent whose turn the platform could not start is returned in failedMentions, so you can retry that one. startedTurnIds names the turns this message began; a mention of an agent that is already working steers its live turn instead and is not listed. Files in fileIds join the session’s working set for good.

Turns start before the message is written, so a turn_started entry holds a lower seq than the message that caused it; the message names the turns it started.

Learn more: Work sessions

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired1-128 characters

Request

This endpoint expects an object.

textstringRequired1-4000 characters

mentionslist of stringsOptionalDefaults to []

fileIdslist of stringsOptionalDefaults to []

Response

The appended entry and the turns it started.

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

503

Service Unavailable Error