Loading...
    • Developer Guide
    • API Reference
    • MCP
    • Resources
    • Release Notes
    Search...
    ⌘K
    Using the API
    API overviewBeta headersErrors
    Messages
    Create a Message
    Count tokens in a Message
    Models
    List Models
    Get a Model
    Beta
    Create User Profile
    List User Profiles
    Get User Profile
    Update User Profile
    Create Enrollment URL
    Admin
    Completions
    Create a Text Completion
    Support & configuration
    Rate limitsService tiersVersionsIP addressesSupported regionsOpenAI SDK compatibility
    Console
    Log in

    User Profiles

    Create User Profile
    client.beta.userProfiles.create(UserProfileCreateParams { external_id, metadata, betas } params, RequestOptionsoptions?): BetaUserProfile { id, created_at, metadata, 4 more }
    POST/v1/user_profiles
    List User Profiles
    client.beta.userProfiles.list(UserProfileListParams { limit, order, page, betas } params?, RequestOptionsoptions?): PageCursorV2<BetaUserProfile { id, created_at, metadata, 4 more } >
    GET/v1/user_profiles
    Get User Profile
    client.beta.userProfiles.retrieve(stringid, UserProfileRetrieveParams { betas } params?, RequestOptionsoptions?): BetaUserProfile { id, created_at, metadata, 4 more }
    GET/v1/user_profiles/{id}
    Update User Profile
    client.beta.userProfiles.update(stringid, UserProfileUpdateParams { external_id, metadata, betas } params, RequestOptionsoptions?): BetaUserProfile { id, created_at, metadata, 4 more }
    POST/v1/user_profiles/{id}
    Create Enrollment URL
    client.beta.userProfiles.createEnrollmentURL(stringid, UserProfileCreateEnrollmentURLParams { betas } params?, RequestOptionsoptions?): BetaUserProfileEnrollmentURL { expires_at, type, url }
    POST/v1/user_profiles/{id}/enrollment_url
    ModelsExpand Collapse
    BetaUserProfile { id, created_at, metadata, 4 more }
    id: string
    created_at: string

    A timestamp in RFC 3339 format

    metadata: Record<string, string>
    trust_grants: Record<string, BetaUserProfileTrustGrant { status } >
    status: string
    type: string
    updated_at: string

    A timestamp in RFC 3339 format

    external_id?: string | null
    BetaUserProfileEnrollmentURL { expires_at, type, url }
    expires_at: string

    A timestamp in RFC 3339 format

    type: string
    url: string
    BetaUserProfileTrustGrant { status }
    status: string

    Solutions

    • AI agents
    • Code modernization
    • Coding
    • Customer support
    • Education
    • Financial services
    • Government
    • Life sciences

    Partners

    • Amazon Bedrock
    • Google Cloud's Vertex AI

    Learn

    • Blog
    • Catalog
    • Courses
    • Use cases
    • Connectors
    • Customer stories
    • Engineering at Anthropic
    • Events
    • Powered by Claude
    • Service partners
    • Startups program

    Company

    • Anthropic
    • Careers
    • Economic Futures
    • Research
    • News
    • Responsible Scaling Policy
    • Security and compliance
    • Transparency

    Learn

    • Blog
    • Catalog
    • Courses
    • Use cases
    • Connectors
    • Customer stories
    • Engineering at Anthropic
    • Events
    • Powered by Claude
    • Service partners
    • Startups program

    Help and security

    • Availability
    • Status
    • Support
    • Discord

    Terms and policies

    • Privacy policy
    • Responsible disclosure policy
    • Terms of service: Commercial
    • Terms of service: Consumer
    • Usage policy