Chat with an agent

Have a conversational interaction with an agent. This endpoint maintains conversation context

through the messages array, allowing for multi-turn conversations.

Use cases:

  • Customer support chatbots
  • AI assistants with memory
  • Multi-step question answering
  • Conversational agents that need context

Message format: Follows OpenAI-compliant message structure with support for:

  • system, user, assistant, and tool roles
  • Multimodal content (text + images)
  • Tool/function calling

Streaming: Set stream: true in the request body to receive Server-Sent Events (SSE) stream with incremental chunks. Perfect for ChatGPT-like real-time chat interfaces.

POST
/agents/{name}/chat
AuthorizationBearer <token>

Project API key

In: header

Path Parameters

name*string

Unique, URL-safe agent name within the project

Request Body

application/json

messages*

Conversation history. Must include at least one message.

Items1 <= items
stream?boolean

Whether to stream the response as SSE.

Defaultfalse
context?

Optional request context passed to the agent handler.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.reminix.ai/v1/agents/string/chat" \  -H "Content-Type: application/json" \  -d '{    "messages": [      {        "role": "user",        "content": "What is the weather today?"      }    ],    "stream": false  }'

{
  "message": {
    "role": "assistant",
    "content": "The weather today is sunny, 72°F with light winds."
  }
}

{
  "error": "Invalid request"
}
{
  "error": "Invalid or missing API key"
}
{
  "error": "Resource not found"
}
{
  "error": "Internal server error"
}
{
  "error": "Unable to reach agent machine. The deployment may be down."
}
{
  "error": "Request timeout - agent took too long to respond"
}