Prompts

client.prompts saves prompt templates you reuse across turns. Write {{variable}} placeholders in the template, then run it by passing its promptId and variables to chat(), completion(), or object(). To learn when a saved prompt helps, read Prompts.

const prompt = await client.prompts.create({
  name: "Release note",
  template: "Write a release note for {{feature}}.",
});

const result = await client.completion({
  agentId,
  promptId: prompt.id,
  variables: { feature: "faster search" },
});
console.log(await result.text);

Every method takes one input object and accepts an optional abortSignal.

Templates

• Variable names match [A-Za-z_][A-Za-z0-9_]*. A template has up to 10 different variables and 10,240 characters.
• Blazing Agents reads the variables from the template and returns them in variables.
• When you run a prompt, pass every variable and no others, or the turn fails with prompt_variable_missing or prompt_variable_unknown.
• Only the filled-in text is saved in the session, so editing or deleting a prompt later does not change past conversations.

Available operations

Methods

create()

Saves a prompt template.

Signature: create(input: CreatePromptBody & ResourceRequestOptions): Promise<PromptResponse>

const prompt = await client.prompts.create({
  name: "Release note",
  template: "Write a release note for {{feature}} aimed at {{audience}}.",
  agentId,
});

Deleting the linked agent also deletes the prompt. Your tenant can hold up to 100 prompts. Returns PromptResponse. Errors: validation_failed, prompt_name_conflict, prompt_limit_reached, and not_found when the agent does not exist.

list()

Lists your prompts, most recently updated first.

Signature: list(input?: { userId?: string; agentId?: string } & ResourceRequestOptions): Promise<PromptsResponse>

const { prompts } = await client.prompts.list({ agentId });

The result is not paginated. Returns { prompts: PromptResponse[] }.

get()

Reads one prompt.

Signature: get(input: { promptId: string } & ResourceRequestOptions): Promise<PromptResponse>

const prompt = await client.prompts.get({ promptId });
console.log(prompt.variables);

Returns PromptResponse. Errors: validation_failed, not_found.

update()

Changes a prompt's name, template, agent link, or metadata.

Signature: update(input: UpdatePromptBody & { promptId: string } & ResourceRequestOptions): Promise<PromptResponse>

const prompt = await client.prompts.update({
  promptId,
  template: "Summarize {{feature}} for {{audience}}.",
});

Takes promptId plus any of name, template, agentId, and metadata, with at least one. Fields you leave out stay as they are; metadata replaces all metadata, and agentId: null removes the link. userId cannot change. The next turn that uses the prompt gets the new template.

Returns PromptResponse. Errors: validation_failed, prompt_name_conflict, not_found.

delete()

Deletes a prompt for good.

Signature: delete(input: { promptId: string } & ResourceRequestOptions): Promise<void>

await client.prompts.delete({ promptId });

Errors: validation_failed, not_found.

Response types

PromptResponse

PromptsResponse is { prompts: PromptResponse[] }.

Errors

Failures throw BlazingAgentsError. The prompt codes:

Next

• Prompts
• Client generation methods