Banks

Preview an operation's prompts (no LLM call)

Changed on

Render the exact system and user messages retain, consolidation or reflect would send for this bank, without calling an LLM, reading memories, or changing anything. Everything that shapes the prompt comes from the bank; the runtime data an operation would be given is a fixed placeholder. Both messages are returned: retain and consolidation keep their system prompt bank-agnostic (one provider-side cache serves every bank) and carry the mission in the user message instead.

post/v1/default/banks/{bank_id}/prompts/preview

Request

Path parameters

bank_idstring required

Headers

authorizationstring nullable

Request body

operation'retain' | 'consolidation' | 'reflect'

Which operation's prompts to render.

strategystring nullable

Name of a retain strategy to render under (a key of the bank's retain_strategies). Retain only. Omit it and the bank's retain_default_strategy applies, exactly as it does for a retain that names none.

Example request

{
  "operation": "retain"
}

Response

Successful Response

strategystring nullable

The retain strategy these prompts were rendered under, if any.

strategiesstring[]

Names of the bank's retain strategies, so a client can offer them without a second call.

response_schemaobject nullable

JSON schema the response is constrained to, when the operation constrains it.

skipped_reasonstring nullable

Why no prompt is sent, when the configuration means none is.

Changes