Skip to main content
POST
Archive agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Agent ID

Response

Agent archived successfully

id
string
required

Agent ID

organizationId
string
required

Organization ID

name
string
required

Agent name

Example:

"Customer Support Agent"

instructions
string
required

Agent instructions

status
enum<string>
required

Agent status

Available options:
draft,
active,
archived
version
number
required

Agent version

modelConfig
object
required

Model configuration

createdAt
string<date-time>
required

Created at timestamp

updatedAt
string<date-time>
required

Updated at timestamp

description
string | null

Agent description

policy
string | null

Agent policy (business rules)

voiceConfig
object

Voice configuration

memoryConfig
object

Memory configuration

metadata
object | null

Additional metadata

knowledgeBaseConfig
object | null

Knowledge base configuration for RAG

createdBy
string | null

Created by user ID