---
title: "Get MCP preferences"
canonical_url: https://docs.zvid.io/docs/endpoints/get-mcp-preferences/
source: docs/endpoints/get-mcp-preferences.api.mdx
content_revision: 6338386a1dd87e4a
---

# Get MCP preferences

`GET /api/mcp/preferences`

Read account defaults used by the hosted MCP service. Change defaults in the dashboard; this REST operation is read-only.

## Authentication

- Option 1: `x-api-key: YOUR_API_KEY` (header). API key for authentication. Create one in your dashboard.
- Option 2: `Authorization: Bearer YOUR_ACCESS_TOKEN`. Dashboard JWT in Authorization: Bearer <token>, only on operations that explicitly list this scheme. Prefer x-api-key for REST integrations. OAuth for hosted MCP is a separate connection at https://mcp.zvid.io/mcp.

Create API keys at [app.zvid.io/api-keys](https://app.zvid.io/api-keys). Keep credentials on your server.

## Parameters

This operation has no path, query, or additional header parameters.

## Request

The shell examples read credentials from `ZVID_API_KEY` (or `ZVID_ACCESS_TOKEN` for Bearer authentication). Set that variable in your environment. Replace sample project, template, job, and asset identifiers with values from your own account.

This operation does not take a request body.

### Request example

```bash
curl --request GET 'https://api.zvid.io/api/mcp/preferences' \
  --header "x-api-key: $ZVID_API_KEY"
```

## Responses


### HTTP 200

Successful response

Content type: `application/json`.

Required properties: `defaultProfile`, `defaultMaxRenderCredits`, `profiles`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.defaultProfile` | `"creator"` / `"readonly"` / `"automation"` / `"developer"` | Yes |  |
| `response.defaultMaxRenderCredits` | integer | Yes | Minimum: `1`. Maximum: `10000`. |
| `response.profiles` | array of object | Yes |  |

**Nested field: `response.profiles`**

**Array item: `response.profiles[]`**

Required properties: `id`, `name`, `description`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.profiles[].id` | string | Yes |  |
| `response.profiles[].name` | string | Yes |  |
| `response.profiles[].description` | string | Yes |  |


### HTTP 400

Invalid input or semantic validation error

Content type: `application/json`.

Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.error` | string | Yes |  |
| `response.message` | string | No |  |
| `response.details` | array of object | No |  |
| `response.planLimits` | object | No | Present on render validation errors; contains the authenticated user's current render limits. |

**Nested field: `response.details`**

**Array item: `response.details[]`**

Unknown properties are rejected. Required properties: `field`, `message`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.details[].field` | string | Yes |  |
| `response.details[].message` | string | Yes |  |


### HTTP 401

Missing or invalid credentials

Content type: `application/json`.

Unknown properties are rejected. Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.error` | string | Yes | Error type |
| `response.message` | string | No | Human-readable error message |


### HTTP 404

Not found for this account

Content type: `application/json`.

Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.error` | string | Yes | Error type |
| `response.message` | string | No | Human-readable error message |


### HTTP 500

Server error

Content type: `application/json`.

Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.error` | string | Yes | Error type |
| `response.message` | string | No | Human-readable error message |


## Schema definitions

The following definitions describe the fields referenced above. Expand a definition to inspect its complete contract.


### schema mcp preferences

**McpPreferences**


Required properties: `defaultProfile`, `defaultMaxRenderCredits`, `profiles`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `McpPreferences.defaultProfile` | `"creator"` / `"readonly"` / `"automation"` / `"developer"` | Yes |  |
| `McpPreferences.defaultMaxRenderCredits` | integer | Yes | Minimum: `1`. Maximum: `10000`. |
| `McpPreferences.profiles` | array of object | Yes |  |

**Nested field: `McpPreferences.profiles`**

**Array item: `McpPreferences.profiles[]`**

Required properties: `id`, `name`, `description`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `McpPreferences.profiles[].id` | string | Yes |  |
| `McpPreferences.profiles[].name` | string | Yes |  |
| `McpPreferences.profiles[].description` | string | Yes |  |


### schema validation error

**ValidationError**


Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `ValidationError.error` | string | Yes |  |
| `ValidationError.message` | string | No |  |
| `ValidationError.details` | array of object | No |  |
| `ValidationError.planLimits` | object | No | Present on render validation errors; contains the authenticated user's current render limits. |

**Nested field: `ValidationError.details`**

**Array item: `ValidationError.details[]`**

Unknown properties are rejected. Required properties: `field`, `message`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `ValidationError.details[].field` | string | Yes |  |
| `ValidationError.details[].message` | string | Yes |  |


### schema authentication error

**AuthenticationError**


Unknown properties are rejected. Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `AuthenticationError.error` | string | Yes | Error type |
| `AuthenticationError.message` | string | No | Human-readable error message |


### schema error

**Error**


Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `Error.error` | string | Yes | Error type |
| `Error.message` | string | No | Human-readable error message |


## Related resources

- [OpenAPI specification](https://docs.zvid.io/openapi.yaml)
- [Project payload schema](https://docs.zvid.io/schemas/render-payload.schema.json)
- [Quick Start](https://docs.zvid.io/docs/quick-start/)
- [Authentication guide](https://docs.zvid.io/docs/authentication/)