# Start a CLI device login

- **OpenAPI Version:** `3.2.0`
- **API Version:** `3.1.0`
- **Contact:** Syndai <https://syndai.ai>

## Contents

**Operations**

- [POST /api/v1/cli/device](#scalar-operation-post-apiv1clidevice)

**Schemas**

- [CliDeviceStartRequest](#scalar-schema-clidevicestartrequest)
- [CliDeviceStartResponse](#scalar-schema-clidevicestartresponse)
- [ProblemDetail](#scalar-schema-problemdetail)
- [ExternalErrorCode](#scalar-schema-externalerrorcode)

<a id="scalar-context-global-servers"></a>

## Servers

- **URL:** `https://api.syndai.ai`

<a id="scalar-context-global-authentication"></a>

## Authentication

- **CustomerApiKey**: HTTP bearer (`API Key`)

  Customer API key sent as a bearer token

## Tags

### CLI auth

The device login the `syndai` CLI uses to get an API key: start a login, show the user code to a person to approve in the browser, then poll for the key. Unapproved polls answer with OAuth device-flow errors.

## Operations

<a id="scalar-operation-post-apiv1clidevice"></a>

### Start a CLI device login

- **Method:** `POST`
- **Path:** `/api/v1/cli/device`
- **Operation ID:** `startCliDevice`
- **Tags:** CLI auth

Open a device login (RFC 8628). Show `user_code` and open `verification_uri_complete` in a browser, where an owner or admin of the workspace approves it; poll `POST /api/v1/cli/device/token` every `interval` seconds until `expires_in`. `scopes` asks for a key with exactly those scopes (omit it for the owner CLI set); members and unpublish scopes are never granted here.

**Servers:** [Inherited servers](#scalar-context-global-servers)

#### Authentication

No authentication required.

#### Request body

**Required:** `false`

**Content type:** `application/json`

[CliDeviceStartRequest](#scalar-schema-clidevicestartrequest) | `null`

<a id="scalar-example-1"></a>

**Generated example:**

```json
{
  "client_name": "",
  "host": "",
  "scopes": [
    ""
  ]
}
```

#### Responses

##### 200 Request fulfilled, document follows

**Content type:** `application/json`

[CliDeviceStartResponse](#scalar-schema-clidevicestartresponse)

<a id="scalar-example-2"></a>

**Generated example:**

```json
{
  "device_code": "",
  "expires_in": 1,
  "interval": 1,
  "user_code": "",
  "verification_uri": "",
  "verification_uri_complete": ""
}
```

##### 400, 404, 426, 503

- `400` Bad request syntax or unsupported method
- `404` Resource not found
- `426` CLI\_UPGRADE\_REQUIRED: run npx -y syndai\@latest
- `503` CLI sign-in is unavailable right now

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

RFC 7807 problem detail returned for public CaaS errors.

<a id="scalar-example-3"></a>

**Generated example:**

```json
{
  "code": "BUDGET_EXHAUSTED",
  "detail": null,
  "existing_run_id": null,
  "instance": null,
  "status": 1,
  "title": "",
  "type": "about:blank",
  "additionalProperty": "anything"
}
```

##### 429 Rate limit exceeded

**Headers:**

- **`Retry-After`**

  Seconds to wait before retrying the request

  `integer`

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

RFC 7807 problem detail returned for public CaaS errors.

[Generated example](#scalar-example-3)

##### default Unexpected error

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

<a id="scalar-example-4"></a>

**Generated example:**

```json
null
```

## Schemas

<a id="scalar-schema-clidevicestartrequest"></a>

### CliDeviceStartRequest

**Type:** `object`

- **`client_name`**: `string | null`, maxLength: `200`
- **`host`**: `string | null`, maxLength: `200`
- **`scopes`**: `array`, maxItems: `64`

  **One of:**
  - `array of string`
  - `null`

<a id="scalar-example-5"></a>

**Generated example:**

```json
{
  "client_name": "",
  "host": "",
  "scopes": [
    ""
  ]
}
```

<a id="scalar-schema-clidevicestartresponse"></a>

### CliDeviceStartResponse

**Type:** `object`

- **`device_code` (required)**: `string`
- **`expires_in` (required)**: `integer`
- **`interval` (required)**: `integer`
- **`user_code` (required)**: `string`
- **`verification_uri` (required)**: `string`
- **`verification_uri_complete` (required)**: `string`

<a id="scalar-example-6"></a>

**Generated example:**

```json
{
  "device_code": "",
  "expires_in": 1,
  "interval": 1,
  "user_code": "",
  "verification_uri": "",
  "verification_uri_complete": ""
}
```

<a id="scalar-schema-problemdetail"></a>

### ProblemDetail

**Type:** `object`

RFC 7807 problem detail returned for public CaaS errors.

- **`code` (required)**: `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "VERSION_NOT_DEPLOYED", "INTERNAL_ERROR"`

  Stable error codes surfaced to public CaaS clients.
- **`status` (required)**: `integer`
- **`title` (required)**: `string`
- **`detail`**: `string | null`, default: `null`
- **`existing_run_id`**: `string | null`, default: `null`
- **`instance`**: `string | null`, default: `null`
- **`type`**: `string`, default: `"about:blank"`

<a id="scalar-example-7"></a>

**Generated example:**

```json
{
  "code": "BUDGET_EXHAUSTED",
  "detail": null,
  "existing_run_id": null,
  "instance": null,
  "status": 1,
  "title": "",
  "type": "about:blank",
  "additionalProperty": "anything"
}
```

<a id="scalar-schema-externalerrorcode"></a>

### ExternalErrorCode

**Type:** `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "VERSION_NOT_DEPLOYED", "INTERNAL_ERROR"`

Stable error codes surfaced to public CaaS clients.