OpenResponsesOptions

Namespace: Vercel.AI.OpenResponses

public sealed class OpenResponsesOptions

Open Responses settings. The default origin is the AI Gateway Open Responses route.

Inheritance: object

View source

Properties

ApiKey

public string? ApiKey { get; set; }

Explicit key.

Value: string

View source

ApiKeyEnvironmentVariable

public string ApiKeyEnvironmentVariable { get; set; }

Environment variable.

Value: string

View source

BaseUrl

public string BaseUrl { get; set; }

API origin. Requests are posted to {BaseUrl}/responses.

Value: string

View source

Extensions

public IReadOnlyList<OpenResponsesExtension>? Extensions { get; set; }

Codecs for Open Responses extension tools, items, and streaming events. Experimental.

Value: IReadOnlyList<OpenResponsesExtension>

View source

GetResponseErrorMetadata

public Func<JsonElement, OpenResponsesErrorMetadata?>? GetResponseErrorMetadata { get; set; }

Reads HTTP status and retry metadata from an endpoint-specific response error object. Applies to both generation and streaming errors. Maps to getResponseErrorMetadata.

Value: Func<JsonElement, OpenResponsesErrorMetadata>

View source

Headers

public IReadOnlyDictionary<string, string>? Headers { get; set; }

Extra headers sent with every request.

Value: IReadOnlyDictionary<string, string>

View source

Name

public string Name { get; set; }

Provider name. It is the key for provider options and provider metadata. Maps to name.

Value: string

View source

StrictResponseInput

public bool StrictResponseInput { get; set; }

Whether to serialize assistant history using the strict OpenAI Responses input schemas. Assistant messages without an item ID are sent as easy input messages. Maps to strictResponseInput.

Value: bool

View source