Skip to main content
POST
Issue a scoped workspace API key

Authorizations

__Secure-better-auth.session_token
string
cookie
required

Better Auth session with selected organization. Mutations also require the trusted Origin header.

Body

application/json
name
string
required
Required string length: 1 - 80
scopes
enum<string>[]
required
Minimum array length: 1
Available options:
agents:read,
agents:write,
inboxes:read,
inboxes:write,
email:send,
numbers:read,
sms:read,
numbers:provision,
numbers:release,
sms:send,
events:read
resourceGrants
object | null
dailyInboxLimit
integer | null
Required range: 0 <= x <= 10000
dailyNumberLimit
integer | null
Required range: 0 <= x <= 10000
dailyEmailLimit
integer | null
Required range: 0 <= x <= 10000
dailySmsLimit
integer | null
Required range: 0 <= x <= 10000
agentId
string
Minimum string length: 1
expiresInDays
integer
default:90
Required range: 1 <= x <= 365

Response

Successful JSON response

The response is of type object.