You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guides/vercel.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,7 @@ Once you click on **Create project**, you should see the following message: “Y
67
67
68
68
### Understand and use Meilisearch API keys
69
69
70
-
Meilisearch creates two default API keys: [`Default Search API Key` and `Default Admin API Key`](/learn/security/basic_security#obtaining-api-keys).
70
+
Meilisearch creates [four default API keys](/learn/security/basic_security#obtaining-api-keys): `Default Search API Key`, `Default Admin API Key`, `Default Read-Only Admin API Key`, and `Default Chat API Key`.
71
71
72
72
#### Admin API key
73
73
@@ -77,7 +77,7 @@ Use the `Default Admin API Key`, to control who can access or create new documen
77
77
78
78
Use the `Default Search API Key` to access the [search route](/reference/api/search). This is the one you want to use in your front end.
79
79
80
-
Both keys are automatically added to Vercel along with the Meilisearch URL.
80
+
The Search and Admin API keys are automatically added to Vercel along with the Meilisearch URL. For more information on the other default keys, consult the [security documentation](/learn/security/basic_security#obtaining-api-keys).
81
81
82
82
<Tip>
83
83
The master key–which hasn’t been added to Vercel–grants users full control over an instance. You can find it in your project’s overview on your [Meilisearch Cloud dashboard](https://cloud.meilisearch.com/projects/?utm_campaign=oss&utm_source=docs&utm_medium=vercel-integration). Read more about [Meilisearch security](https://www.meilisearch.com/docs/learn/security/master_api_keys).
Copy file name to clipboardExpand all lines: learn/security/basic_security.mdx
+51-4Lines changed: 51 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,7 +83,7 @@ Restart Meilisearch with the argument above to use this new and secure master ke
83
83
84
84
## Obtaining API keys
85
85
86
-
When your project is protected, Meilisearch automatically generates two API keys: `Default Search API Key` and `Default Admin API Key`. API keys are authorization tokens designed to safely communicate with the Meilisearch API.
86
+
When your project is protected, Meilisearch automatically generates four API keys: `Default Search API Key`, `Default Admin API Key`, `Default Read-Only Admin API Key`, and `Default Chat API Key`. API keys are authorization tokens designed to safely communicate with the Meilisearch API.
87
87
88
88
### Obtaining API keys in Meilisearch Cloud
89
89
@@ -103,7 +103,7 @@ Use your master key to query the `/keys` endpoint to view all API keys in your i
103
103
Only use the master key to manage API keys. Never use the master key to perform searches or other common operations.
104
104
</Warning>
105
105
106
-
Meilisearch's response will include at least the two default API keys:
106
+
Meilisearch's response will include at least the default API keys:
107
107
108
108
```json
109
109
{
@@ -112,7 +112,7 @@ Meilisearch's response will include at least the two default API keys:
112
112
"name": "Default Search API Key",
113
113
"description": "Use it to search from the frontend",
@@ -155,6 +187,21 @@ Then use the `Default Search API Key` to perform search operations in the index
155
187
156
188
<CodeSamplesBasicSecurityTutorialSearch1 />
157
189
190
+
### Admin API keys
191
+
192
+
Meilisearch provides two admin API keys for managing your instance:
193
+
194
+
- The `Default Admin API Key` grants full access to all Meilisearch operations except API key management. Use it to configure index settings, add documents, and perform other administrative tasks.
195
+
- The `Default Read-Only Admin API Key` allows read-only access to the whole database. Use it when you need to retrieve information from your Meilisearch instance without being able to modify it.
196
+
197
+
<Warning>
198
+
Do not expose admin API keys on a public frontend.
199
+
</Warning>
200
+
201
+
### Chat API key
202
+
203
+
The `Default Chat API Key` is designed for frontend usage with [conversational search](/learn/chat/getting_started_with_chat). It has access to both `search` and `chatCompletions` actions, allowing users to both perform searches and interact with the chat completions feature.
204
+
158
205
## Conclusion
159
206
160
207
You have successfully secured Meilisearch by configuring a master key. You then saw how to access the Meilisearch API by adding an API key to your request's authorization header.
Copy file name to clipboardExpand all lines: learn/security/differences_master_api_keys.mdx
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,4 +24,9 @@ API keys grant access to a specific set of indexes, routes, and endpoints. You c
24
24
25
25
**Use API keys for all API operations except API key management.** This includes search, configuring index settings, managing indexes, and adding and updating documents.
26
26
27
-
In many cases, the default API keys are all you need to safely manage your Meilisearch project. Use the `Default Search API key` for searching, and the `Default Admin API Key` to configure index settings, add documents, and other operations.
27
+
In many cases, the default API keys are all you need to safely manage your Meilisearch project:
28
+
29
+
- Use the `Default Search API Key` for search operations from the frontend
30
+
- Use the `Default Admin API Key` to configure index settings, add documents, and other operations. Do not expose it on a public frontend
31
+
- Use the `Default Read-Only Admin API Key` for read-only access to all indexes, documents, and settings. Do not expose it on a public frontend
32
+
- Use the `Default Chat API Key` for [conversational search](/learn/chat/getting_started_with_chat). It can be safely used from the frontend
0 commit comments