Skip to main content
POST
Create API template.

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Body

application/json
name
string
required

Name.

path
string
required

Normalized path (e.g. /api/v1/users/:userId, /_/auth, or /users/@)

Maximum string length: 1024
method
enum<string>
required

Method.

Available options:
GET,
POST,
PUT,
PATCH,
DELETE
active
boolean
default:true

Whether the endpoint is active immediately after creation. Set false for validate-before-activate rollouts.

category
string

Category.

desc
string

Description.

metadata
object

Optional resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

componentId
string

Component identifier.

componentVersion
number

Exact low-code component version to pin for a stable rollout. CUSTOM_NODEJS endpoints always execute the component active runtime revision and must omit this field.

timeout
number
default:60

Endpoint execution timeout in seconds. The effective maximum is resolved at runtime from the current instance quota.

Required range: x >= 1
Example:

60

options
object

Endpoint runtime options stored as loose JSONB. Custom low-code input values live under "input"; first-class keys such as "guard", "componentSchemaId", "componentSchemaVersion", "componentSchemaElement", "popResult", "httpCode", "legacyResults", and "memory" live at the options root.

Response

Job scheduled.

Last modified on September 5, 2026