Create API key - Veri Documentation

POST

/

v1

/

api_keys

Create API key

curl --request POST \
  --url https://api.veri.studio/v1/api_keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "workspace_id": "<string>"
}
'

import requests

url = "https://api.veri.studio/v1/api_keys"

payload = {
    "name": "<string>",
    "email": "<string>",
    "workspace_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', email: '<string>', workspace_id: '<string>'})
};

fetch('https://api.veri.studio/v1/api_keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "object": "<string>",
  "id": "<string>",
  "name": "<string>",
  "key_prefix": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "key": "<string>",
  "last_used_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

API key with the vk_ prefix. Create one from the dashboard.

Body

application/json

name

string

required

email

string | null

Server-injected display email for the authenticated user. Set by the web proxy from the signed-in Clerk session (never trusted from a browser body). Absent for keys minted outside the proxy (SDK, CI). When present, it upserts users.email so /v1/me and the CLI can show the account.

workspace_id

string | null

Workspace the key is scoped to (workspaces design). Stamped by the web proxy from the active Clerk org, or passed explicitly by SDK callers. Absent / equal to the caller's own id => a personal key. Validated server-side at mint: a workspace the caller is not a member of is rejected, so the stamp is a convenience, never an authority.

Response

The created key, including the plaintext value returned once

object

string

required

id

string

required

name

string

required

key_prefix

string

required

created_at

string<date-time>

required

key

string

required

Plaintext key returned ONCE on creation. Save it immediately.

last_used_at

string<date-time> | null

Create API key

curl --request POST \
  --url https://api.veri.studio/v1/api_keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "workspace_id": "<string>"
}
'

import requests

url = "https://api.veri.studio/v1/api_keys"

payload = {
    "name": "<string>",
    "email": "<string>",
    "workspace_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', email: '<string>', workspace_id: '<string>'})
};

fetch('https://api.veri.studio/v1/api_keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "object": "<string>",
  "id": "<string>",
  "name": "<string>",
  "key_prefix": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "key": "<string>",
  "last_used_at": "2023-11-07T05:31:56Z"
}