Files
openrouter-python-sdk-retry…/docs/sdks/completions/README.md
T
Matt Apperson 5fc522c72f Initial commit: OpenRouter Python SDK
Auto-generated Python SDK for OpenRouter API, providing comprehensive client library with:
- Chat completions and streaming support
- Embeddings API
- Model and provider information
- API key management
- Analytics and usage tracking
- OAuth authentication flows
- Full type hints and error handling
2025-11-13 10:56:25 -05:00

13 KiB
Raw Blame History

Completions

(completions)

Overview

Available Operations

generate

Creates a completion for the provided prompt and parameters. Supports both streaming and non-streaming modes.

Example Usage

from openrouter import OpenRouter
import os


with OpenRouter(
    api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router:

    res = open_router.completions.generate(prompt=[], stream=False)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
prompt models.Prompt ✔️ N/A
model Optional[str] N/A
models List[str] N/A
best_of OptionalNullable[int] N/A
echo OptionalNullable[bool] N/A
frequency_penalty OptionalNullable[float] N/A
logit_bias Dict[str, float] N/A
logprobs OptionalNullable[int] N/A
max_tokens OptionalNullable[int] N/A
n OptionalNullable[int] N/A
presence_penalty OptionalNullable[float] N/A
seed OptionalNullable[int] N/A
stop OptionalNullable[models.CompletionCreateParamsStop] N/A
stream Optional[bool] N/A
stream_options OptionalNullable[models.StreamOptions] N/A
suffix OptionalNullable[str] N/A
temperature OptionalNullable[float] N/A
top_p OptionalNullable[float] N/A
user Optional[str] N/A
metadata Dict[str, str] N/A
response_format OptionalNullable[models.CompletionCreateParamsResponseFormatUnion] N/A
retries Optional[utils.RetryConfig] Configuration to override the default retry behavior of the client.

Response

models.CompletionResponse

Errors

Error Type Status Code Content Type
errors.ChatError 400, 401, 429 application/json
errors.ChatError 500 application/json
errors.OpenRouterDefaultError 4XX, 5XX */*