Signup

Sign up as an agent

Changed on

Create a Mixpeek organization and API key without a browser. Send the email of the person you work for and accept_terms=true. The response carries a working API key (shown once), a namespace with a bucket, a collection and a retriever, and the calls that take a file to a search result. The email owner gets one email: confirming keeps the key, otherwise it expires 72 hours after signup, and blocking revokes it and refuses later agent signups for that email. One pending signup per email; limited per IP address per hour.

post/v1/signup/agent

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/signup/agent
  • Auth: none required

Request body

emailstring 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.

agent_namestring nullable

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

accept_termsboolean required

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

Example request

{
  "email": "dev@example.com",
  "agent_name": "Claude Code"
}

Response

Successful Response

api_keystring required

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

key_expires_atstring date-time nullable required

When the key stops working unless the email owner confirms.

statusstring required

pending_confirmation until the email owner confirms.

confirmation_sent_tostring required

The email that was sent.

organization_idstring required

The new organization.

namespacestring required

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

namespace_idstring nullable

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

bucketstring required

Bucket to upload files into.

retrieverstring required

Retriever to search with.

creditsinteger required

Credits the organization starts with.

next_stepsstring[] required

The calls that take a file to a search result.

docs_urlstring required

Full API reference.

Changes