KakaFlow KB

Create Enrollment URL API Endpoint

3 phút đọc

Create Enrollment URL API Endpoint

Trust: ★★★☆☆ (0.90) · 0 validations · developer_reference

Published: 2026-05-10 · Source: crawler_authoritative

Tình huống

API endpoint for creating enrollment URLs to onboard end users into Anthropic user profiles beta feature, targeted at developers building applications that integrate Anthropic’s user management system.

Insight

The Create Enrollment URL endpoint is a POST request to /v1/user_profiles/{user_profile_id}/enrollment_url. It requires a user_profile_id path parameter identifying the target user profile. The endpoint accepts optional header parameters via the anthropic-beta header to specify beta version(s) to use. Multiple beta versions can be specified as an array. The full list of available beta versions includes: message-batches-2024-09-24, prompt-caching-2024-07-31, computer-use-2024-10-22, computer-use-2025-01-24, pdfs-2024-09-25, token-counting-2024-11-01, token-efficient-tools-2025-02-19, output-128k-2025-02-19, files-api-2025-04-14, mcp-client-2025-04-04, mcp-client-2025-11-20, dev-full-thinking-2025-05-14, interleaved-thinking-2025-05-14, code-execution-2025-05-22, extended-cache-ttl-2025-04-11, context-1m-2025-08-07, context-management-2025-06-27, model-context-window-exceeded-2025-08-26, skills-2025-10-02, fast-mode-2026-02-01, output-300k-2026-03-24, user-profiles-2026-03-24, advisor-tool-2026-03-01, and managed-agents-2026-04-01. The response returns a BetaUserProfileEnrollmentURL object containing three fields: expires_at (RFC 3339 timestamp), type (always “enrollment_url”), and url (the enrollment URL string).

Hành động

To create an enrollment URL, send a POST request to /v1/user_profiles/{user_profile_id}/enrollment_url. Replace $USER_PROFILE_ID with your target user profile ID and $ANTHROPIC_API_KEY with your API key. Required headers include anthropic-version: 2023-06-01 and X-Api-Key. Include the anthropic-beta: user-profiles-2026-03-24 header (or a later beta version) to access the user profiles feature. The enrollment URL returned is valid until the expires_at timestamp. Example curl command: curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID/enrollment_url -X POST -H 'anthropic-version: 2023-06-01' -H 'anthropic-beta: user-profiles-2026-03-24' -H "X-Api-Key: $ANTHROPIC_API_KEY"

Kết quả

Returns a BetaUserProfileEnrollmentURL object with the enrollment URL string, its RFC 3339 expiration timestamp, and type field set to ‘enrollment_url’. The URL is valid for end-user onboarding until the expires_at time.

Điều kiện áp dụng

Requires the anthropic-beta header with ‘user-profiles-2026-03-24’ or a later beta version. This is a beta API subject to change.

Nội dung gốc (Original)

Create Enrollment URL

post /v1/user_profiles/{user_profile_id}/enrollment_url

Create Enrollment URL

Path Parameters

  • user_profile_id: string

Header Parameters

  • "anthropic-beta": optional array of AnthropicBeta

    Optional header to specify the beta version(s) you want to use.

    • UnionMember0 = string

    • UnionMember1 = "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 21 more

      • "message-batches-2024-09-24"

      • "prompt-caching-2024-07-31"

      • "computer-use-2024-10-22"

      • "computer-use-2025-01-24"

      • "pdfs-2024-09-25"

      • "token-counting-2024-11-01"

      • "token-efficient-tools-2025-02-19"

      • "output-128k-2025-02-19"

      • "files-api-2025-04-14"

      • "mcp-client-2025-04-04"

      • "mcp-client-2025-11-20"

      • "dev-full-thinking-2025-05-14"

      • "interleaved-thinking-2025-05-14"

      • "code-execution-2025-05-22"

      • "extended-cache-ttl-2025-04-11"

      • "context-1m-2025-08-07"

      • "context-management-2025-06-27"

      • "model-context-window-exceeded-2025-08-26"

      • "skills-2025-10-02"

      • "fast-mode-2026-02-01"

      • "output-300k-2026-03-24"

      • "user-profiles-2026-03-24"

      • "advisor-tool-2026-03-01"

      • "managed-agents-2026-04-01"

Returns

  • BetaUserProfileEnrollmentURL = object { expires_at, type, url }

    • expires_at: string

      A timestamp in RFC 3339 format

    • type: "enrollment_url"

      Object type. Always enrollment_url.

      • "enrollment_url"

    • url: string

      Enrollment URL to send to the end user. Valid until expires_at.

Example

curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID/enrollment_url \
    -X POST \
    -H 'anthropic-version: 2023-06-01' \
    -H 'anthropic-beta: user-profiles-2026-03-24' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

Liên kết

Xem thêm:

Sơ đồ

Liên kết ngược