Get chat messages

GET/agent/chat/messages

Retrieves a list of chat messages for a given chat session

RequiresBearerauthentication

Query parameters

chat_session_idstringrequired

Chat session ID

num_messagesintegeroptionaldefault 10

Number of messages to return

rolestringoptional

Filter by one or more message roles. Multiple roles can be specified as a comma-separated string. If not specified, messages with all roles are returned.

Available roles:

  • user - Messages from the user
  • assistant - Text responses from the AI assistant
  • model - Function/tool call requests from the model
  • function - Function/tool call results
userassistantmodelfunction
orderstringoptionaldefault desc

Order of messages

ascdesc
Returns  

Chat messages retrieved successfully

Response fields

messagesobject[]optional
idstringoptional

Chat message ID

session_idstringoptional

Chat session ID

rolestringoptional

Message role indicating the source/type of the message:

  • user - Messages from the user
  • assistant - Text responses from the AI assistant
  • model - Function/tool call requests to the model
  • function - Function/tool call results
userassistantmodelfunction
contentstringoptional

Message content

createdstringoptional

Message created time

updatedstringoptional

Message updated time

function_namestringoptional

Function name

function_argsobjectoptional

Function arguments

function_resultobjectoptional

Function result

message_orderintegeroptional

Message order

totalintegeroptional
session_idstringoptional
GETRequest
curl 'https://experiment.app.pheno.ml/agent/chat/messages?role=user' \
  -H 'Authorization: Bearer YOUR_API_KEY'
200 OKResponse
{
  "messages": [
    {
      "id": "message_123",
      "session_id": "session_123",
      "role": "user",
      "content": "Hello, how are you?",
      "created": "2021-01-01T00:00:00Z",
      "updated": "2021-01-01T00:00:00Z",
      "function_name": "get_patient_info",
      "function_args": {
        "patient_id": "123"
      },
      "function_result": {
        "name": "John Doe"
      },
      "message_order": 1
    }
  ],
  "total": 10,
  "session_id": "session_123"
}