---
title: "POST /api/v1/auth/cli/start"
method: POST
path: "/api/v1/auth/cli/start"
tags: ["auth"]
---

# POST /api/v1/auth/cli/start

`POST /api/v1/auth/cli/start`

## Request

- Base URL: `https://composal.com` (the document declares no server; this is the origin it was published from)
- URL: `https://composal.com/api/v1/auth/cli/start`
- Auth: HTTP bearer

## Request body

- object
  - `name` string
  - `client_kind` 'cli' | 'desktop' | 'android' | 'ios' | 'ios_dev': ios_dev returns to the separate local iOS app; neither iOS client kind accepts an arbitrary callback URL.
  - `intent` 'signin' | 'signup'

## Response `200`

CLI approval request

- CliLoginStart
  - `login_id` string, required
  - `polling_token` string, required
  - `verification_url` string, uri, required
  - `expires_at` string, date-time, required
  - `poll_interval_seconds` integer, required

## Other responses

- `201`: CLI approval request created
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `422`: Unprocessable entity
- `502`: Bad gateway

---

[API](https://skmtc.dev/composal/apis/vex-api.md) - [All operations](https://skmtc.dev/composal/apis/vex-api/llms.txt) - [OpenAPI document](https://skmtc.dev/composal/apis/vex-api/revisions/74298a24e040?raw)