botruntime
API ReferenceChat API

Set State Expiry

Updates the [State](#schema_state) expiry.

POST
/v1/chat/states/{type}/{id}/{name}/expiry

Path Parameters

type*string

Represents the resource type that the state is related to

Value in

  • "conversation"
  • "user"
  • "bot"
  • "integration"
  • "workflow"
id*string

Id of the State which will be either the botId, the userId or the conversationId

name*string

Name of the State which is declared inside the bot definition

Header Parameters

x-bot-id*string

Bot id

x-integration-id?string

Integration id

x-integration-alias?string

Integration alias

Request Body

application/json

State expiry

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/chat/states/conversation/string/string/expiry" \  -H "x-bot-id: string" \  -H "Content-Type: application/json" \  -d '{    "expiry": 1  }'
{  "state": {    "id": "stringstringstringstringstri",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "botId": "stringstringstringstringstri",    "conversationId": "stringstringstringstringstri",    "userId": "stringstringstringstringstri",    "name": "string",    "type": "conversation",    "payload": {},    "expiry": 1,    "expiresAt": "2019-08-24T14:15:22Z"  }}
{  "state": {    "id": "stringstringstringstringstri",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "botId": "stringstringstringstringstri",    "conversationId": "stringstringstringstringstri",    "userId": "stringstringstringstringstri",    "name": "string",    "type": "conversation",    "payload": {},    "expiry": 1,    "expiresAt": "2019-08-24T14:15:22Z"  }}

Set State POST

Overrides the [State](#schema_state) object by setting the values of the parameters passed.

Start Integration Operation POST

Creates a durable operation record and queues an integration action. Support is action- and adapter-specific. The generic fallback invokes one ordinary action, remains limited by its maxExecutionTime (at most 119 seconds), and has no provider Start/Poll/Cancel adapter. The endpoint rejects fields named contentBase64. When input has a top-level fileRef, the server accepts its id, resolves it in the authenticated bot scope, and persists the complete immutable generation metadata; other input remains opaque JSON. File bytes are not part of this request.