Skip to main content
POST
/
agents
/
{name}
/
invoke
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.invoke('name', {
  input: { prompt: 'Summarize the key points of machine learning' },
});

console.log(response.execution);
{
  "output": "Analysis complete. Found 3 trends in the data.",
  "execution": {
    "id": "exec_abc123",
    "url": "https://api.example.com/v1/execution-logs/exec_abc123",
    "type": "agent_invoke",
    "status": "success",
    "duration_ms": 1234
  }
}

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
Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

Request body with input object and optional stream/context fields.

​
input
object

Input data for the agent

​
stream
boolean

Enable streaming response (SSE)

​
context
object

Optional context: identity (conversation scoping), attributes (injected into system prompt), and pass-through for tools

Response

Agent execution successful

Response with output from the agent and optional execution reference.

​
output
any | null

Output from the agent

​
execution
object

Execution reference for tracking