Create, revise or check a portable model

Supply prompt and optional documents to create a definition. To revise, include the complete current content and output questions. Nothing is saved by the server. Prompt-based authoring uses System Two pricing. With content and no prompt or files, this is a free validation check returning stages and the derived input schema.

POST/v1/systemtwo/models

Authorization

AuthorizationBearer token · headerrequired

Account API key

Request body

requiredapplication/json

modelstring

Optional generator alias

promptstring

contentDefinition

Show properties

namestringrequired

inputsobjectrequired

decisionsobjectrequired

functionsobject

outputQuestions

stateState

JSON evidence or a text string. JSON matching the input schema needs no LLM.

Show properties

One of:

object

object

any[]

Array of any

any

string

string

namestring

modestring

default: "fast"

Allowed:fastthinking

dry_runboolean

Accepted for compatibility; every definition is unsaved

filesobject[]

Show properties

Array of object

namestring

typestring

datastringrequired

Responses

200

Unsaved definition or validation result

One of:

Draft

modelPortableModel

Show properties

contentDefinitionrequired

Show properties

namestringrequired

inputsobjectrequired

decisionsobjectrequired

functionsobject

questionsQuestionsrequired

contentDefinition

Show properties

namestringrequired

inputsobjectrequired

decisionsobjectrequired

functionsobject

outputQuestions

inputobject

examplesobject[]

usageUsage

Show properties

input_tokensintegerrequired

min 0

output_tokensintegerrequired

min 0

provider_usageUsage

Show properties

input_tokensintegerrequired

min 0

output_tokensintegerrequired

min 0

billingBilling

Settled charge deducted from account balance. Questions and authoring use API input/output tokens at System Two rates, independent of provider work or cache hits. Submitted model executions use API input tokens at System One rates (output free by default). Extraction uses actual provider tokens at System Two rates. API response accounting metadata (usage, billing) is excluded from token counting.

Show properties

currencystring

estimatedboolean

cost_usdnumber

balanceBalance

Show properties

currencystring

balance_usdnumber

reserved_usdnumber

available_usdnumber

itemsobject[]

Check

validboolean

stagesobject[]

warningsstring[]

contentDefinition

Show properties

namestringrequired

inputsobjectrequired

decisionsobjectrequired

functionsobject

inputobject

400

Request failed; no successful execution charge is settled

typestring

titlestring

statusinteger

codestring

detailstring

errorsobject[]

401

Request failed; no successful execution charge is settled

typestring

titlestring

statusinteger

codestring

detailstring

errorsobject[]

402

insufficient_balance; available funds cannot cover the request reservation

typestring

titlestring

statusinteger

codestring

detailstring

errorsobject[]

403

Request failed; no successful execution charge is settled

typestring

titlestring

statusinteger

codestring

detailstring

errorsobject[]

422

Request failed; no successful execution charge is settled

typestring

titlestring

statusinteger

codestring

detailstring

errorsobject[]

429

Request failed; no successful execution charge is settled

typestring

titlestring

statusinteger

codestring

detailstring

errorsobject[]

502

Request failed; no successful execution charge is settled

typestring

titlestring

statusinteger

codestring

detailstring

errorsobject[]

504

Request failed; no successful execution charge is settled

typestring

titlestring

statusinteger

codestring

detailstring

errorsobject[]

Request

curl -X POST 'https://api.aityx.ai/v1/systemtwo/models' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "string",
  "prompt": "string",
  "content": {
    "name": "string",
    "inputs": {},
    "decisions": {},
    "functions": {}
  },
  "output": {
    "property1": {
      "type": "noul",
      "instructions": null,
      "criteria": null,
      "options": {},
      "levels": [
        null
      ]
    },
    "property2": {
      "type": "noul",
      "instructions": null,
      "criteria": null,
      "options": {},
      "levels": [
        null
      ]
    }
  },
  "state": {},
  "name": "string",
  "mode": "fast",
  "dry_run": true,
  "files": [
    {
      "name": "string",
      "type": "string",
      "data": "string"
    }
  ]
}'

