OAuth | OpenRouter Python SDK | OpenRouter

(o_auth)

Overview

OAuth authentication endpoints

Available Operations

exchange_auth_code_for_api_key - Exchange authorization code for API key
create_auth_code - Create authorization code

exchange_auth_code_for_api_key

Exchange an authorization code from the PKCE flow for a user-controlled API key

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.o_auth.exchange_auth_code_for_api_key(code="auth_code_abc123def456", code_verifier="dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", code_challenge_method="S256")
9 
10     # Handle response
11     print(res)

Parameters

Parameter	Type	Required	Description	Example
`code`	str	✔️	The authorization code received from the OAuth redirect	auth_code_abc123def456
`code_verifier`	Optional[str]	➖	The code verifier if code_challenge was used in the authorization request	dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk
`code_challenge_method`	OptionalNullable[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod]	➖	The method used to generate the code challenge	S256
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.ExchangeAuthCodeForAPIKeyResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestResponseError	400	application/json
errors.ForbiddenResponseError	403	application/json
errors.InternalServerResponseError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	/

create_auth_code

Create an authorization code for the PKCE flow to generate a user-controlled API key

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.o_auth.create_auth_code(callback_url="https://myapp.com/auth/callback", code_challenge="E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM", code_challenge_method="S256", limit=100)
9 
10     # Handle response
11     print(res)

Parameters

Parameter	Type	Required	Description	Example
`callback_url`	str	✔️	The callback URL to redirect to after authorization. Note, only https URLs on ports 443 and 3000 are allowed.	https://myapp.com/auth/callback
`code_challenge`	Optional[str]	➖	PKCE code challenge for enhanced security	E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM
`code_challenge_method`	Optional[operations.CreateAuthKeysCodeCodeChallengeMethod]	➖	The method used to generate the code challenge	S256
`limit`	Optional[float]	➖	Credit limit for the API key to be created	100
`expires_at`	date	➖	Optional expiration time for the API key to be created
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.CreateAuthKeysCodeResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestResponseError	400	application/json
errors.UnauthorizedResponseError	401	application/json
errors.InternalServerResponseError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	/