Skip to content
SegmentationAPI

Create an API key

POST
/v1/api-keys
curl --request POST \
  --url https://api.segmentationapi.com/v1/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "label": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
>= 1 characters <= 128 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
label
required
string
>= 1 characters <= 64 characters
Examplegenerated
{
  "label": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Secret returned once

Media typeapplication/json
object
apiKey
required
object
keyId
required
string
label
required
string
prefix
required
string
revoked
required
boolean
revokedAt
string
nullable
createdAt
required
string
updatedAt
required
string
secret
string
secretUnavailable
required
boolean
Examplegenerated
{
  "apiKey": {
    "keyId": "example",
    "label": "example",
    "prefix": "example",
    "revoked": true,
    "revokedAt": "example",
    "createdAt": "example",
    "updatedAt": "example"
  },
  "secret": "example",
  "secretUnavailable": true
}

401

Section titled “401”

Authentication is missing, invalid, or expired

Media typeapplication/json
object
error
required
string
message
string
remainingTokens
integer
requestedTokens
integer
>= 1
expiresAt
string format: date-time
activeJobId
string
upgradeUrl
string format: uri
retryAfterSeconds
integer
>= 1
Examplegenerated
{
  "error": "example",
  "message": "example",
  "remainingTokens": 1,
  "requestedTokens": 1,
  "expiresAt": "2026-04-15T12:00:00Z",
  "activeJobId": "example",
  "upgradeUrl": "https://example.com",
  "retryAfterSeconds": 1
}