For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
This page is for version v4 (default).
For other versions, use one of these documentation indexes:
- v4 (default): https://help.getzep.com/v4/llms.txt
- v3: https://help.getzep.com/v3/llms.txt
- v2: https://help.getzep.com/v2/llms.txt
Type “Api-Key” followed by a space and the project API key.
Path parameters
agent_uuidstringRequired
Agent UUID
Request
Request body
objectivestringRequired
The developer describes the task instance. The create request requires a non-empty value but
does not check its size. An AppendAgentTraceEventRequest returns 400 if the Trace objective
exceeds 8 KiB (8,192 bytes).
learn_frombooleanOptional
The developer supplies whether eligible evidence may participate in learning. Defaults to true.
metadatamap from strings to anyOptional
Developer metadata used to organize and filter Traces.
parent_trace_uuidstringOptional
The developer supplies the parent Trace UUID when this attempt retries an earlier attempt.
task_familystringOptional
The developer may set a task-family slug. If the developer omits it, Agent Skills assigns the
Trace to a task family automatically. If Agent Skills cannot assign a task family, the
task_family_inference field of the Trace is unassigned. A BYOM configuration requires task_family. A
strict-residency deployment requires task_family. Without task_family in either case, the
API returns 400 invalid_request with the message task_family is required. The slug must
contain 1 to 128 lowercase letters, digits, ., _, /, or -. It must start with a
lowercase letter or digit.
trace_idstringOptional
The developer may set an identifier that is unique within the Agent. A retry with the same create parameters returns 200 and the existing Trace. Different parameters return 409.
Response
OK
abandoned_atstringOptional
The time the Trace was abandoned.
agent_uuidstringOptional
The service returns the owning Agent UUID.
attempt_family_uuidstringOptional
The service returns the stable retry-family identity shared by attempts.
closed_atstringOptional
The time the Trace closed.
created_atstringOptional
The time the Trace was created.
internalobjectOptional
Server-owned fields that are not part of the top-level capture contract.
learn_frombooleanOptional
The service returns whether eligible evidence may participate in learning.
learn_from_reasonstringOptional
The service returns why the Trace is not eligible for learning, when it is not eligible.
metadatamap from strings to anyOptional
Developer metadata used for exact containment filters.
objectivestringOptional
The service returns the task-instance objective captured for this attempt.
outcomeenumOptional
The service returns the task outcome that the developer recorded. Valid values are succeeded, failed, partial, abandoned, and unknown.
Allowed values:
parent_trace_uuidstringOptional
The service returns the parent attempt when this Trace is a retry.
revisionintegerOptional
The service returns the current revision for the next update or lifecycle command.
sourceobjectOptional
The source record for an imported Trace.
statusenumOptional
The service returns the current lifecycle state. Valid values are open, closing, closed, abandoned, and deleted.
Allowed values:
task_familystringOptional
The service returns the declared or assigned task-family slug, when one
is available.
task_family_inferenceobjectOptional
The service returns the latest classification result. Its state is pending, assigned, or unassigned. It is absent if classification did not run for this Trace.
task_family_sourcestringOptional
The service returns how it selected the task family. Valid values are
declared, import_rule, and inferred.
trace_idstringOptional
The developer may set an identifier that is unique within the Agent. A retry with the same create parameters returns 200 and the existing Trace. Different parameters return 409.
updated_atstringOptional
The time the Trace was last updated.
uuidstringOptional
The service returns the stable Trace UUID.
verificationenumOptional
The service returns how the outcome was verified. Valid values are none, agent, tool, customer, and external.
