Skip to main content
POST
Add an Anthropic key

Authorizations

X-API-Key
string
header
required

Body

application/json

An Anthropic key to add, or to put in place of one the workspace holds.

api_key
string
required

The key, as Anthropic shows it once. Checked with Anthropic before saving.

Required string length: 1 - 512

Response

Successful Response

The workspace's own Anthropic keys and how its paid AI work uses them.

Never a key: its last four characters. With a key, the AI work that costs credits (the areas switched on) runs on one of the working keys, picked at random, and a row costs the key fee plus the web pages it read.

can_change
boolean
required

Whether the caller may add, replace, pause or remove keys: admins.

key
ClaudeKeyEntrySchema · object | null
required

The key that stands for them all: a working one when any works, so the keys stop AI work only when this one has stopped. Null when none is connected.

key_fee_credits
number
required

What a row on the key costs here, in credits.

keys
ClaudeKeyEntrySchema · object[]
required

Every key, oldest first. Each piece of AI work runs on a working one.

limit_lifts_at
string<date-time>
required

When the month ends (midnight UTC on the next month's first day), and with it a reached limit: the moment held AI work on the keys starts again.

limit_reached
boolean
required

Whether this month reached the limit: AI work on the key waits until limit_lifts_at.

max_keys
integer
required

The most Anthropic keys a workspace may hold.

month
ClaudeKeyMonthSchema · object
required

What AI work on the key cost this calendar month (UTC).

monthly_limit_usd
integer | null
required

AI work on the key stops for the month once our estimate of its Anthropic bill reaches this many dollars; null for no limit.

paid
boolean
required

Whether the workspace is on a paid plan: the key needs one.

paused
boolean
required

True pays all AI work with credits until resumed.

requests_per_minute
integer | null
required

The account's request limit a minute, as Anthropic said at the last check.

slow
boolean
required

Whether that limit is a new Anthropic account's: big runs go slower for now.

use_for_columns
boolean
required

AI columns that answer from the model alone.

use_for_research
boolean
required

Research cells: an AI column with web research, Enrich job, agents.

use_for_writing
boolean
required

Sequence steps and replies the agent writes.