Prompt types
Every prompt has apromptType that describes the kind of output it is intended to produce.
Choosing the correct type keeps your vault organized and lets the API surface the right generation options when you use a prompt to queue a job.
Key fields
Prompt object
When you read a prompt from the API, the returned object includes the following fields:Prompt lifecycle
Working with a prompt follows a predictable three-step pattern:- Create — Send a
POST /api/v1/promptsrequest with your instruction text, type, and any model configuration. The API returns a prompt object with a uniqueid. - Save to a vault — Prompts are saved into a vault automatically when you supply a
vaultId, or land in your General vault by default. You can move them between vaults at any time. - Use in a generation — Reference the prompt’s text and configuration when calling
POST /api/v1/generations. The generation runs asynchronously and saves its output back to a vault.