Skip to main content
POST
/
api
/
v1
/
local
/
session
/
{namespace}
/
{sessionId}
Executes a session
curl --request POST \
  --url https://api.coralcloud.ai/api/v1/local/session/{namespace}/{sessionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "extendedEndReport": true,
  "ttl": 123,
  "persistenceMode": {
    "mode": "hold_after_exit",
    "duration": 123
  },
  "webhooks": {}
}
'
{
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
namespace
string
required

The namespace of the session

​
sessionId
string
required

The sessionId of the session

Body

application/json

Settings for the execution of the session

​
extendedEndReport
boolean
required

If specified, the end report generated for this session will be extended, including threads and messages

​
ttl
integer<int64>

If specified, the session will never live longer than this many milliseconds.

​
persistenceMode
hold_after_exit · object

Session will exist for at least the specified time (in milliseconds) after the session exits. This time does not include the run time of the session.

​
webhooks
SessionWebhooks · object

Webhooks executed for this session

Response

Success