Skip to content

Profile ​

Type: object additionalProperties: false

FieldRequiredTypeDescription and constraints
idYesstringformat: "uuid"
account_idYesstringformat: "uuid"
account_nameYesstring
account_activeYesboolean
activeYesboolean
availableYesboolean
nameYesstring
descriptionYesstring / null
harnessYesstringenum: ["codex"]
modelYesstringminLength: 1
codexYesCodexProfile
instructionsYesstring
is_defaultYesboolean

JSON Schema ​

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

All schemas · HTTP API