Agents

APIs for managing and retrieving agents configured in the Metorial dashboard. Agents serve as AI workflows for processing messages and generating responses.

Agent object

Attributes

id

String

A unique identifier for the agent, used for referencing the agent programmatically.

slug

String

A human-readable identifier for the agent, often used for easier reference in the dashboard or API.

name

String

The name of the agent, typically set by the user to describe its purpose or function.

created_at

Date

The date and time when the agent was created, recorded in ISO 8601 format.

updated_at

Date

The date and time when the agent was last updated, recorded in ISO 8601 format.

current_release

ObjectOptional

The most recent release of the agent, which will be used when initiating a new run. This property may be omitted if no release exists.

{
  "id": "agent_Rm4Mnheq2bfEPhBhP7SY",
  "slug": "my-agent",
  "name": "My Agent",
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "current_release": {
    "id": "rel_Rm4Mnheq2bfEPhBhP7SY",
    "agentId": "agent_Rm4Mnheq2bfEPhBhP7SY",
    "version": 1,
    "created_at": "2025-01-01T00:00:00.000Z"
  }
}

List agents

Retrieve a list of all agents available in your Metorial dashboard. This includes agents with their metadata and current release information.

Query Parameters

ids

ObjectOptional

Filter the agents by their unique IDs. Provide a comma-separated list of IDs to retrieve specific agents.

GEThttps://api.metorial.com/agents
curl -X GET "https://api.metorial.com/v1/agents" \
  -H "Authorization: Bearer metorial_sk_..."

Get agent

Retrieve detailed information about a single agent by specifying its unique identifier.

URL Parameters

agentId

String

A unique identifier for the agent, used for API interactions.

GEThttps://api.metorial.com/agents/:agentId
curl -X GET "https://api.metorial.com/v1/agents/agent_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."