Create an app | Runtype Documentation

Create an app. The hostname is {slug}-{shortId}.runtype.run; a client token scoped to that origin is auto-provisioned. Upload a version and activate it to start serving.

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects an object.

namestringRequired1-255 characters

slugstringRequired1-40 characters

Hostname slug: lowercase letters, digits, and hyphens; must start with a letter. The app serves at {slug}-{shortId}.runtype.run.

descriptionstringOptional<=2000 characters

visibilityenumOptionalDefaults to unlisted

Allowed values:

Response

App created

activeVersionIdstring or null

clientTokenIdstring or null

createdAtstring

descriptionstring or null

hostnamestring

idstring

namestring

shortIdstring

slugstring

statusenum

updatedAtstring

urlstring

visibilityenum

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/apps \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Weather Tracker",
>	"slug": "weather-tracker"
>	}'

1	{
2	"activeVersionId": "v1.0.3",
3	"clientTokenId": "ctk_9f8e7d6c5b4a3",
4	"createdAt": "2024-06-10T09:15:00Z",
5	"description": "An app to track and display real-time weather updates.",
6	"hostname": "weather-tracker-4a1b2c.runtype.run",
7	"id": "app_1234567890abcdef",
8	"name": "Weather Tracker",
9	"shortId": "4a1b2c",
10	"slug": "weather-tracker",
11	"status": "active",
12	"updatedAt": "2024-06-10T09:15:00Z",
13	"url": "https://weather-tracker-4a1b2c.runtype.run",
14	"visibility": "public"
15	}