v2

latestOpenAPI 3.1.0Proprietary2026-07-26127193620.1 KB

CLI

Start CLI account signup

Starts a terminal-native CLI signup. signup_code is optional; omit it to sign up without one. 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

Headers

Idempotency-Keystring

Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.

Request body

emailstring email required

signup_codestring

Optional signup code. Omit if you do not have one.

terms_acceptedtrue 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

successtrue required