# Create an app API key

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

## Contents

**Operations**

- [POST /api/v1/external/coding/customers/{customer\_id}/repositories/{coding\_repository\_id}/publication/data/api/keys](#scalar-operation-post-apiv1externalcodingcustomerscustomer-idrepositoriescoding-repository-idpublicationdataapikeys)

**Schemas**

- [ApiKeyCreateRequest](#scalar-schema-apikeycreaterequest)
- [ApiKeyCreated](#scalar-schema-apikeycreated)
- [ApiKeyRead](#scalar-schema-apikeyread)
- [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

### Apps

Beta: may change without notice. Publishing a repository as a hosted app: publish, unpublish, read and update a publication, its deployments, custom domain, runtime and monthly AI limit, and export its data or waitlist.

## Operations

<a id="scalar-operation-post-apiv1externalcodingcustomerscustomer-idrepositoriescoding-repository-idpublicationdataapikeys"></a>

### Create an app API key

- **Method:** `POST`
- **Path:** `/api/v1/external/coding/customers/{customer_id}/repositories/{coding_repository_id}/publication/data/api/keys`
- **Operation ID:** `createAppApiKey`
- **Tags:** Apps

Makes a key for server-to-server calls to the app's `/api` and `/sync`, acting as member `acts_as` (null: the owner), so the app's rules judge it like that person. The answer carries the key ONCE (`key`); only its SHA-256 is kept. `browser` lets other sites' web pages use it (CORS); off, it works only from servers and the app itself. At most 20 per app. Needs `coding:apps:publish`.

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

**Authentication:** [Global authentication](#scalar-context-global-authentication)

#### Path parameters

- **`customer_id` (required)**: `string`, format: `uuid`
- **`coding_repository_id` (required)**: `string`, format: `uuid`

#### Request body

**Required:** `true`

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

[ApiKeyCreateRequest](#scalar-schema-apikeycreaterequest)

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

**Generated example:**

```json
{
  "acts_as": "",
  "browser": false,
  "label": ""
}
```

#### Responses

##### 200 Request fulfilled, document follows

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

[ApiKeyCreated](#scalar-schema-apikeycreated)

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

**Generated example:**

```json
{
  "key": "",
  "record": {
    "acts_as": "",
    "browser": true,
    "created_at": "",
    "id": "",
    "label": "",
    "last_used_at": "",
    "member_id": ""
  }
}
```

##### 400, 401, 403, 404

- `400` Bad request syntax or unsupported method
- `401` Invalid or missing customer API key
- `403` Insufficient scope or forbidden customer access
- `404` Resource not found

**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-apikeycreaterequest"></a>

### ApiKeyCreateRequest

**Type:** `object`

- **`label` (required)**: `string`, minLength: `1`, maxLength: `80`
- **`acts_as`**: `string | null`, pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
- **`browser`**: `boolean`, default: `false`

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

**Generated example:**

```json
{
  "acts_as": "",
  "browser": false,
  "label": ""
}
```

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

### ApiKeyCreated

**Type:** `object`

- **`key` (required)**: `string`
- **`record` (required)**: [ApiKeyRead](#scalar-schema-apikeyread)

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

**Generated example:**

```json
{
  "key": "",
  "record": {
    "acts_as": "",
    "browser": true,
    "created_at": "",
    "id": "",
    "label": "",
    "last_used_at": "",
    "member_id": ""
  }
}
```

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

### ApiKeyRead

**Type:** `object`

- **`acts_as` (required)**: `string`
- **`browser` (required)**: `boolean`
- **`id` (required)**: `string`
- **`label` (required)**: `string`
- **`member_id` (required)**: `string`
- **`created_at`**: `string | null`
- **`last_used_at`**: `string | null`

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

**Generated example:**

```json
{
  "acts_as": "",
  "browser": true,
  "created_at": "",
  "id": "",
  "label": "",
  "last_used_at": "",
  "member_id": ""
}
```

<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", "PUBLISH_TAG_EXISTS", "PUBLISH_VERSION_EXISTS", "VERSION_NOT_DEPLOYED", "DATA_REFUSED", "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-8"></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", "PUBLISH_TAG_EXISTS", "PUBLISH_VERSION_EXISTS", "VERSION_NOT_DEPLOYED", "DATA_REFUSED", "INTERNAL_ERROR"`

Stable error codes surfaced to public CaaS clients.