{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/anthropic/main/json-schema/anthropic-beta-create-user-profile-request-schema.json", "title": "BetaCreateUserProfileRequest", "x-generated": "2026-09-23", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/anthropic-user-profiles-beta-true-api-openapi.yml#/components/schemas/BetaCreateUserProfileRequest", "type": "object", "additionalProperties": false, "properties": { "external_id": { "description": "Platform's own identifier for this user. Not enforced unique. Maximum 255 characters.", "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255 }, { "type": "null" } ] }, "name": { "description": "Optional for all profiles. Real-world name of the entity this profile represents (company or individual); for a resold-to company (`relationship` `resold` / `access_type` `passthrough`), that company's name where known. Maximum 255 characters.", "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255 }, { "type": "null" } ] }, "relationship": { "description": "How the entity relates to the platform. `external` (default): an individual end-user. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.", "allOf": [ { "$ref": "#/$defs/BetaUserProfileRelationship" } ], "x-anthropic-beta-required": [ "user-profiles-2026-03-24" ] }, "access_type": { "description": "How the platform uses the API for this entity. `application` (default): the profile represents an individual end-user of the platform's product. `passthrough`: the profile identifies a company the platform resells Claude access to.", "allOf": [ { "$ref": "#/$defs/BetaUserProfileAccessType" } ], "x-anthropic-beta-required": [ "user-profiles-2026-08-18" ] }, "metadata": { "description": "Free-form key-value data to attach to this user profile. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. Values must be non-empty strings.", "type": "object", "additionalProperties": { "type": "string" } } }, "$defs": { "BetaUserProfileAccessType": { "type": "string", "description": "How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company.", "enum": [ "application", "passthrough" ] }, "BetaUserProfileRelationship": { "type": "string", "description": "How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.", "enum": [ "external", "resold", "internal" ] } } }