ID string

The unique identifier of the prompt template to use.

Variables map[string, BetaResponsePromptVariableUnion]Optional

Optional map of values to substitute in for variables in your prompt. The substitution values can either be strings, or other Response input types like images or files.

One of the following:

string

type BetaResponseInputText struct{…}

A text input to the model.

Text string

The text input to the model.

Type InputText

The type of the input item. Always input_text.

PromptCacheBreakpoint BetaResponseInputTextPromptCacheBreakpointOptional

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

Mode Explicit

The breakpoint mode. Always explicit.

type BetaResponseInputImage struct{…}

An image input to the model. Learn about image inputs.

Detail BetaResponseInputImageDetail

The detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.

One of the following:

const BetaResponseInputImageDetailLow BetaResponseInputImageDetail = "low"

const BetaResponseInputImageDetailHigh BetaResponseInputImageDetail = "high"

const BetaResponseInputImageDetailAuto BetaResponseInputImageDetail = "auto"

const BetaResponseInputImageDetailOriginal BetaResponseInputImageDetail = "original"

Type InputImage

The type of the input item. Always input_image.

FileID stringOptional

The ID of the file to be sent to the model.

ImageURL stringOptional

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

formaturi

PromptCacheBreakpoint BetaResponseInputImagePromptCacheBreakpointOptional

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

Mode Explicit

The breakpoint mode. Always explicit.

type BetaResponseInputFile struct{…}

A file input to the model.

Type InputFile

The type of the input item. Always input_file.

Detail BetaResponseInputFileDetailOptional

The detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.

One of the following:

const BetaResponseInputFileDetailAuto BetaResponseInputFileDetail = "auto"

const BetaResponseInputFileDetailLow BetaResponseInputFileDetail = "low"

const BetaResponseInputFileDetailHigh BetaResponseInputFileDetail = "high"

FileData stringOptional

The content of the file to be sent to the model.

FileID stringOptional

The ID of the file to be sent to the model.

FileURL stringOptional

The URL of the file to be sent to the model.

formaturi

Filename stringOptional

The name of the file to be sent to the model.

PromptCacheBreakpoint BetaResponseInputFilePromptCacheBreakpointOptional

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

Mode Explicit

The breakpoint mode. Always explicit.

Version stringOptional

Optional version of the prompt template.