Skip to main content
POST
/
agents
/
{name}
/
chat
JavaScript
import Reminix from '@reminix/sdk';

const client = new Reminix({
  apiKey: process.env['REMINIX_API_KEY'], // This is the default and can be omitted
});

const response = await client.agents.chat('name', {
  messages: [{ content: 'string', role: 'system' }],
});

console.log(response.conversation_id);
{
  "messages": [
    {
      "role": "system",
      "content": "<string>",
      "name": "<string>",
      "tool_call_id": "<string>",
      "tool_calls": [
        {
          "id": "<string>",
          "type": "function",
          "function": {
            "name": "<string>",
            "arguments": "<string>"
          }
        }
      ]
    }
  ],
  "conversation_id": "<string>"
}

Authorizations

Authorization
string
header
required

API Key or Personal Access Token (PAT). When using PAT, include X-Project header.

Path Parameters

name
string
required

Unique, URL-safe agent name within the project

Minimum string length: 1

Body

application/json
messages
object[]
required

Array of chat messages

Minimum array length: 1
conversation_id
string

Conversation ID to continue an existing conversation

stream
boolean

Enable streaming response

context
object

Optional context with identity for conversation scoping

Response

Chat response

messages
object[]
required

Array of assistant response messages

conversation_id
string

Conversation ID (present when conversation persistence is enabled)