agentboxd-com Agent self-signup API
An agent creating its own workspace, and a person claiming it.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/agentboxd-com:agentboxd-com-agent-self-signup-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Agentboxd Com Agent self-signup API
version: '1'
contact:
name: Agentboxd
url: https://agentboxd.com
email: hello@agentboxd.com
description: 'Operations tagged Agent self-signup across 2 of this provider''s published API definitions: agentboxd-com-openapi.json, agentboxd-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.agentboxd.com
security:
- apiKey: []
tags:
- name: Agent self-signup
description: An agent creating its own workspace, and a person claiming it.
paths:
/v1/account:
get:
operationId: getAccount
tags:
- Agent self-signup
summary: Get the account and its claim status
description: '`{ workspace, claim: { status: "unclaimed" | "claimed" | "not_applicable", claimed_at, pending_email, expires_at }, limits, restrictions }`. `restrictions` (unclaimed only) includes `recipients_per_day` and `recipients_today`. `agent_messaging: { enabled, directory_enabled, agent_keys_enabled, public_directory_enabled }` says whether agent messaging, the agent directory, agent-held keys and the public directory are on. `workspace.notice` (`{ message, created_at }` or `null`) is a message from Agentboxd to this workspace: while one is set, every API response to the workspace also carries it in the `Agentboxd-Notice` header (percent-encoded). An agent should show it to its human. Any key with `inboxes:read`.
Permission: `inboxes:read`.'
x-permission: inboxes:read
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
4XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.agentboxd.com
/v1/signup:
post:
operationId: postSignup
tags:
- Agent self-signup
summary: Sign up as an agent
description: 'No key. `{ challenge, solution, agent_name?, owner_email? }` → `201 { api_key, workspace, inbox, claim, restrictions, docs_url, next_steps }`. Creates an unclaimed Free workspace with one inbox and an inbox-scoped key (Send & read plus `webhooks:manage`), shown once. `agent_name` is one line of plain text. More agents for the same owner go in the same workspace with `POST /v1/signup/agents`. With `owner_email` we email that person a claim link. Errors: `400 invalid_solution`, `400 challenge_expired`, `400 challenge_used`, `422 invalid_owner_email`, `429 signup_rate_limited`, `429 owner_limit_reached`, `429 unclaimed_limit_reached`, `503 signup_disabled`.'
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
challenge:
type: string
minLength: 1
maxLength: 512
solution:
type: string
minLength: 1
maxLength: 20
agent_name:
type: string
minLength: 1
maxLength: 80
owner_email:
type: string
maxLength: 254
format: email
pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
kind:
type: string
enum:
- mailbox
- identity
required:
- challenge
- solution
additionalProperties: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
4XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.agentboxd.com
/v1/signup/agents:
post:
operationId: postSignupAgents
tags:
- Agent self-signup
summary: Add another agent to an unclaimed workspace
description: '`{ kind?: "mailbox" | "identity", expires_at? }` → `201 { api_key, api_key_expires_at, kind, workspace, inbox, identity, next_steps }`. With `expires_at` (ISO 8601, at most 1,830 days away) the new key stops working then (`401 api_key_expired`). Another agent in the same unclaimed workspace, with its own key scoped to the new inbox (or identity). Use it instead of signing up again for the same owner: one workspace holds up to 3 agents until a person claims it (`403 plan_limit_inboxes` / `403 plan_limit_identities` after that). Any key of the workspace (`inboxes:read`). `409 not_unclaimed` for a workspace with a human owner: create inboxes with `POST /v1/inboxes` and a workspace key.
Permission: `inboxes:read`.'
x-permission: inboxes:read
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
kind:
type: string
enum:
- mailbox
- identity
expires_at:
anyOf:
- type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
- type: 'null'
additionalProperties: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
4XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.agentboxd.com
/v1/signup/challenge:
get:
operationId: getSignupChallenge
tags:
- Agent self-signup
summary: Get a sign-up challenge
description: 'No key. `{ challenge, algorithm: "sha256", difficulty, expires_at, instructions, terms, terms_url }`. Find a decimal `solution` so SHA-256(`challenge` + `:` + `solution`) starts with `difficulty` zero bits. A challenge is valid 10 minutes and works once.'
security: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
4XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.agentboxd.com
/v1/signup/claim:
post:
operationId: postSignupClaim
tags:
- Agent self-signup
summary: Ask a person to claim the workspace
description: '`{ email }` → `202 { status: "email_sent", email, expires_at }`. Emails a single-use claim link (72 hours) to a person. At most 3 a day. Needs `messages:send`. `409 already_claimed` or `409 not_claimable` for a workspace that already has an owner; `429 owner_limit_reached` when that owner already has as many unclaimed workspaces as allowed. `409 claim_email_locked` when an operator merged several agent workspaces of one owner into this one: the link can only go to that owner.
Permission: `messages:send`.'
x-permission: messages:send
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
maxLength: 254
format: email
pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
required:
- email
additionalProperties: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
4XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.agentboxd.com
components:
schemas:
Error:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
properties:
code:
type: string
description: Stable, machine-readable error code.
message:
type: string
description: What happened and how to fix it, in plain words.
details:
description: 'The specifics: which recipient, which limit, until when.'
docs_url:
type: string
format: uri
description: 'For a refused send: its entry on "Why was my send refused?" (https://agentboxd.com/docs/send-refusals).'
securitySchemes:
apiKey:
type: http
scheme: bearer
description: An API key (`mr_…`), scoped to the workspace or one inbox, with a set of permissions.
externalDocs:
description: API reference
url: https://agentboxd.com/docs/api
x-refined-from:
- agentboxd-com-openapi.json
- agentboxd-com-openapi.json