# Get the command schema

`GET https://api.vidmoat.com/v1/schema/commands`

- Scope: none (a valid credential is still required)
- Cost: Free

The full command vocabulary the editor accepts, verbatim from COMMAND_SCHEMA. A valid bearer token is required, but no additional scope is needed.

> **Note.** This is the same schema the editor and the MCP server validate against. If an op is not in here, it does not exist.

## Response

Returns `200`.

### Response fields

- `schema` (object): The schema.
  - `description` (string): How commands are applied.
  - `enums` (object): Allowed values for clip types, easings, blend modes, effects, transitions, aspect ratios and more.
  - `commands` (object): Every op, keyed by name: `{ description, params }`, where each param is a type string such as `number?`.

## Request examples

```bash curl
curl https://api.vidmoat.com/v1/schema/commands \
  -H "Authorization: Bearer $VIDMOAT_KEY"
```

```js Node
const res = await fetch('https://api.vidmoat.com/v1/schema/commands', {
  headers: {
    Authorization: `Bearer ${process.env.VIDMOAT_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(data.error?.message ?? `HTTP ${res.status}`);
console.log(data);
```

```python Python
import os
import requests

res = requests.get(
    "https://api.vidmoat.com/v1/schema/commands",
    headers={"Authorization": f"Bearer {os.environ['VIDMOAT_KEY']}"},
    timeout=60,
)
res.raise_for_status()
print(res.json())
```

## Example response

```json
{
  "schema": {
    "description": "…",
    "enums": { "aspectRatio": ["16:9", "9:16", "1:1", "4:5", "4:3", "21:9"] },
    "commands": {
      "setProjectSettings": {
        "description": "…",
        "params": { "name": "string?", "aspectRatio": "aspectRatio?", "fps": "number?", "background": "css color?" }
      }
    }
  }
}
```

---

Source: https://developer.vidmoat.com/developer/docs/api/account/get-command-schema
Previous: [Get usage](https://developer.vidmoat.com/developer/docs/api/account/get-usage.md)
Next: [List projects](https://developer.vidmoat.com/developer/docs/api/projects/list-projects.md)
All documentation: https://developer.vidmoat.com/llms-full.txt