Skip to main content
POST
Sign up as an agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Keys this body does not declare are refused with 422 extra_forbidden naming the accepted keys (since 2026-11-02).

What an agent sends to get its own API key.

email
string<email>
required

Email of the person the agent works for. They get one email with a link to keep the key and a link to block it. Until they confirm, the key expires 72 hours after signup.

Example:

"dev@example.com"

accept_terms
boolean
required

Must be true: the email owner's use is governed by the terms at https://mixpeek.com/terms

agent_name
string | null

Name of the agent or tool signing up, shown in that email.

Maximum string length: 80
Example:

"Claude Code"

Response

Successful Response

The key and workspace an agent gets back. The key is shown only here.

api_key
string
required

Send as 'Authorization: Bearer <api_key>'. Returned once; Mixpeek stores only its hash.

key_expires_at
string<date-time> | null
required

When the key stops working unless the email owner confirms.

status
string
required

pending_confirmation until the email owner confirms.

confirmation_sent_to
string
required

The email that was sent.

organization_id
string
required

The new organization.

namespace
string
required

Send as the 'X-Namespace' header. It holds a bucket, a collection and a retriever, ready to index and search.

bucket
string
required

Bucket to upload files into.

retriever
string
required

Retriever to search with.

credits
integer
required

Credits the organization starts with.

next_steps
string[]
required

The calls that take a file to a search result.

docs_url
string
required

Full API reference.

namespace_id
string | null

Namespace id, or null if it is still being created.