Skip to navigation
SDK ReferenceAgentLearning

Get Agent Learning State

Get Agent Learning State. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns 403 permission_denied. To get access, contact support@getzep.com.

Authentication

AuthorizationApi-Key

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

Path parameters

agent_uuidstringRequired
Agent UUID

Query parameters

task_familystringRequiredformat: "^[a-z0-9][a-z0-9._/-]{0,127}$"
Task family

Response

OK
approvalstringOptional
The service returns the approval mode. Valid values are auto and manual. The default is auto.
compilation_modestringOptional

The service returns the Agent’s learning mode. Valid values are scheduled, manual, and on_close. The default is scheduled.

compilation_pendingbooleanOptional
The service sets this to true while a learning run waits to start or runs. Skills from that run are not yet available.
eligible_trace_countintegerOptional
The service reports the number of Traces that can support learning.
minimum_attempt_familiesintegerOptional

The service reports how many distinct attempt families a run needs. The default is 3 in scheduled mode and 1 in on_close mode.

next_stepstringOptional
The service returns text that tells a person what to do next. Code must not treat this text as a stable value.
required_evaluationslist of stringsOptional
The service returns the evaluations that each candidate must pass.
task_familystringOptional
The service returns the category whose learning progress this record describes.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error