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
-`organization`: The Spice.ai organization that owns the application
51
-
-`application`: The specific application to load tables from
52
-
-`catalog_name`: (optional): A specific catalog within the application. If not specified, the application's default catalog is used
51
+
-`organization`: The Spice.ai organization that owns the application.
52
+
-`application`: The specific application to load tables from.
53
+
-`catalog_name` (optional): A specific catalog within the application. Defaults to `spice` if not specified.
53
54
54
55
For example:
55
56
@@ -161,11 +162,28 @@ include:
161
162
162
163
## `params`
163
164
164
-
The following parameters are supported for configuring the connection to the Spice Cloud catalog/tables:
165
+
### Authentication
165
166
166
-
| Parameter Name | Definition |
167
+
| Parameter Name | Description |
167
168
|---------------|------------|
168
-
| `spiceai_api_key` | Authorization API key from the Spice.ai Cloud Platform, used to login to the specified organization and app. |
169
+
| `spiceai_api_key` | API key from the Spice.ai Cloud Platform. Takes precedence over `spiceai_token`. |
170
+
| `spiceai_token` | Legacy alias for `spiceai_api_key`. Used only if `spiceai_api_key` is not set. |
171
+
172
+
### Region
173
+
174
+
| Parameter Name | Description |
175
+
|---------------|------------|
176
+
| `spiceai_region` | The Spice Cloud region to connect to (e.g. `us-east-1`). **Required** unless `spiceai_http_endpoint` is set. To list available regions, run `spice cloud regions`. |
177
+
178
+
### Endpoint Overrides
179
+
180
+
These parameters override the default endpoints derived from `spiceai_region`. They are typically only needed for development or custom deployments.
181
+
182
+
| Parameter Name | Description |
183
+
|---------------|------------|
184
+
| `spiceai_http_endpoint` | Custom HTTP endpoint for the Spice Cloud catalog API (Iceberg REST catalog compatible). If set, `spiceai_region` is not required and region validation is skipped. |
185
+
| `spiceai_endpoint` | Custom Arrow Flight endpoint for query execution. Takes precedence over `spiceai_flight_endpoint`. |
186
+
| `spiceai_flight_endpoint` | Legacy alias for `spiceai_endpoint`. Used only if `spiceai_endpoint` is not set. |
0 commit comments