# Get model

> Get model.

`GET https://api.cymatics.tech/v1/models/{model}`

Scope: `results:read`

## Request

Send your key as `Authorization: Bearer cym_test_…`. Requires the `results:read` scope. Test keys read the simulator; live keys read your paired Cymos.

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `model` (SDK and CLI: `model_id`) | path | `string` | Yes | Model id |

## Response

`200 · application/json`

```json
{
  "data": {
    "id": "id_01",
    "versions": [
      "demo-1"
    ],
    "recommended_version": "recommended_version",
    "deployment": "deployment",
    "live_available": true
  },
  "meta": {
    "request_id": "req_01",
    "project_id": "proj_demo",
    "livemode": false,
    "generated_at": "2026-10-24T23:55:30.000Z"
  }
}
```

## Errors

| Status | Description |
| --- | --- |
| `429` | `rate_limit_exceeded`: Too many requests this minute for the key (or twice that across the project), or too many open streams for the project. Retry after the seconds in Retry-After.<br>`quota_exceeded`: A live key's project has used its monthly live-hour cap. There is no Retry-After. Don't retry; raise the live-hour cap in the dashboard. Headers: Retry-After, RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset. |
| `503` | `live_unavailable`: This operation has no live data for this project yet (for example, no paired Cymo covers it). Don't retry the same request; pair a Cymo that covers it, or build against a test key.<br>`service_unavailable`: A dependency, such as API key verification, is unreachable, or the project is busy with another write. Retry after the seconds in Retry-After, with backoff. |
| `4XX` | Invalid request, credential, permission or revision. |
| `default` | Error with a stable code and request ID. |

Every error is a `{ error, meta }` envelope with a stable `code`. See [Errors](https://docs.cymatics.tech/errors) for each code and whether to retry.

## Call it

**TypeScript · @cymos/sdk**

```ts
import { Cymo } from "@cymos/sdk";

const cymo = new Cymo({ apiKey: process.env.CYMO_API_KEY! });

const { data, meta } = await cymo.models.get({ model_id: "model_vitals" });
```

**terminal · cymatics CLI**

```sh
$ cymatics models get --model-id model_vitals --json
```

**curl**

```sh
curl "https://api.cymatics.tech/v1/models/model_vitals" \
  -H "Authorization: Bearer $CYMO_API_KEY"
```

**MCP tool**

```
get_model({ model_id: "model_vitals" })
```

The MCP tool `get_model` calls this operation with your key.