Presets - Python SDK
Presets - Python SDK
Presets - Python SDK
The Python SDK and docs are currently in beta. Report issues on GitHub.
Presets endpoints
Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. messages, stream, prompt) are silently ignored.
1 from openrouter import OpenRouter 2 import os 3 4 with OpenRouter( 5 http_referer="<value>", 6 x_open_router_title="<value>", 7 x_open_router_categories="<value>", 8 api_key=os.getenv("OPENROUTER_API_KEY", ""), 9 ) as open_router: 10 11 res = open_router.presets.create_presets_chat_completions(slug="my-preset", messages=[ 12 { 13 "content": "You are a helpful assistant.", 14 "role": "system", 15 }, 16 { 17 "content": "Hello!", 18 "role": "user", 19 }, 20 ], model="openai/gpt-5.4", stream=False, temperature=0.7) 21 22 # Handle response 23 print(res)
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
slug | str | ✔️ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset |
messages | List[components.ChatMessages] | ✔️ | List of messages for the conversation | [{"content": "Hello!","role": "user"}] |
http_referer | Optional[str] | ➖ | The app identifier should be your app’s URL and is used as the primary identifier for rankings. This is used to track API usage per application. | |
x_open_router_title | Optional[str] | ➖ | The app display name allows you to customize how your app appears in OpenRouter’s dashboard. | |
x_open_router_categories | Optional[str] | ➖ | Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings. | |
cache_control | Optional[components.AnthropicCacheControlDirective] | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models. | {"type": "ephemeral"} |
debug | Optional[components.ChatDebugOptions] | ➖ | Debug options for inspecting request transformations (streaming only) | {"echo_upstream_body": true} |
frequency_penalty | OptionalNullable[float] | ➖ | Frequency penalty (-2.0 to 2.0) | 0 |
image_config | Dict[str, components.ImageConfig] | ➖ | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | {"aspect_ratio": "16:9","quality": "high"} |
logit_bias | Dict[str, float] | ➖ | Token logit bias adjustments | {"50256": -100} |
logprobs | OptionalNullable[bool] | ➖ | Return log probabilities | false |
max_completion_tokens | OptionalNullable[int] | ➖ | Maximum tokens in completion | 100 |
max_tokens | OptionalNullable[int] | ➖ | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 |
metadata | Dict[str, str] | ➖ | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | {"session_id": "session-456","user_id": "user-123"} |
modalities | List[components.Modality] | ➖ | Output modalities for the response. Supported values are “text”, “image”, and “audio”. | [ “text”, “image” ] |
model | Optional[str] | ➖ | Model to use for completion | openai/gpt-4 |
models | List[str] | ➖ | Models to use for completion | [ “openai/gpt-4”, “openai/gpt-4o” ] |
parallel_tool_calls | OptionalNullable[bool] | ➖ | Whether to enable parallel function calling during tool use. When true, the model may generate multiple tool calls in a single response. | true |
plugins | List[components.ChatRequestPlugin] | ➖ | Plugins you want to enable for this request, including their settings. | |
presence_penalty | OptionalNullable[float] | ➖ | Presence penalty (-2.0 to 2.0) | 0 |
provider | OptionalNullable[components.ProviderPreferences] | ➖ | When multiple model providers are available, optionally indicate your routing preference. | {"allow_fallbacks": true} |
reasoning | Optional[components.ChatRequestReasoning] | ➖ | Configuration options for reasoning models | {"effort": "medium","summary": "concise"} |
response_format | Optional[components.ResponseFormat] | ➖ | Response format configuration | {"type": "json_object"} |
seed | OptionalNullable[int] | ➖ | Random seed for deterministic outputs | 42 |
service_tier | OptionalNullable[components.ChatRequestServiceTier] | ➖ | The service tier to use for processing this request. | auto |
session_id | Optional[str] | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | |
stop | OptionalNullable[components.Stop] | ➖ | Stop sequences (up to 4) | [ "" ] |
stop_server_tools_when | List[components.StopServerToolsWhenCondition] | ➖ | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides max_tool_calls. | [{"step_count": 5,"type": "step_count_is"},{"max_cost_in_dollars": 0.5,"type": "max_cost"}] |
stream | Optional[bool] | ➖ | Enable streaming response | false |
stream_options | OptionalNullable[components.ChatStreamOptions] | ➖ | Streaming configuration options | {"include_usage": true} |
temperature | OptionalNullable[float] | ➖ | Sampling temperature (0-2) | 0.7 |
tool_choice | Optional[components.ChatToolChoice] | ➖ | Tool choice configuration | auto |
tools | List[components.ChatFunctionTool] | ➖ | Available tools for function calling | [{"function": {"description": "Get weather","name": "get_weather"},“type”: “function” } ] |
top_logprobs | OptionalNullable[int] | ➖ | Number of top log probabilities to return (0-20) | 5 |
top_p | OptionalNullable[float] | ➖ | Nucleus sampling parameter (0-1) | 1 |
trace | Optional[components.TraceConfig] | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | {"trace_id": "trace-abc123","trace_name": "my-app-trace"} |
user | Optional[str] | ➖ | Unique user identifier | user-123 |
retries | Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
components.CreatePresetFromInferenceResponse
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.BadRequestResponseError | 400 | application/json |
| errors.UnauthorizedResponseError | 401 | application/json |
| errors.ForbiddenResponseError | 403 | application/json |
| errors.NotFoundResponseError | 404 | application/json |
| errors.ConflictResponseError | 409 | application/json |
| errors.InternalServerResponseError | 500 | application/json |
| errors.OpenRouterDefaultError | 4XX, 5XX | */* |
Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. messages, stream, prompt) are silently ignored.
1 from openrouter import OpenRouter 2 import os 3 4 with OpenRouter( 5 http_referer="<value>", 6 x_open_router_title="<value>", 7 x_open_router_categories="<value>", 8 api_key=os.getenv("OPENROUTER_API_KEY", ""), 9 ) as open_router: 10 11 res = open_router.presets.create_presets_messages(slug="my-preset", messages=[ 12 { 13 "content": "Hello!", 14 "role": "user", 15 }, 16 ], model="anthropic/claude-4.6-sonnet", max_tokens=1024, system="You are a helpful assistant.") 17 18 # Handle response 19 print(res)
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
slug | str | ✔️ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset |
messages | List[components.MessagesMessageParam] | ✔️ | N/A | |
model | str | ✔️ | N/A | |
http_referer | Optional[str] | ➖ | The app identifier should be your app’s URL and is used as the primary identifier for rankings. This is used to track API usage per application. | |
x_open_router_title | Optional[str] | ➖ | The app display name allows you to customize how your app appears in OpenRouter’s dashboard. | |
x_open_router_categories | Optional[str] | ➖ | Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings. | |
cache_control | Optional[components.AnthropicCacheControlDirective] | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models. | {"type": "ephemeral"} |
context_management | OptionalNullable[components.ContextManagement] | ➖ | N/A | |
max_tokens | Optional[int] | ➖ | N/A | |
metadata | Optional[components.Metadata] | ➖ | N/A | |
models | List[str] | ➖ | N/A | |
output_config | Optional[components.MessagesOutputConfig] | ➖ | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | {"effort": "medium"} |
plugins | List[components.MessagesRequestPlugin] | ➖ | Plugins you want to enable for this request, including their settings. | |
provider | OptionalNullable[components.ProviderPreferences] | ➖ | When multiple model providers are available, optionally indicate your routing preference. | {"allow_fallbacks": true} |
service_tier | Optional[str] | ➖ | N/A | |
session_id | Optional[str] | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | |
speed | OptionalNullable[components.Speed] | ➖ | N/A | standard |
stop_sequences | List[str] | ➖ | N/A | |
stop_server_tools_when | List[components.StopServerToolsWhenCondition] | ➖ | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides max_tool_calls. | [{"step_count": 5,"type": "step_count_is"},{"max_cost_in_dollars": 0.5,"type": "max_cost"}] |
stream | Optional[bool] | ➖ | N/A | |
system | Optional[components.System] | ➖ | N/A | |
temperature | Optional[float] | ➖ | N/A | |
thinking | Optional[components.Thinking] | ➖ | N/A | |
tool_choice | Optional[components.ToolChoice] | ➖ | N/A | |
tools | List[components.MessagesRequestToolUnion] | ➖ | N/A | |
top_k | Optional[int] | ➖ | N/A | |
top_p | Optional[float] | ➖ | N/A | |
trace | Optional[components.TraceConfig] | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | {"trace_id": "trace-abc123","trace_name": "my-app-trace"} |
user | Optional[str] | ➖ | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | |
retries | Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
components.CreatePresetFromInferenceResponse
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.BadRequestResponseError | 400 | application/json |
| errors.UnauthorizedResponseError | 401 | application/json |
| errors.ForbiddenResponseError | 403 | application/json |
| errors.NotFoundResponseError | 404 | application/json |
| errors.ConflictResponseError | 409 | application/json |
| errors.InternalServerResponseError | 500 | application/json |
| errors.OpenRouterDefaultError | 4XX, 5XX | */* |
Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. messages, stream, prompt) are silently ignored.
1 from openrouter import OpenRouter 2 import os 3 4 with OpenRouter( 5 http_referer="<value>", 6 x_open_router_title="<value>", 7 x_open_router_categories="<value>", 8 api_key=os.getenv("OPENROUTER_API_KEY", ""), 9 ) as open_router: 10 11 res = open_router.presets.create_presets_responses(slug="my-preset", input="Hello!", instructions="You are a helpful assistant.", model="openai/gpt-5.4", service_tier="auto", stream=False) 12 13 # Handle response 14 print(res)
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
slug | str | ✔️ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset |
http_referer | Optional[str] | ➖ | The app identifier should be your app’s URL and is used as the primary identifier for rankings. This is used to track API usage per application. | |
x_open_router_title | Optional[str] | ➖ | The app display name allows you to customize how your app appears in OpenRouter’s dashboard. | |
x_open_router_categories | Optional[str] | ➖ | Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings. | |
background | OptionalNullable[bool] | ➖ | N/A | |
cache_control | Optional[components.AnthropicCacheControlDirective] | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models. | {"type": "ephemeral"} |
frequency_penalty | OptionalNullable[float] | ➖ | N/A | |
image_config | Dict[str, components.ImageConfig] | ➖ | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | {"aspect_ratio": "16:9","quality": "high"} |
include | List[components.ResponseIncludesEnum] | ➖ | N/A | |
input | Optional[components.InputsUnion] | ➖ | Input for a response request - can be a string or array of items | [{"content": "What is the weather today?","role": "user"}] |
instructions | OptionalNullable[str] | ➖ | N/A | |
max_output_tokens | OptionalNullable[int] | ➖ | N/A | |
max_tool_calls | OptionalNullable[int] | ➖ | N/A | |
metadata | Dict[str, str] | ➖ | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | {"session_id": "abc-def-ghi","user_id": "123"} |
modalities | List[components.OutputModalityEnum] | ➖ | Output modalities for the response. Supported values are “text” and “image”. | [ “text”, “image” ] |
model | Optional[str] | ➖ | N/A | |
models | List[str] | ➖ | N/A | |
parallel_tool_calls | OptionalNullable[bool] | ➖ | N/A | |
plugins | List[components.ResponsesRequestPlugin] | ➖ | Plugins you want to enable for this request, including their settings. | |
presence_penalty | OptionalNullable[float] | ➖ | N/A | |
previous_response_id | OptionalNullable[str] | ➖ | N/A | |
prompt | OptionalNullable[components.StoredPromptTemplate] | ➖ | N/A | {"id": "prompt-abc123","variables": {"name": "John"}} |
prompt_cache_key | OptionalNullable[str] | ➖ | N/A | |
provider | OptionalNullable[components.ProviderPreferences] | ➖ | When multiple model providers are available, optionally indicate your routing preference. | {"allow_fallbacks": true} |
reasoning | OptionalNullable[components.ReasoningConfig] | ➖ | Configuration for reasoning mode in the response | {"effort": "medium","summary": "auto"} |
safety_identifier | OptionalNullable[str] | ➖ | N/A | |
service_tier | OptionalNullable[components.ResponsesRequestServiceTier] | ➖ | N/A | |
session_id | Optional[str] | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | |
stop_server_tools_when | List[components.StopServerToolsWhenCondition] | ➖ | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides max_tool_calls. | [{"step_count": 5,"type": "step_count_is"},{"max_cost_in_dollars": 0.5,"type": "max_cost"}] |
stream | Optional[bool] | ➖ | N/A | |
temperature | OptionalNullable[float] | ➖ | N/A | |
text | Optional[components.TextExtendedConfig] | ➖ | Text output configuration including format and verbosity | {"format": {"type": "text"},“verbosity”: “medium” } |
tool_choice | Optional[components.OpenAIResponsesToolChoiceUnion] | ➖ | N/A | auto |
tools | List[components.ResponsesRequestToolUnion] | ➖ | N/A | |
top_k | Optional[int] | ➖ | N/A | |
top_logprobs | OptionalNullable[int] | ➖ | N/A | |
top_p | OptionalNullable[float] | ➖ | N/A | |
trace | Optional[components.TraceConfig] | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | {"trace_id": "trace-abc123","trace_name": "my-app-trace"} |
truncation | OptionalNullable[components.OpenAIResponsesTruncation] | ➖ | N/A | auto |
user | Optional[str] | ➖ | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | |
retries | Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
components.CreatePresetFromInferenceResponse
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.BadRequestResponseError | 400 | application/json |
| errors.UnauthorizedResponseError | 401 | application/json |
| errors.ForbiddenResponseError | 403 | application/json |
| errors.NotFoundResponseError | 404 | application/json |
| errors.ConflictResponseError | 409 | application/json |
| errors.InternalServerResponseError | 500 | application/json |
| errors.OpenRouterDefaultError | 4XX, 5XX | */* |