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

# Train machine handler

> **Required scope:** models:manage

**Required scope:** `models:manage`

### Request body

`TrainRequest`

<ParamField body="examples" type="ProvisionTrainingExample[]">
  Additional training examples (optional).
</ParamField>

<ParamField body="include_flywheel" type="boolean">
  Whether to include flywheel events (default: true).
</ParamField>

### Response

`TrainResponse`

<ResponseField name="concept_models_learned" type="integer" required />

<ResponseField name="concept_rules_learned" type="integer" required />

<ResponseField name="custom_examples" type="integer" required />

<ResponseField name="flywheel_examples" type="integer" required />

<ResponseField name="org_id" type="string" required />

<ResponseField name="successful_abductions" type="integer" required />

<ResponseField name="total_examples" type="integer" required />

<ResponseField name="training_time_ms" type="integer (int64)" required />

### Status codes

| Code  | Meaning                                            |
| ----- | -------------------------------------------------- |
| `200` | Training completed                                 |
| `401` | Unauthorized — missing or invalid credentials      |
| `403` | Forbidden — the key/token lacks the required scope |
| `404` | Machine not provisioned                            |
| `429` | Rate limited — see Retry-After / X-RateLimit-Reset |
| `500` | Training failed                                    |

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url 'https://api.nsr.stateset.com/api/v1/machines/train' \
    --header 'X-API-Key: YOUR_API_KEY' \
    --header 'Content-Type: application/json' \
    --data '{
    "examples": [
      {
        "expected_category": "string",
        "input": "string"
      }
    ],
    "include_flywheel": true
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "concept_models_learned": 1,
    "concept_rules_learned": 1,
    "custom_examples": 1,
    "flywheel_examples": 1,
    "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "successful_abductions": 1,
    "total_examples": 1,
    "training_time_ms": 250
  }
  ```
</ResponseExample>