Create surface API key | Runtype Documentation

Create a new API key for a surface. The plaintext key is only returned on creation.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

surfaceIdstringRequired

Request

This endpoint expects an object.

environmentenumOptionalDefaults to test

Allowed values:

expiresAtdatetimeOptional

namestringOptional<=255 characters

rateLimitPerDayintegerOptional>=1

rateLimitPerMinuteintegerOptional>=1

scopeslist of stringsOptional

Capability restrictions. Prefer IDs from get_surface.scopeTargets; linked surface-item/capability IDs and unique names shown in that catalog are accepted and resolved to immutable authorization targets. Use * for unrestricted access.

Response

Surface key created

createdAtstring

environmentstring

expiresAtstring or null

idstring

isActiveboolean

keystring

keyHintstring or null

keyPrefixstring

namestring or null

rateLimitPerDayinteger or null

rateLimitPerMinuteinteger or null

scopeTargetIdslist of strings

scopeslist of strings

surfaceIdstring

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/products/id/surfaces/surfaceId/keys \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Production Key",
>	"rateLimitPerDay": 5000,
>	"rateLimitPerMinute": 60,
>	"scopes": [
>	"surfitem_01jexampleanswer",
>	"surfitem_01jexampleticket"
>	]
>	}'

1	{
2	"createdAt": "string",
3	"environment": "string",
4	"expiresAt": "string",
5	"id": "string",
6	"isActive": true,
7	"key": "string",
8	"keyHint": "string",
9	"keyPrefix": "string",
10	"name": "string",
11	"rateLimitPerDay": 1,
12	"rateLimitPerMinute": 1,
13	"scopeTargetIds": [
14	"string"
15	],
16	"scopes": [
17	"string"
18	],
19	"surfaceId": "string"
20	}