Skip to content

Models client

Client Models

These are the models returned by, and passed to, the methods on the AsyncClient and Client that work at the server level rather than on a single index. This covers API keys, the network configuration used for remote federated search, webhooks, and the health and version information for the server.

Client Models API

meilisearch_python_sdk.models.client

ClientStats

Bases: CamelBase

Source code in meilisearch_python_sdk/models/client.py 
12
13
14
15
16
class ClientStats(CamelBase):
    database_size: int | str
    used_database_size: int | str | None = None
    last_update: datetime | None = None
    indexes: dict[str, IndexStats] | None = None

database_size instance-attribute 

database_size: int | str

used_database_size class-attribute instance-attribute 

used_database_size: int | str | None = None

last_update class-attribute instance-attribute 

last_update: datetime | None = None

indexes class-attribute instance-attribute 

indexes: dict[str, IndexStats] | None = None

Key

Bases: _KeyBase

Source code in meilisearch_python_sdk/models/client.py 
30
31
32
33
class Key(_KeyBase):
    key: str
    created_at: datetime
    updated_at: datetime | None = None

key instance-attribute 

key: str

created_at instance-attribute 

created_at: datetime

updated_at class-attribute instance-attribute 

updated_at: datetime | None = None

KeyCreate

Bases: CamelBase

Source code in meilisearch_python_sdk/models/client.py 
36
37
38
39
40
41
42
43
class KeyCreate(CamelBase):
    name: str | None = None
    description: str | None = None
    actions: list[str]
    indexes: list[str]
    expires_at: datetime | None = None

    model_config = pydantic.ConfigDict(ser_json_timedelta="iso8601")  # type: ignore[typeddict-unknown-key]

name class-attribute instance-attribute 

name: str | None = None

description class-attribute instance-attribute 

description: str | None = None

actions instance-attribute 

actions: list[str]

indexes instance-attribute 

indexes: list[str]

expires_at class-attribute instance-attribute 

expires_at: datetime | None = None

model_config class-attribute instance-attribute 

model_config = pydantic.ConfigDict(
    ser_json_timedelta="iso8601"
)

KeyUpdate

Bases: CamelBase

Source code in meilisearch_python_sdk/models/client.py 
46
47
48
49
50
51
52
53
54
class KeyUpdate(CamelBase):
    key: str
    name: str | None = None
    description: str | None = None
    actions: list[str] | None = None
    indexes: list[str] | None = None
    expires_at: datetime | None = None

    model_config = pydantic.ConfigDict(ser_json_timedelta="iso8601")  # type: ignore[typeddict-unknown-key]

key instance-attribute 

key: str

name class-attribute instance-attribute 

name: str | None = None

description class-attribute instance-attribute 

description: str | None = None

actions class-attribute instance-attribute 

actions: list[str] | None = None

indexes class-attribute instance-attribute 

indexes: list[str] | None = None

expires_at class-attribute instance-attribute 

expires_at: datetime | None = None

model_config class-attribute instance-attribute 

model_config = pydantic.ConfigDict(
    ser_json_timedelta="iso8601"
)

KeySearch

Bases: CamelBase

Source code in meilisearch_python_sdk/models/client.py 
57
58
59
60
61
class KeySearch(CamelBase):
    results: list[Key]
    offset: int
    limit: int
    total: int

results instance-attribute 

results: list[Key]

offset instance-attribute 

offset: int

limit instance-attribute 

limit: int

total instance-attribute 

total: int

Remote

Bases: CamelBase

Source code in meilisearch_python_sdk/models/client.py 
64
65
66
class Remote(CamelBase):
    url: str | None = None
    search_api_key: str | None = None

url class-attribute instance-attribute 

url: str | None = None

search_api_key class-attribute instance-attribute 

search_api_key: str | None = None

Network

Bases: CamelBase

Source code in meilisearch_python_sdk/models/client.py 
69
70
71
class Network(CamelBase):
    self_: str | None = pydantic.Field(None, alias="self")
    remotes: Mapping[str, Remote] | None = None

self_ class-attribute instance-attribute 

self_: str | None = pydantic.Field(None, alias='self')

remotes class-attribute instance-attribute 

remotes: Mapping[str, Remote] | None = None

Webhook Models API

meilisearch_python_sdk.models.webhook

Webhook

Bases: CamelBase

Source code in meilisearch_python_sdk/models/webhook.py 
 6
 7
 8
 9
10
class Webhook(CamelBase):
    uuid: str
    url: str
    headers: dict[str, str] | None = None
    is_editable: bool

uuid instance-attribute 

uuid: str

url instance-attribute 

url: str

headers class-attribute instance-attribute 

headers: dict[str, str] | None = None

is_editable instance-attribute 

is_editable: bool

Webhooks

Bases: CamelBase

Source code in meilisearch_python_sdk/models/webhook.py 
13
14
class Webhooks(CamelBase):
    results: list[Webhook]

results instance-attribute 

results: list[Webhook]

WebhookCreate

Bases: CamelBase

Source code in meilisearch_python_sdk/models/webhook.py 
17
18
19
class WebhookCreate(CamelBase):
    url: str
    headers: dict[str, str] | None = None

url instance-attribute 

url: str

headers class-attribute instance-attribute 

headers: dict[str, str] | None = None

WebhookUpdate

Bases: CamelBase

Source code in meilisearch_python_sdk/models/webhook.py 
22
23
24
class WebhookUpdate(CamelBase):
    url: str | None = None
    headers: dict[str, str] | None = None

url class-attribute instance-attribute 

url: str | None = None

headers class-attribute instance-attribute 

headers: dict[str, str] | None = None

Health Models API

meilisearch_python_sdk.models.health

Health

Bases: CamelBase

Source code in meilisearch_python_sdk/models/health.py 
4
5
class Health(CamelBase):
    status: str

status instance-attribute 

status: str

Version Models API

meilisearch_python_sdk.models.version

Version

Bases: CamelBase

Source code in meilisearch_python_sdk/models/version.py 
6
7
8
9
class Version(CamelBase):
    commit_sha: str
    commit_date: datetime | str
    pkg_version: str

commit_sha instance-attribute 

commit_sha: str

commit_date instance-attribute 

commit_date: datetime | str

pkg_version instance-attribute 

pkg_version: str