Actors

Actors are entities within the system, representing users, AI assistants, or tools capable of participating in threads and sending messages.

Actor object

Attributes

id

String

A unique identifier for the actor, used to distinguish it from other actors.

name

String

The name of the actor, which may represent a user, assistant, or tool.

metadata

ObjectOptional

An optional field containing additional metadata for the actor. This metadata can include any supplementary information required to identify or describe the actor.

type

Enum

Specifies the type of actor, which determines its role in the system.

created_at

Date

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

updated_at

Date

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

{
  "id": "act_Rm4Mnheq2bfEPhBhP7SY",
  "name": "John Doe",
  "type": "user",
  "metadata": {
    "email": "[email protected]",
    "other": "Additional metadata can be included here."
  },
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}

List actors

Retrieve a list of all actors currently defined in the system. Allows for optional filtering by various attributes.

Query Parameters

id

ObjectOptional

Filter actors by their unique identifiers.

created_at

ObjectOptional

Filter actors by their creation date.

updated_at

ObjectOptional

Filter actors by their last update date.

type

ObjectOptional

Filter actors by their type (e.g., user, assistant, tool).

GEThttps://api.metorial.com/actors
curl -X GET "https://api.metorial.com/actors?type=user" \
  -H "Authorization: Bearer metorial_sk_..."

Get actor

Retrieve detailed information about a single actor by their unique ID.

URL Parameters

actorId

String

A unique string identifier for an actor, used for retrieval and management operations.

GEThttps://api.metorial.com/actors/:actorId
curl -X GET "https://api.metorial.com/actors/act_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."