Skip to main content
GET
/
agents
/
{name}
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 agent = await client.agents.retrieve('x');

console.log(agent.id);
{
  "id": "<string>",
  "projectId": "<string>",
  "name": "<string>",
  "type": "<string>",
  "status": "active",
  "config": {
    "provider": "openai",
    "model": "gpt-4o",
    "systemPrompt": "You are a helpful assistant.",
    "tools": [
      "search-web"
    ],
    "maxIterations": 10,
    "memory": {
      "enabled": true
    },
    "knowledgeBase": {
      "enabled": true,
      "collectionIds": [
        "coll_abc123"
      ]
    }
  },
  "description": "<string>",
  "input": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "default": "<unknown>",
    "enum": [
      "<unknown>"
    ],
    "properties": {},
    "required": [
      "<string>"
    ],
    "items": "<unknown>"
  },
  "output": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "default": "<unknown>",
    "enum": [
      "<unknown>"
    ],
    "properties": {},
    "required": [
      "<string>"
    ],
    "items": "<unknown>"
  },
  "canStream": true,
  "canChat": true,
  "discoveredAt": "<string>",
  "createdBy": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<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

Agent name

Minimum string length: 1

Response

Agent details

​
id
string
required

Unique agent ID

​
projectId
string
required

Project ID

​
name
string
required

Agent name

​
type
string
required

Agent type: "managed" for UI-created, "{language}" for custom agents (e.g., "python"), or "{language}-{adapter}" for adapter-based (e.g., "python-langchain")

​
status
enum<string>
required

Agent status

Available options:
active,
inactive
​
config
object
required

Agent configuration (for managed agents)

Example:
{
  "provider": "openai",
  "model": "gpt-4o",
  "systemPrompt": "You are a helpful assistant.",
  "tools": ["search-web"],
  "maxIterations": 10,
  "memory": { "enabled": true },
  "knowledgeBase": {
    "enabled": true,
    "collectionIds": ["coll_abc123"]
  }
}
​
description
string | null
required

Agent description

​
input
object
required

JSON Schema for agent input

​
output
object
required

JSON Schema for agent output

​
canStream
boolean | null
required

Whether agent supports streaming

​
canChat
boolean | null
required

Whether agent supports chat interface

​
discoveredAt
string | null
required

When the agent was discovered (for custom agents)

​
createdBy
string | null
required

User who created the agent

​
createdAt
string
required

Creation timestamp

​
updatedAt
string
required

Last update timestamp