Work Memory
2 operations.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/work-memory/runs | List runs the delegating run can recall |
| GET | /api/v1/work-memory/runs/{agentRunId} | Read one recallable run |
List runs the delegating run can recall
GET /api/v1/work-memory/runs
Available only to a work-memory delegate's run-bound credential. The recallable runs are derived from the delegating run: the same coordinator Agent, the same Project and Environment or the same Organization and platform user, and the same external-subject binding. Newest first.
Parameters
query
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List runs the delegating run can recall. |
cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List runs the delegating run can recall. |
createdAfter | string | optional | Only recalls runs created at or after this timestamp. |
createdBefore | string | optional | Only recalls runs created before this timestamp. |
states | array<"completed" | "failed" | "canceled" | "expired"> | optional | Filters runs to the supplied set of lifecycle states. Applies to List runs the delegating run can recall. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — runs: array<object> (required); pagination: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service 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 delegating 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 delegating run.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
agentRunId | string | required | Identifies the agent run whose state or history is addressed. Applies to Read one recallable run. |
query
| Name | Type | Required | Description |
|---|---|---|---|
view | "summary" | "transcript" | optional | Selects the full request and final result (summary) or also a transcript page (transcript). |
transcriptOffset | integer | optional | Index of the first transcript entry to return with view=transcript. |
transcriptLimit | integer | optional | Maximum number of transcript entries to return with view=transcript. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — run: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |