Skip to main content
POST
Create Custom Api

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request model for creating a Custom API.

name
string
required

API name

Required string length: 1 - 100
description
string | null

API description

url
string | null

API URL

Required string length: 1 - 500
method
string | null
default:GET

HTTP method

headers
Headers · object | null

HTTP headers

body
string | null

HTTP body (JSON template)

env
Env · object | null

Environment variables (secrets)

is_active
boolean
default:true

Whether the API is active

Response

Successful Response

Response model for Custom API.

id
integer
required
user_id
integer
required
name
string
required
description
string | null
required
url
string | null
required
method
string | null
required
headers
Headers · object | null
required
body
string | null
required
env
Env · object | null
required
is_active
boolean
required
is_default
boolean
required
created_at
string
required
updated_at
string
required