const response = await fetch("https://api.aityx.ai/v1/systemtwo/models", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"model\": \"string\",\n  \"prompt\": \"string\",\n  \"content\": {\n    \"name\": \"string\",\n    \"inputs\": {},\n    \"decisions\": {},\n    \"functions\": {}\n  },\n  \"output\": {\n    \"property1\": {\n      \"type\": \"noul\",\n      \"instructions\": null,\n      \"criteria\": null,\n      \"options\": {},\n      \"levels\": [\n        null\n      ]\n    },\n    \"property2\": {\n      \"type\": \"noul\",\n      \"instructions\": null,\n      \"criteria\": null,\n      \"options\": {},\n      \"levels\": [\n        null\n      ]\n    }\n  },\n  \"state\": {},\n  \"name\": \"string\",\n  \"mode\": \"fast\",\n  \"dry_run\": true,\n  \"files\": [\n    {\n      \"name\": \"string\",\n      \"type\": \"string\",\n      \"data\": \"string\"\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "https://api.aityx.ai/v1/systemtwo/models",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"model\": \"string\",\n  \"prompt\": \"string\",\n  \"content\": {\n    \"name\": \"string\",\n    \"inputs\": {},\n    \"decisions\": {},\n    \"functions\": {}\n  },\n  \"output\": {\n    \"property1\": {\n      \"type\": \"noul\",\n      \"instructions\": null,\n      \"criteria\": null,\n      \"options\": {},\n      \"levels\": [\n        null\n      ]\n    },\n    \"property2\": {\n      \"type\": \"noul\",\n      \"instructions\": null,\n      \"criteria\": null,\n      \"options\": {},\n      \"levels\": [\n        null\n      ]\n    }\n  },\n  \"state\": {},\n  \"name\": \"string\",\n  \"mode\": \"fast\",\n  \"dry_run\": true,\n  \"files\": [\n    {\n      \"name\": \"string\",\n      \"type\": \"string\",\n      \"data\": \"string\"\n    }\n  ]\n}",
)

Response

{
  "model": {
    "content": {
      "name": "string",
      "inputs": {},
      "decisions": {},
      "functions": {}
    },
    "questions": {
      "property1": {
        "type": "noul",
        "instructions": null,
        "criteria": null,
        "options": {},
        "levels": [
          null
        ]
      },
      "property2": {
        "type": "noul",
        "instructions": null,
        "criteria": null,
        "options": {},
        "levels": [
          null
        ]
      }
    }
  },
  "content": {
    "name": "string",
    "inputs": {},
    "decisions": {},
    "functions": {}
  },
  "output": {
    "property1": {
      "type": "noul",
      "instructions": null,
      "criteria": null,
      "options": {},
      "levels": [
        null
      ]
    },
    "property2": {
      "type": "noul",
      "instructions": null,
      "criteria": null,
      "options": {},
      "levels": [
        null
      ]
    }
  },
  "input": {},
  "examples": [
    {}
  ],
  "usage": {
    "input_tokens": 0,
    "output_tokens": 0
  },
  "provider_usage": {
    "input_tokens": 0,
    "output_tokens": 0
  },
  "billing": {
    "currency": "USD",
    "estimated": false,
    "cost_usd": 0,
    "balance": {
      "currency": "USD",
      "balance_usd": 0,
      "reserved_usd": 0,
      "available_usd": 0
    },
    "items": [
      {}
    ]
  }
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "code": "insufficient_balance",
  "detail": "string",
  "errors": [
    {}
  ]
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "code": "insufficient_balance",
  "detail": "string",
  "errors": [
    {}
  ]
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "code": "insufficient_balance",
  "detail": "string",
  "errors": [
    {}
  ]
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "code": "insufficient_balance",
  "detail": "string",
  "errors": [
    {}
  ]
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "code": "insufficient_balance",
  "detail": "string",
  "errors": [
    {}
  ]
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "code": "insufficient_balance",
  "detail": "string",
  "errors": [
    {}
  ]
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "code": "insufficient_balance",
  "detail": "string",
  "errors": [
    {}
  ]
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "code": "insufficient_balance",
  "detail": "string",
  "errors": [
    {}
  ]
}