Get Agent context | Zep Documentation

{
  "context": "A customer reports a duplicate charge.",
  "objective": "Refund a duplicate charge.",
  "partial_sources": [
    {
      "reason": "acknowledged_gap",
      "source": "trace",
      "task_uuid": "6a906e70-50ca-4e43-a874-5fcae02a71fa"
    }
  ],
  "request_id": "6a906e70-50ca-4e43-a874-5fcae02a71fa",
  "skipped": [
    {
      "reason": "acknowledged_gap",
      "skill_uuid": "6a906e70-50ca-4e43-a874-5fcae02a71fa",
      "version": 1
    }
  ],
  "snapshot": [
    {
      "artifact_sha256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
      "evidence_citations": [
        "event-001"
      ],
      "evidence_counts": {
        "contradicting": 1,
        "neutral": 1,
        "supporting": 1
      },
      "rank": 1,
      "skill_uuid": "6a906e70-50ca-4e43-a874-5fcae02a71fa",
      "version": 1
    }
  ],
  "task_family": "support/refund",
  "trace_uuid": "6a906e70-50ca-4e43-a874-5fcae02a71fa",
  "truncated": false
}

Get Agent context. 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

Request

Objective or Trace and context constraints

environmentslist of objectsOptional

The developer supplies environment names used by the Skill. At most 32.

kindstringOptional<=64 characters

The developer supplies a Skill kind. At most 64.

max_charactersintegerOptional1-50000

The developer sets the maximum number of characters in the context response.

modelslist of objectsOptional

The developer supplies models used for this evaluation. At most 32.

objectivestringOptional<=512 characters

The developer supplies the task-instance objective. At most 512.

task_familystringOptional<=128 characters

The developer supplies the task-family slug. At most 128.

toolslist of objectsOptional

The developer supplies tool names used by the Skill. At most 32.

trace_uuidstringOptional

The developer supplies the UUID of the source Trace.

Response

contextstringOptional

The service returns context for this result.

objectivestringOptional

The service returns the task-instance objective.

partial_sourceslist of objectsOptional

The service returns sources that it could not include in full.

request_idstringOptional

The service returns the UUID that identifies this context request.

skippedlist of objectsOptional

The service returns the Skills that it skipped.

snapshotlist of objectsOptional

The service returns a snapshot of the source data.

task_familystringOptional

The service returns the task-family slug.

trace_uuidstringOptional

The service returns the UUID of the source Trace.

truncatedbooleanOptional

The service sets this to true when the context exceeds its output limit.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

503

Service Unavailable Error