Skip to main content
POST
/
api
/
executions
/
{executionId}
/
status-messages
Create execution status message
curl --request POST \
  --url https://platform.kodexa.ai/api/executions/{executionId}/status-messages \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "type": "THINKING",
  "subtitle": "<string>"
}
'
{
  "datetime": "2023-11-07T05:31:56Z",
  "executionId": "<string>",
  "id": "<string>",
  "subtitle": "<string>",
  "title": "<string>",
  "type": "THINKING"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

​
executionId
string<uuid>
required

Unique identifier (UUID) of the execution.

Body

application/json

Request to create a status message for an execution.

​
title
string
required

Main status message text.

​
type
enum<string>
required

Status type.

Available options:
THINKING,
SEARCHING,
PLANNING,
REVIEWING,
PROCESSING,
ANALYZING,
WRITING,
WAITING
​
subtitle
string

Optional secondary message text.

Response

Status message created

A status message for an execution, providing live feedback about what the system is doing.

​
datetime
string<date-time>

When this status message was created.

​
executionId
string

ID of the execution this message belongs to.

​
id
string

Unique identifier of the status message.

​
subtitle
string

Optional secondary message text.

​
title
string

Main status message text.

​
type
enum<string>

Status type.

Available options:
THINKING,
SEARCHING,
PLANNING,
REVIEWING,
PROCESSING,
ANALYZING,
WRITING,
WAITING