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.
openapi: 3.2.0
info:
title: Agentboxd Com Events API
version: '1'
contact:
name: Agentboxd
url: https://agentboxd.com
email: hello@agentboxd.com
description: 'Operations tagged Events 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: Events
description: The realtime event stream over WebSocket.
paths:
/v1/stream:
get:
operationId: getStream
tags:
- Events
summary: Open the realtime event stream (WebSocket)
description: 'WebSocket (`wss://`). The webhook events, pushed live: `subscribe` with `inbox_ids?`, `event_types?`, `payload?` and `since?` to replay what you missed (last hour, up to 1000 events). Auth: `Authorization: Bearer` on the upgrade, or a stream token. Needs `messages:read`; without `drafts:read`, draft events arrive as envelopes. See Realtime events.
Permission: `messages:read`.'
x-permission: messages: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/stream/token:
post:
operationId: postStreamToken
tags:
- Events
summary: Get a single-use stream URL
description: '→ `201 { token, expires_at, url }`: a single-use URL for `GET /v1/stream`, valid 60 seconds, for browsers. Keys are never accepted in the URL.
Permission: `messages:read`.'
x-permission: messages: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
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