> ## 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.

# Seed machine handler

> **Required scope:** models:manage

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

### Request body

`MachineSeedRequest`

<ParamField body="actions" type="MachineActionContract[]" />

<ParamField body="brand_name" type="string" required />

<ParamField body="brand_voice" type="object" />

<ParamField body="catalog" type="MachineCatalogItem[]" />

<ParamField body="file_ids" type="string[]" />

<ParamField body="historical_tickets" type="MachineHistoricalTicket[]" />

<ParamField body="metadata" type="object" />

<ParamField body="policies" type="MachinePolicyDocument[]" />

<ParamField body="structured" type="object" />

### Response

`MachineSeedResponse`

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

<ResponseField name="candidate_actions" type="string[]" />

<ResponseField name="candidate_intents" type="string[]" />

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

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

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

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

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

<ResponseField name="review_items" type="string[]" />

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

<ResponseField name="summary" type="MachineSeedSummary" required>
  <Expandable title="MachineSeedSummary">
    <ResponseField name="actions" type="integer" required />

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

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

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

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

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

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

    <ResponseField name="unlabeled_tickets" type="integer" required />
  </Expandable>
</ResponseField>

### Status codes

| Code  | Meaning                                            |
| ----- | -------------------------------------------------- |
| `201` | Machine seed pack created                          |
| `400` | Invalid seed pack                                  |
| `401` | Unauthorized — missing or invalid credentials      |
| `403` | Forbidden — the key/token lacks the required scope |
| `429` | Rate limited — see Retry-After / X-RateLimit-Reset |

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url 'https://api.nsr.stateset.com/api/v1/machines/seed' \
    --header 'X-API-Key: YOUR_API_KEY' \
    --header 'Content-Type: application/json' \
    --data '{
    "actions": [
      {
        "description": "Two-person tent, green — replacement for damaged pole set.",
        "method": "string",
        "name": "Two-Person Tent",
        "path": "string",
        "required_entities": [],
        "requires_approval": true
      }
    ],
    "brand_name": "Acme Outdoors",
    "brand_voice": {
      "agent_name": "string",
      "guidance": "string",
      "tone": "string"
    },
    "catalog": [
      {
        "aliases": [],
        "availability": "string",
        "category": "standard",
        "description": "Two-person tent, green — replacement for damaged pole set.",
        "name": "Two-Person Tent",
        "price": "49.00",
        "properties": {},
        "sku": "SKU-TENT-2P-GRN",
        "subscription_price": "49.00"
      }
    ],
    "file_ids": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "historical_tickets": [
      {
        "extracted_entities": {},
        "input": "string",
        "outcome_action": "string",
        "outcome_status": "string",
        "requires_human_review": true,
        "resolved_intent": "string"
      }
    ],
    "metadata": {},
    "policies": [
      {
        "category": "standard",
        "escalation_required": true,
        "name": "Two-Person Tent",
        "text": "Two-person tent, green — replacement for damaged pole set."
      }
    ],
    "structured": {
      "entities": [
        {
          "entity_type": null,
          "name": null,
          "properties": null
        }
      ],
      "rules": [
        {
          "body": null,
          "confidence": null,
          "description": null,
          "head_args": null,
          "head_predicate": null,
          "name": null
        }
      ],
      "triples": [
        {
          "confidence": null,
          "object_id": null,
          "predicate": null,
          "subject_id": null
        }
      ]
    }
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json 201 theme={null}
  {
    "brand_name": "Acme Outdoors",
    "candidate_actions": [
      "string"
    ],
    "candidate_intents": [
      "string"
    ],
    "created_at": 1,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "next_step": "string",
    "object": "string",
    "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "review_items": [
      "string"
    ],
    "status": "pending",
    "summary": {
      "actions": 1,
      "catalog_items": 1,
      "explicit_rules": 1,
      "file_ids": 1,
      "historical_tickets": 1,
      "labeled_tickets": 1,
      "policies": 1,
      "unlabeled_tickets": 1
    }
  }
  ```
</ResponseExample>