Artemise
Docs
Sign in
API reference

SDK auth (device flow)

POST /v1/sdk-auth/start and /v1/sdk-auth/poll — how SDK login works on the wire.

The only unauthenticated endpoints in the API — they bootstrap a key for an SDK that doesn't have one yet. Approval always happens in a signed-in browser session and requires an active subscription.

Start a login

POST /api/v1/sdk-auth/start
{
  "device_code": "adc_…",
  "user_code": "ABCD-1234",
  "verification_url": "https://www.artemise.live/connect?code=ABCD-1234",
  "expires_in": 600,
  "interval": 3
}

Show verification_url (or user_code) to the user. Keep device_code secret — it's the bearer for the claim.

Poll for the result

POST /api/v1/sdk-auth/poll

Body: { "device_code": "adc_…" }. Poll every interval seconds.

Responses:

  • { "status": "pending" } — keep polling
  • { "status": "ok", "api_key": "ns_live_…" } — returned exactly once
  • { "status": "denied" } — the user rejected the request
  • { "status": "expired" } — 10-minute TTL elapsed; start over
  • { "status": "claimed" } — the key was already retrieved
DraftsErrors, quotas & limits