Skip to main content
POST
Create an application

Authorizations

Authorization
string
header
required

A Custral API key, created in Settings → Developers → Applications, sent as Authorization: Bearer sk_…. The X-Api-Key header is also accepted and takes precedence. Use a secret key (sk_…) from your server; a publishable key (pk_…) may hold only objects:read and usage:write. Never expose a secret key in a browser.

Body

application/json
name
string
required
Minimum string length: 1
Example:

"Pied Piper sync"

type
enum<string>
required

Use internal for your own integration.

Available options:
workflow,
internal
description
string
rails
enum<string>
Available options:
webhook,
internal
status
enum<string>
Available options:
private,
unlisted,
public
url
string
providerId
string | null

Response

200 - application/json

The new application.

data
object

A developer application. Keys belong to an application.

reqId
string

A per-request id (req_…). Quote it to support when reporting a problem.

Example:

"req_2a1f9c8e7b6d5"