Skip to content
AbloAblo Docs
Esc
↑↓navigate↵open⌘Jpreview

Mint a short-lived session credential

Call this first: every other route needs the key it returns. Requires a secret (sk_) key — a session cannot mint itself.

POST/v1/ephemeral_keys
Request body
requiredapplication/json
userobjectrequired
Show properties
idstringrequired
min length 1
teamIdsstring[]
organizationIdstring
min length 1
schemaProjectIdstring
min length 1
schemaOwnerOrgIdstring
min length 1
syncGroupsstring[]
Show properties
Array of string
Any of:
string
string
string
string
operationsstring[]
min items 1
activeSchemaOperationsstring[]
min items 1
controlPlaneOnlyboolean
ttlSecondsinteger
max 9007199254740991
labelstring
min length 1
Responses
201The minted credential
objectstring
idstringrequired
min length 1
expiresAtstringrequired
min length 1
organizationIdstringrequired
min length 1
participantIdstringrequired
min length 1
projectIdstring | anyrequired
default: null
Show properties
Any of:
string
string
any
any
branchIdstring | anyrequired
default: null
Show properties
Any of:
string
string
any
any
branchRootbooleanrequired
default: false
syncGroupsstring[]required
deliveryPartitionobject | anyrequired
default: null
Show properties
Any of:
object
indexintegerrequired
min 0 · max 9007199254740991
countintegerrequired
min 2 · max 9007199254740991
any
any
operationsstring[]required
controlPlaneOnlyboolean
tokenstringrequired
min length 1
400The request did not satisfy the published contract.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
401The Bearer credential is missing, malformed, or expired.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
403The credential does not authorize this operation.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
404The addressed resource does not exist in the credential scope.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
409The request conflicts with current claim, version, or idempotency state.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
429The caller exceeded an enforced rate limit.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
500The server could not complete the request.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
503A required service is temporarily unavailable.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
defaultAn HTTP error not otherwise listed; decoded through the canonical envelope.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
Request
curl -X POST "https://api.abloatai.com/api/v1/ephemeral_keys" \
  -H "Content-Type: application/json" \
  -d '{
  "user": {
    "id": "string",
    "teamIds": [
      "string"
    ]
  },
  "organizationId": "string",
  "schemaProjectId": "string",
  "schemaOwnerOrgId": "string",
  "syncGroups": [
    "default"
  ],
  "operations": [
    "string"
  ],
  "activeSchemaOperations": [
    "read"
  ],
  "controlPlaneOnly": true,
  "ttlSeconds": 0,
  "label": "string"
}'
Response
{
  "object": "ephemeral_key",
  "id": "string",
  "expiresAt": "string",
  "organizationId": "string",
  "participantId": "string",
  "projectId": null,
  "branchId": null,
  "branchRoot": false,
  "syncGroups": [
    "string"
  ],
  "deliveryPartition": null,
  "operations": [
    "string"
  ],
  "controlPlaneOnly": true,
  "token": "string"
}