Documentation menu

Work Memory

2 operations.

MethodEndpointDescription
GET/api/v1/work-memory/runsList runs the recalling run can recall
GET/api/v1/work-memory/runs/{agentRunId}Read one recallable run

List runs the recalling run can recall

GET /api/v1/work-memory/runs

Available only to the run-bound credential of an Agent granted work-memory:read. The recallable runs are derived from the recalling run: the same Agent, the same Project and Environment, and the same external-subject binding. Newest first.

Parameters

query

NameTypeRequiredDescription
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List runs the recalling run can recall.
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List runs the recalling run can recall.
createdAfterstringoptionalOnly recalls runs created at or after this timestamp.
createdBeforestringoptionalOnly recalls runs created before this timestamp.
statesarray<"completed" | "failed" | "canceled" | "expired">optionalFilters runs to the supplied set of lifecycle states. Applies to List runs the recalling run can recall.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — runs: array<object> (required); pagination: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)

Read one recallable run

GET /api/v1/work-memory/runs/{agentRunId}

Returns the request and final result of a run inside the recalling run's recall scope, and with view=transcript a page of its step-by-step transcript. A run outside the scope is reported as not found. Every read is recorded against the recalling run.

Parameters

path

NameTypeRequiredDescription
agentRunIdstringrequiredIdentifies the agent run whose state or history is addressed. Applies to Read one recallable run.

query

NameTypeRequiredDescription
view"summary" | "transcript"optionalSelects the full request and final result (summary) or also a transcript page (transcript).
transcriptOffsetintegeroptionalIndex of the first transcript entry to return with view=transcript.
transcriptLimitintegeroptionalMaximum number of transcript entries to return with view=transcript.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — run: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)