Skip to main content
POST
Obtain an account credential with verified email and password proof

Body

application/json
name
string
required
Required string length: 5 - 300
password
string<password>
required
write-only
Required string length: 1 - 1024
scopes
enum<string>[]
required
Required array length: 1 - 20 elements
Available options:
workspaces:read,
workspaces:write,
workspaces:manage,
members:read,
members:write,
teams:read,
teams:write,
invites:accept,
agents:read,
agents:write,
sources:read,
sources:write,
learnings:read,
learnings:write,
grill:read,
grill:write,
notifications:read,
notifications:write,
credentials:read,
credentials:write
email
string<email>
required
Maximum string length: 254
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Response

Obtain an account credential with verified email and password proof

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
name
string
required
Required string length: 5 - 300
prefix
string
required
scopes
enum<string>[]
required
Required array length: 1 - 20 elements
Available options:
workspaces:read,
workspaces:write,
workspaces:manage,
members:read,
members:write,
teams:read,
teams:write,
invites:accept,
agents:read,
agents:write,
sources:read,
sources:write,
learnings:read,
learnings:write,
grill:read,
grill:write,
notifications:read,
notifications:write,
credentials:read,
credentials:write
expiresAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
token
string
required
read-only

One-time credential secret; not present in subsequent metadata reads.