Put one paperwork agent to work

POST

https://api.cloudraker.com/v1/paperwork-agents/:handle/sessions

POST

/v1/paperwork-agents/:handle/sessions

curl -X POST https://api.cloudraker.com/v1/paperwork-agents/handle/sessions \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "description": "string"
}'

{
  "data": {
    "object": "string",
    "id": "string",
    "status": "open",
    "title": "string",
    "description": "string",
    "agents": [
      {
        "id": "string",
        "handle": "string",
        "name": "string",
        "role": "string"
      }
    ],
    "spaceIds": [
      "string"
    ],
    "fileIds": [
      "string"
    ],
    "counts": {
      "turns": 1,
      "approvalsPending": 1,
      "tasksPending": 1
    },
    "apiVisible": true,
    "createdAt": "string",
    "lastActivityAt": "string",
    "closedAt": "string",
    "entriesUrl": "string",
    "streamUrl": "string",
    "artifactsUrl": "string",
    "startedTurnIds": [
      "string"
    ],
    "failedMentions": [
      "string"
    ],
    "webhookUrl": "string"
  }
}

Opens a work session with one agent and hands it the job in a single call: the session is opened, the agent is mentioned, and its turn starts before the response returns.

{handle} is the agent’s handle (mike) or its agt_ id. An unknown or unpublished agent answers 404.

startedTurnIds names the turn that began. Watch it at streamUrl, or set webhookUrl and receive the same events on your endpoint.

Learn more: Paperwork agents

Authentication

AuthorizationBearer

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

Path parameters

handlestringRequired1-128 characters

Request

This endpoint expects an object.

descriptionstringRequired1-8000 characters

titlestringOptional<=200 characters

fileIdslist of stringsOptionalDefaults to []

spaceIdslist of stringsOptionalDefaults to []

webhookUrlstringOptionalformat: "uri"<=2048 characters

apiVisiblebooleanOptionalDefaults to false

Response

The opened session and the turn it started.

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

503

Service Unavailable Error