Create AdminAgentMessage

POST

api

sys

adminagentmessages

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/adminagentmessages \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "AdminAgentSessionId": 123,
  "Role": 123,
  "TokensUsed": 123,
  "Target": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/adminagentmessages"

payload = {
    "AdminAgentSessionId": 123,
    "Role": 123,
    "TokensUsed": 123,
    "Target": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({AdminAgentSessionId: 123, Role: 123, TokensUsed: 123, Target: 123})
};

fetch('https://spaces.nexudus.com/api/sys/adminagentmessages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

An individual message within an admin agent session conversation. Messages can be from the user, assistant, system, or tool calls/results. Each message tracks its role, content, and any tool interactions including tool name, arguments, and results. Token usage is tracked per message for cost monitoring.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the AdminAgentMessage-Create role.

Request Body

Required Fields

integer

required

ID of the admin agent session linked to this message.

integer

required

Role of the message sender: User, Assistant, System, ToolCall, or ToolResult.

integer

required

Number of LLM tokens consumed by this message.

integer

required

Agent when the assistant was asked to answer, Chat when the message was for the people in the conversation.

Optional Fields

string

The text content of the message.

string

Name of the tool that was called or produced a result.

string

JSON-formatted arguments passed to the tool.

string

JSON-formatted result returned by the tool.

integer

User who wrote the message (people only).

string

JSON with the users and/or agent mentioned in the message.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/adminagentmessages" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "AdminAgentSessionId": 0,
    "Role": 0,
    "TokensUsed": 0,
    "Target": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/adminagentmessages',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      AdminAgentSessionId: 0,
      Role: 0,
      TokensUsed: 0,
      Target: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/adminagentmessages',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'AdminAgentSessionId': 0,
        'Role': 0,
        'TokensUsed': 0,
        'Target': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the adminagentmessage was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "AdminAgentMessage was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[email protected]",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Role: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Role"
    }
  ],
  "WasSuccessful": false
}

Create AdminAgentMessage

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/adminagentmessages \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "AdminAgentSessionId": 123,
  "Role": 123,
  "TokensUsed": 123,
  "Target": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/adminagentmessages"

payload = {
    "AdminAgentSessionId": 123,
    "Role": 123,
    "TokensUsed": 123,
    "Target": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({AdminAgentSessionId: 123, Role: 123, TokensUsed: 123, Target: 123})
};

fetch('https://spaces.nexudus.com/api/sys/adminagentmessages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400