@archastro/sdk
    Preparing search index...

    Class AgentWorkingMemoryResource

    Index

    Constructors

    Methods

    Constructors

    Methods

    • Delete a working memory entry Permanently deletes a working memory entry from the agent. This action is irreversible. Expired entries can also be deleted — they are hidden from list results but persist until overwritten or deleted. Requires an app-scoped API key. The authenticated caller must be able to modify the agent that owns the entry. Returns 403 if the key is not app-scoped or the caller lacks modify access, and 404 if the agent or entry does not exist within the accessible scope.

      Parameters

      • agent: string

        Agent ID (agt_...) whose working memory entries to retrieve.

      • entry: string

        Working memory entry ID (amm_...) to delete.

      Returns Promise<void>

      Empty body. Returns HTTP 204 on success.

    • List working memory entries for an agent Returns a paginated list of working memory entries belonging to the specified agent. Entries are key-value pairs the agent stores for context between interactions. Results are ordered by creation time descending (newest first) and can be filtered with a substring search against the key name. Requires an app-scoped API key. The authenticated caller must have access to the app the agent belongs to. Returns 403 if the key is not app-scoped, and 404 if the agent does not exist within the accessible scope.

      Parameters

      • agent: string

        Agent ID (agt_...) whose working memory entries to retrieve.

      • Optionalparams: { page?: number; pageSize?: number; search?: string }

        Query parameters.

        • Optionalpage?: number

          Page number to retrieve, starting at 1. Defaults to 1.

        • OptionalpageSize?: number

          Number of entries to return per page. Defaults to 25.

        • Optionalsearch?: string

          Substring filter applied to entry keys (case-insensitive). Omit to return all keys.

      Returns Promise<WorkingMemoryEntryListResponse>

      Paginated list of working memory entries for the agent.

    • Update a working memory entry Updates the value and/or expiry of an existing working memory entry. Only the fields you supply are changed; omitted fields retain their current values. The entry key cannot be changed after creation — delete the entry and let the agent (or a future create call) write a new one instead. Pass expires_at as null to remove the expiry so the entry no longer expires. Expired entries can still be updated; they stay hidden from list results until their expiry is in the future again. Requires an app-scoped API key. The authenticated caller must be able to modify the agent that owns the entry. Returns 403 if the key is not app-scoped or the caller lacks modify access, and 404 if the agent or entry does not exist within the accessible scope.

      Parameters

      • agent: string

        Agent ID (agt_...) whose working memory entries to retrieve.

      • entry: string

        Working memory entry ID (amm_...) to update.

      • input: { expires_at?: string; value?: string }

        Request body.

        • Optionalexpires_at?: string

          New expiry for the entry (ISO 8601). Pass null to remove the expiry so the entry never expires. Omit to keep the current expiry.

        • Optionalvalue?: string

          Replacement string value to store under the entry's key. Maximum 65,536 characters.

      Returns Promise<WorkingMemoryEntry>

      The updated working memory entry.