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

# Get Check Settings

Use this API to get the checks settings the engine applies to a project: the confidence floor, your own flags and the default owners, and where they came from. Change them with [Update Check Settings](https://velt.dev/docs/api-reference/rest-apis/v2/agents/checks/settings/update.md).

# Endpoint

`POST https://api.velt.dev/v2/agents/checks/settings/get`

# Headers

**x-velt-api-key** `string` *required*

Your API key.

**x-velt-auth-token** `string` *required*

Your [Auth Token](https://velt.dev/docs/security/auth-tokens.md).

# Body

#### Params

**data** `object` *required*

**properties**

**organizationId** `string` *required*

1 to 512 characters. The organization of the project.

**documentId** `string` *required*

1 to 512 characters. The document of the project.

The schema uses `.strict()`: unknown fields are rejected.

## **Example Requests**

```JSON theme={null}
{
  "data": {
    "organizationId": "org_acme",
    "documentId": "acme-marketing-site"
  }
}
```

# Response

#### Success Response

```JSON theme={null}
{
  "result": {
    "status": "success",
    "message": "Check settings retrieved",
    "data": {
      "confidenceFloor": 60,
      "hostFlags": {
        "weeklyDigest": true
      },
      "owners": {
        "dev": {
          "userId": "user_jordan",
          "name": "Jordan Lee",
          "email": "jordan@example.com"
        },
        "admin": {
          "userId": "user_sam"
        }
      },
      "source": "mirror",
      "updatedAt": 1761465600000
    }
  }
}
```

| Field | Type | Description |
| - | - | - |
| `data.confidenceFloor` | number | 0 to 100. A finding under it writes no comment. Default: `50`. |
| `data.hostFlags` | object | Your own boolean flags. Stored and returned, never read by the engine. |
| `data.owners` | object | The default owner of a check by its responsibility (`content`, `design`, `dev`) and the fallback (`admin`), each `{ userId, name?, email? }`. Only the owners set with Update Check Settings are present. |
| `data.source` | string | Where the settings came from: `"mirror"` (set with Update Check Settings), `"host"` (the embedding product's own) or `"default"`. |
| `data.updatedAt` | number \| null | When the settings were last updated (epoch ms), or `null` when never set. |

#### Failure Response

```JSON theme={null}
{
  "error": {
    "message": "Workspace not found or has no store database for the checks engine",
    "status": "NOT_FOUND",
    "details": {
      "reason": "CHECKS_WORKSPACE_NOT_FOUND"
    }
  }
}
```

**Errors:** `INVALID_ARGUMENT` (a body outside the schema: a missing `organizationId` or `documentId`, or an unknown field) / `NOT_FOUND` with `CHECKS_WORKSPACE_NOT_FOUND` (the workspace has no store database).

```js theme={null}
{
  "result": {
    "status": "success",
    "message": "Check settings retrieved",
    "data": {
      "confidenceFloor": 50,
      "hostFlags": {},
      "owners": {},
      "source": "default",
      "updatedAt": null
    }
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.