Skip to content
Get started

Prompt Guide

Retrieve
client.models.promptGuide.retrieve(stringmodelID, PromptGuideRetrieveParams { projectId } query?, RequestOptionsoptions?): PromptGuideRetrieveResponse { promptGuide }
GET/models/{modelId}/prompt-guide
Update
client.models.promptGuide.update(stringmodelID, PromptGuideUpdateParams { promptGuide, projectId } params, RequestOptionsoptions?): PromptGuideUpdateResponse { promptGuide }
PUT/models/{modelId}/prompt-guide
ModelsExpand Collapse
PromptGuideRetrieveResponse { promptGuide }
promptGuide: PromptGuide { value }
value: string

The markdown prompt guide used as the system prompt for Prompt Spark.

Instructions and baked-in examples both live in this single markdown document. No runtime templating is performed on it.

PromptGuideUpdateResponse { promptGuide }
promptGuide: PromptGuide { value }
value: string

The markdown prompt guide used as the system prompt for Prompt Spark.

Instructions and baked-in examples both live in this single markdown document. No runtime templating is performed on it.