Completions | OpenRouter Python SDK | OpenRouter

The Python SDK and docs are currently in beta. Report issues on GitHub.

(completions)

Overview

Available Operations

generate - Create a completion

generate

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

Example Usage

1 from openrouter import OpenRouter
2 import os
3 
4 with OpenRouter(
5     api_key=os.getenv("OPENROUTER_API_KEY", ""),
6 ) as open_router:
7 
8     res = open_router.completions.generate(prompt=[], stream=False)
9 
10     # Handle response
11     print(res)

Parameters

Parameter	Type	Required	Description
`prompt`	components.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[components.CompletionCreateParamsStop]	➖	N/A
`stream`	Optional[bool]	➖	N/A
`stream_options`	OptionalNullable[components.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[components.CompletionCreateParamsResponseFormatUnion]	➖	N/A
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

components.CompletionResponse

Errors

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