Create Agent | Zep Documentation

{
  "agent_id": "string",
  "created_at": "string",
  "deployment_id": "string",
  "description": "string",
  "memory_settings": {
    "admission_evaluation_requirements": [
      {
        "requirements": [
          {
            "evaluated_by": "string",
            "evaluator_version": "string",
            "result": "string",
            "controlled": true,
            "environment": "string"
          }
        ],
        "task_family": "string"
      }
    ],
    "approval": "manual",
    "approval_minimum_attempt_families": 1,
    "approval_required_tools": [
      "string"
    ],
    "auto_approval_task_families": [
      "string"
    ],
    "compilation_mode": "scheduled",
    "provisional_expiry_days": 1,
    "provisional_skill_limit": 1,
    "retention_days": 1
  },
  "metadata": {},
  "name": "string",
  "revision": 1,
  "security_domain": "string",
  "status": "active",
  "updated_at": "string",
  "uuid": "string",
  "version": "string"
}

Authentication

AuthorizationApi-Key

Type "Api-Key" followed by a space and the project API key.

Request

Request body

agent_idstringRequired<=500 characters

The developer-assigned Agent identifier, unique within the project.

namestringRequired

The Agent's display name.

security_domainstringRequired1-200 characters

The immutable boundary within which Skills may be synthesized. 1 to 200 characters of lowercase letters, digits, and the characters : . - _

deployment_idstringOptional

The customer deployment this Agent represents.

descriptionstringOptional

A human-readable description of the Agent.

memory_settingsobjectOptional

Agent Memory capture, compilation, and promotion settings.

metadatamap from strings to anyOptional

Developer metadata used to organize and filter Agents.

versionstringOptionalDefaults to default

The customer deployment version this Agent represents. If you omit it, the version is "default".

Response

Created

agent_idstringOptional

The developer-assigned Agent identifier, unique within the project.

created_atstringOptional

The time the Agent was created.

deployment_idstringOptional

The customer deployment this Agent represents.

descriptionstringOptional

A human-readable description of the Agent.

memory_settingsobjectOptional

Agent Memory capture, compilation, and promotion settings.

metadatamap from strings to anyOptional

Developer metadata used to organize and filter Agents.

namestringOptional

The Agent's display name.

revisionintegerOptional

The revision required by the next update or delete request.

security_domainstringOptional

The immutable boundary within which Skills may be synthesized.

statusenumOptional

The current lifecycle status.

Allowed values:

updated_atstringOptional

The time the Agent was last updated.

uuidstringOptional

The stable identifier of the Agent.

versionstringOptional

The customer deployment version this Agent represents.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error