---
title: "create instance"
method: POST
path: "/instances"
tags: ["instances"]
---

# create instance

`POST /instances`

Create a new instance. Optionally set a name and webhook configuration.

## Request body

- InstanceUpdate
  - `name` string
  - `webhook` object
    - `url` string
    - `events` EventType[]

## Response `201`

The created instance

- object
  - `instance` Instance
    - `id` integer
    - `name` string
    - `owner` string
    - `webhook_url` string
    - `webhook_events` EventType[]
    - `is_trial` boolean
  - `status` 'success' | 'error'

## Other responses

- `401` — Unauthorized — invalid or missing bearer token
- `403` — Forbidden — insufficient permissions or account blocked
- `404` — Not found — instance does not exist or does not belong to you
- `409` — Conflict — instance is not ready
- `422` — Validation error — invalid or missing request parameters
- `429` — Too many requests — rate limit exceeded

---

[API](https://skmtc.net/waapi/apis/waapi-api.md) · [All operations](https://skmtc.net/waapi/apis/waapi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/waapi/waapi-api/revisions/1e2cc7c12090/schema)