Method create_async

src/openrouter/byok.py:518–683

r"""Create a BYOK provider credential Create a new bring-your-own-key (BYOK) provider credential. The raw key is encrypted at rest and never returned in API responses. Defaults to the authenticated entity's default workspace; use the `workspace_id` body field to scope to a different workspa

(
        self,
        *,
        key: str,
        provider: components.BYOKProviderSlug,
        http_referer: Optional[str] = None,
        x_open_router_title: Optional[str] = None,
        x_open_router_categories: Optional[str] = None,
        allowed_models: OptionalNullable[Iterable[str]] = UNSET,
        allowed_user_ids: OptionalNullable[Iterable[str]] = UNSET,
        disabled: Optional[bool] = None,
        is_fallback: Optional[bool] = None,
        name: OptionalNullable[str] = UNSET,
        workspace_id: Optional[str] = None,
        retries: OptionalNullable[utils.RetryConfig] = UNSET,
        server_url: Optional[str] = None,
        timeout_ms: Optional[int] = None,
        http_headers: Optional[Mapping[str, str]] = None,
    )

        raise errors.OpenRouterDefaultError("Unexpected response received", http_res)

    async def create_async(
        self,
        *,
        key: str,
        provider: components.BYOKProviderSlug,
        http_referer: Optional[str] = None,
        x_open_router_title: Optional[str] = None,
        x_open_router_categories: Optional[str] = None,
        allowed_models: OptionalNullable[Iterable[str]] = UNSET,
        allowed_user_ids: OptionalNullable[Iterable[str]] = UNSET,
        disabled: Optional[bool] = None,
        is_fallback: Optional[bool] = None,
        name: OptionalNullable[str] = UNSET,
        workspace_id: Optional[str] = None,
        retries: OptionalNullable[utils.RetryConfig] = UNSET,
        server_url: Optional[str] = None,
        timeout_ms: Optional[int] = None,
        http_headers: Optional[Mapping[str, str]] = None,
    ) -> components.CreateBYOKKeyResponse:
        r"""Create a BYOK provider credential

        Create a new bring-your-own-key (BYOK) provider credential. The raw key is encrypted at rest and never returned in API responses. Defaults to the authenticated entity's default workspace; use the `workspace_id` body field to scope to a different workspace. Treat the raw key as write-only; it is never returned after creation. [Management key](/docs/guides/overview/auth/management-api-keys) required.

        :param key: The raw provider API key or credential. This value is encrypted at rest and never returned in API responses.
        :param provider: The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`).
        :param http_referer: 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.

        :param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.

        :param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.

        :param allowed_models: Optional allowlist of model slugs this credential may be used for. `null` means no restriction.
        :param allowed_user_ids: Optional allowlist of user IDs that may use this credential. `null` means no restriction.
        :param disabled: Whether this credential should be created in a disabled state.
        :param is_fallback: Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried.
        :param name: Optional human-readable name for the credential.
        :param workspace_id: Optional workspace ID. Defaults to the authenticated entity's default workspace.
        :param retries: Override the default retry configuration for this method
        :param server_url: Override the default server URL for this method
        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
        :param http_headers: Additional headers to set or replace on requests.
        """
        base_url = None
        url_variables = None
        if timeout_ms is None:
            timeout_ms = self.sdk_configuration.timeout_ms

        if server_url is not None:
            base_url = server_url
        else:
            base_url = self._get_url(base_url, url_variables)

        request = operations.CreateBYOKKeyRequest(
            http_referer=http_referer,
            x_open_router_title=x_open_router_title,
            x_open_router_categories=x_open_router_categories,
            create_byok_key_request=components.CreateBYOKKeyRequest(