API reference · schema

PinCreate

6 fields · used by 0 operations

Last reviewed 2026-10-06

Fields

Field	Type	Meaning
`kind` required	string	hf_model \| http_descriptor \| supplied_descriptor
`reference` required	string	min length `1` · max length `300`
`source_url`	string or null	max length `1000`
`descriptor`	object or null
`workspace_id`	string or null	max length `64`
`notes`	string	max length `1000` · default `""`

Smallest valid example

{
  "kind": "kind",
  "reference": "reference",
  "notes": ""
}

JSON Schema

Show the raw definition

{
  "properties": {
    "kind": {
      "type": "string",
      "title": "Kind",
      "description": "hf_model | http_descriptor | supplied_descriptor"
    },
    "reference": {
      "type": "string",
      "maxLength": 300,
      "minLength": 1,
      "title": "Reference"
    },
    "source_url": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1000
        },
        {
          "type": "null"
        }
      ],
      "title": "Source Url"
    },
    "descriptor": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Descriptor"
    },
    "workspace_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 64
        },
        {
          "type": "null"
        }
      ],
      "title": "Workspace Id"
    },
    "notes": {
      "type": "string",
      "maxLength": 1000,
      "title": "Notes",
      "default": ""
    }
  },
  "type": "object",
  "required": [
    "kind",
    "reference"
  ],
  "title": "PinCreate"
}

Try CAIN-42 on your own agents

Create a free account and every new account starts with a 7-day trial of the full platform. Or try the sandbox first, with no account at all.

Create a free account → · Try the sandbox · See the whole ecosystem