System messages API

Manage reusable system messages — instructions sent alongside a prompt to set the AI's tone, role, or constraints. All endpoints require authentication.

System message object

Field	Type	Description
message_id	Int	Unique message identifier (read-only)
name	String	Human-readable name shown in the prompt edit form
message	String	The system message text
created_at	String	Creation timestamp (read-only)
updated_at	String	Last update timestamp (read-only)

Get system message

GET /rest/V1/assistant/system-message/:messageId

Response: the system message object.

Errors: 404 system message not found.

List system messages

GET /rest/V1/assistant/system-messages

Supports filtering and pagination.

Response:

{
  "items": [ { ... } ],
  "search_criteria": { "filter_groups": [], "page_size": 20, "current_page": 1 },
  "total_count": 4
}

Create system message

POST /rest/V1/assistant/system-message

Request body:

{
  "systemMessage": {
    "name": "Marketing copywriter",
    "message": "You are a senior marketing copywriter. Respond in clear, persuasive English; no preamble."
  }
}

name and message are required.

Response: the created system message object with message_id assigned.

Update system message

PUT /rest/V1/assistant/system-message/:messageId

Request body: same structure as Create system message. Include only the fields you want to change — see partial updates.

Response: the updated system message object.

Errors: 404 system message not found.

Delete system message

DELETE /rest/V1/assistant/system-message/:messageId

Response:

true

Errors: 404 system message not found.