Skip to content

Profile ​

Type: object additionalProperties: false

FieldRequiredTypeDescription and constraints
idYesstringformat: "uuid"
nameYesstringminLength: 1
maxLength: 255
descriptionYesstring / nullmaxLength: 4096
harnessYesstringenum: ["codex"]
account_idYesstringformat: "uuid"
account_nameYesstringminLength: 1
maxLength: 255
account_activeYesboolean
activeYesboolean
availableYesboolean
modelYesstringminLength: 1
maxLength: 255
codexYesCodexProfile
instructionsYesstring

JSON Schema ​

json
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "description",
    "harness",
    "account_id",
    "account_name",
    "account_active",
    "active",
    "available",
    "model",
    "codex",
    "instructions"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 4096
    },
    "harness": {
      "type": "string",
      "enum": [
        "codex"
      ]
    },
    "account_id": {
      "type": "string",
      "format": "uuid"
    },
    "account_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "account_active": {
      "type": "boolean"
    },
    "active": {
      "type": "boolean"
    },
    "available": {
      "type": "boolean"
    },
    "model": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "codex": {
      "$ref": "#/components/schemas/CodexProfile"
    },
    "instructions": {
      "type": "string"
    }
  }
}

All schemas · HTTP API