openrouter-python-sdk-retry-errors/docs/sdks/apikeys

APIKeys

(api_keys)

Overview

API key management endpoints

Available Operations

• list - List API keys
• create - Create a new API key
• update - Update an API key
• delete - Delete an API key
• get - Get a single API key
• get_current_key_metadata - Get current API key

list

List all API keys for the authenticated user. Provisioning key required.

Example Usage

from openrouter import OpenRouter
import os


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

    res = open_router.api_keys.list(include_disabled="false", offset="0")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
include_disabled	Optional[str]	➖	Whether to include disabled API keys in the response	false
offset	Optional[str]	➖	Number of API keys to skip for pagination	0
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.ListResponse

Errors

Error Type	Status Code	Content Type
errors.UnauthorizedResponseError	401	application/json
errors.TooManyRequestsResponseError	429	application/json
errors.InternalServerResponseError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	*/*

create

Create a new API key for the authenticated user. Provisioning key required.

Example Usage

from openrouter import OpenRouter
import os


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

    res = open_router.api_keys.create(name="My New API Key")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
name	str	✔️	Name for the new API key	My New API Key
limit	OptionalNullable[float]	➖	Optional spending limit for the API key in USD	50
limit_reset	OptionalNullable[operations.CreateKeysLimitReset]	➖	Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.	monthly
include_byok_in_limit	Optional[bool]	➖	Whether to include BYOK usage in the limit	true
expires_at	date	➖	Optional ISO 8601 UTC timestamp when the API key should expire. Must be UTC, other timezones will be rejected	2027-12-31T23:59:59Z
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.CreateKeysResponse

Errors

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

update

Update an existing API key. Provisioning key required.

Example Usage

from openrouter import OpenRouter
import os


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

    res = open_router.api_keys.update(hash="f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
hash	str	✔️	The hash identifier of the API key to update	f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943
name	Optional[str]	➖	New name for the API key	Updated API Key Name
disabled	Optional[bool]	➖	Whether to disable the API key	false
limit	OptionalNullable[float]	➖	New spending limit for the API key in USD	75
limit_reset	OptionalNullable[operations.UpdateKeysLimitReset]	➖	New limit reset type for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.	daily
include_byok_in_limit	Optional[bool]	➖	Whether to include BYOK usage in the limit	true
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.UpdateKeysResponse

Errors

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

delete

Delete an existing API key. Provisioning key required.

Example Usage

from openrouter import OpenRouter
import os


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

    res = open_router.api_keys.delete(hash="f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
hash	str	✔️	The hash identifier of the API key to delete	f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.DeleteKeysResponse

Errors

Error Type	Status Code	Content Type
errors.UnauthorizedResponseError	401	application/json
errors.NotFoundResponseError	404	application/json
errors.TooManyRequestsResponseError	429	application/json
errors.InternalServerResponseError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	*/*

get

Get a single API key by hash. Provisioning key required.

Example Usage

from openrouter import OpenRouter
import os


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

    res = open_router.api_keys.get(hash="f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
hash	str	✔️	The hash identifier of the API key to retrieve	f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetKeyResponse

Errors

Error Type	Status Code	Content Type
errors.UnauthorizedResponseError	401	application/json
errors.NotFoundResponseError	404	application/json
errors.TooManyRequestsResponseError	429	application/json
errors.InternalServerResponseError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	*/*

get_current_key_metadata

Get information on the API key associated with the current authentication session

Example Usage

from openrouter import OpenRouter
import os


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

    res = open_router.api_keys.get_current_key_metadata()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetCurrentKeyResponse

Errors

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