Skip to content

POST /v1/applications

Availability
Private Preview
Method and path
POST /v1/applications
API version
1.0.0-private-preview
Base URL
https://api.torq.finance
Authentication
SecretKey
Idempotency
Required header: Idempotency-Key.
Rate limits
Read x-ratelimit-* and x-request-id response headers. Do not hard-code a quota.

Authentication requirements

  • SecretKey

Request examples

terminal
curl -X POST 'https://api.torq.finance/v1/applications' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer $TORQ_SECRET_KEY' \
  -H 'Idempotency-Key: $TORQ_IDEMPOTENCY_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"name":"sample_name","environment":"test","scopes":["sample_scopes"]}'
Run a safe sample

This calls the docs preview and returns sample data shaped by the governed OpenAPI response. It never accepts credentials or changes protocol state.

Run the sample call to inspect a schema-shaped response without credentials or side effects.
Request body
ApplicationCreateRequest

Parameters

Idempotency-Key
header
Yes
string

Request schema

ApplicationCreateRequest ApplicationCreateRequest

name
string
Yes
—
slug
string
No
—
environment
enum
Yes
—
scopes
string[]
Yes
—
Inspect nested properties

name string · required

minimum length: 2 · maximum length: 120

slug string · optional

pattern: ^[a-z0-9-]{1,64}$

environment enum · required

one of: test, live

scopes string[] · required

items string

Responses

200
Successful response
ApplicationBootstrap
400
Invalid request
TorqApiError
401
Authentication required
TorqApiError
403
Insufficient scope or authority
TorqApiError
409
State or idempotency conflict
TorqApiError
429
Rate limit exceeded
TorqApiError
500
Internal failure
TorqApiError

200 response schema

ApplicationBootstrap ApplicationBootstrap

id
string
Yes
—
organizationId
string
Yes
—
environment
enum
Yes
—
slug
string
Yes
—
name
string
Yes
—
scopes
string[]
Yes
—
secretKey
string
Yes
—
secretShownOnce
boolean
No
—
Inspect nested properties

id string · required

minimum length: 1 · maximum length: 200

organizationId string · required

minimum length: 1 · maximum length: 200

environment enum · required

one of: test, live

slug string · required

minimum length: 1 · maximum length: 200

name string · required

minimum length: 1 · maximum length: 200

scopes string[] · required

items string

secretKey string · required

minimum length: 1 · maximum length: 200

secretShownOnce boolean · optional

400, 401, 403, 409, 429, 500 response schema

TorqApiError TorqApiError

ok
boolean
Yes
—
code
string
Yes
—
message
string
Yes
—
requestId
string
Yes
—
retryable
boolean
Yes
—
blockedReason
string | null
No
—
docsUrl
string (uri)
No
—
Inspect nested properties

ok boolean · required

code string · required

minimum length: 1 · maximum length: 200

message string · required

minimum length: 1 · maximum length: 200

requestId string · required

minimum length: 1 · maximum length: 200

retryable boolean · required

blockedReason string | null · optional

nullable

docsUrl string (uri) · optional

Related guides

For retry behavior and blocked-state handling, see Errors and rate limits.