Seed machine handler

Required scope: models:manage

POST /api/v1/machines/seed

cURL

curl --request POST \
  --url 'https://api.nsr.stateset.com/api/v1/machines/seed' \
  --header "X-API-Key: $STATESET_NSR_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
      }
    ]
  }
}'

201

{
  "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
  }
}

Required scope: models:manage

Request body

MachineSeedRequest

actions · MachineActionContract[]

brand_name · string · required

brand_voice · object

catalog · MachineCatalogItem[]

file_ids · string[]

historical_tickets · MachineHistoricalTicket[]

metadata · object

policies · MachinePolicyDocument[]

structured · object

Response

MachineSeedResponse

brand_name · string · required

candidate_actions · string[]

candidate_intents · string[]

created_at · integer (int64) · required

id · string · required

next_step · string · required

object · string · required

org_id · string · required

review_items · string[]

status · string · required

summary · MachineSeedSummary · required

Show MachineSeedSummary

actions · integer · required

catalog_items · integer · required

explicit_rules · integer · required

file_ids · integer · required

historical_tickets · integer · required

labeled_tickets · integer · required

policies · integer · required

unlabeled_tickets · integer · required

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

cURL

curl --request POST \
  --url 'https://api.nsr.stateset.com/api/v1/machines/seed' \
  --header "X-API-Key: $STATESET_NSR_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
      }
    ]
  }
}'

201

{
  "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
  }
}