Skip to main content
POST
/
api
/
api-keys
Create an API key
curl --request POST \
  --url https://api.useblueprints.ai/api/api-keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "scopes": []
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "scopes": [],
  "createdAt": "2023-11-07T05:31:56Z",
  "lastUsedAt": "2023-11-07T05:31:56Z",
  "revokedAt": "2023-11-07T05:31:56Z",
  "key": "bp_YOUR_API_KEY"
}

Body

application/json
​
name
string
required
Required string length: 1 - 200
​
scopes
enum<string>[]

Scopes granted to the new key. Send explicit least-privilege scopes for API-created keys.

Available options:
blueprints:read,
blueprints:write,
blueprints:deploy,
orders:read,
orders:write,
market_data:read,
portfolio:read,
portfolio:write,
risk:read,
risk:write,
api_keys:read,
api_keys:write

Response

Created API key including one-time plaintext key.

​
id
string<uuid>
​
name
string
​
scopes
enum<string>[]
Available options:
blueprints:read,
blueprints:write,
blueprints:deploy,
orders:read,
orders:write,
market_data:read,
portfolio:read,
portfolio:write,
risk:read,
risk:write,
api_keys:read,
api_keys:write
​
createdAt
string<date-time>
​
lastUsedAt
string<date-time> | null
​
revokedAt
string<date-time> | null
​
key
string
Example:

"bp_YOUR_API_KEY"