Get one AdminAgentMessage

GET

api

sys

adminagentmessages

{id}

Get one AdminAgentMessage

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/adminagentmessages/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

{
  "AdminAgentSessionId": 123,
  "Role": 123,
  "Content": "<string>",
  "ToolName": "<string>",
  "ToolArguments": "<string>",
  "ToolResult": "<string>",
  "TokensUsed": 123,
  "AuthorId": 123,
  "AuthorFullName": "<string>",
  "AuthorEmail": "<string>",
  "Target": 123,
  "Mentions": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<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-Read role.

Path Parameters

integer

required

The Id of the AdminAgentMessage record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/adminagentmessages/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/adminagentmessages/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/adminagentmessages/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the admin agent session linked to this message.

integer

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

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

Number of LLM tokens consumed by this message.

integer

User who wrote the message (people only).

string

Display value for Author.FullName..

string

Display value for Author.Email..

integer

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

string

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

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "AdminAgentSessionId": 0,
  "Role": 0,
  "Content": null,
  "ToolName": null,
  "ToolArguments": null,
  "ToolResult": null,
  "TokensUsed": 0,
  "AuthorId": null,
  "AuthorFullName": null,
  "AuthorEmail": null,
  "Target": 0,
  "Mentions": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "[email protected]",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "AdminAgentMessage Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one AdminAgentMessage

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/adminagentmessages/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

{
  "AdminAgentSessionId": 123,
  "Role": 123,
  "Content": "<string>",
  "ToolName": "<string>",
  "ToolArguments": "<string>",
  "ToolResult": "<string>",
  "TokensUsed": 123,
  "AuthorId": 123,
  "AuthorFullName": "<string>",
  "AuthorEmail": "<string>",
  "Target": 123,
  "Mentions": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200