Sign in
CLI

Start CLI account signup

Changed on

Starts a terminal-native CLI signup. The API creates a pending signup session, sends an email verification code, and returns an opaque signup token used by the resend and verify steps. This endpoint does not require an API key.

post/cli/signup/start

Request

  • Base URL: https://api.primitive.dev/v1
  • URL: https://api.primitive.dev/v1/cli/signup/start
  • Auth: none required

Request body

emailstring email required
terms_acceptedboolean required

Must be true to confirm acceptance of Primitive's Terms of Service and Privacy Policy

device_namestring

Human-readable device name used for the created CLI OAuth grant

metadataobject

Optional client metadata stored with the signup session; serialized JSON must be 2048 bytes or fewer

Response

CLI signup session created and verification email sent

successboolean required

Changes

  • 52138fa51360Revision changes
    • warning

      removed the request property

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

  • 22d1dfc68434Revision changes
    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status