---
title: ApiKeyScope
sidebar_label: ApiKeyScope
sidebar_position: 10
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lium.io/llms.txt
> Use this file to discover all available pages before exploring further.

<!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->

# ApiKeyScope

```python
from lium.sdk import ApiKeyScope
```

Defined in `lium.sdk.models`.

One row of ``GET /keys/scopes``: what a scope lets a key do, in the server's words.

``description`` is the one sentence next to the picker's checkbox, ``can`` the "what this key can do"
lines, ``route_families`` the routes it opens, ``default`` whether a key made without naming scopes gets it.

```python
ApiKeyScope(
    scope: str,
    description: str,
    title: str = '',
    can: List[str] = <factory>,
    route_families: List[str] = <factory>,
    default: bool = False
)
```

## Fields

| Name | Type | Default |
| --- | --- | --- |
| `scope` | str |  |
| `description` | str |  |
| `title` | str | `''` |
| `can` | List[str] |  |
| `route_families` | List[str] |  |
| `default` | bool | `False` |