Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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: Bring Your AI Ad Event API
description: 'Public surface for Bring Your AI — the local-first AI agent harness migration,
central Claude/Codex/Cursor sync, sanitized distill snapshot, and no-data
remote MCP server.
The primary programmable surface is the Model Context Protocol endpoint at
`/mcp` (streamable-http JSON-RPC 2.0). REST endpoints below are for discovery
and billing. The MCP discovery manifest is available at
`/.well-known/mcp.json`.
Remote MCP is no-data. It exposes discovery, preview, target listing, and
local install handoff only. It does not accept harness files, generated
memories, user rules, API keys, GitHub handles, or file contents. Actual
moves, central sync, distill snapshots, and first-setup builds run through
the local CLI or local MCP server on the user''s machine. Central sync uses
a local hub by default, can use a user-selected Git repo path, keeps auto
sync disabled by default, never performs Git remote actions, and leaves
platform-native config target-local by default during cross-tool sync.
Commerce endpoints expose a machine-readable catalog, quote, and checkout.
The $499 Team Migration Pack includes one guided migration and onboarding
for up to 10 people, plus 10 lifetime licenses. It uses a dynamic Stripe
Checkout Session. Existing individual licenses keep their Payment Links.
Stripe shared payment token
settlement is live for agents: submit a Link-issued token and buyer email to
create a server-confirmed PaymentIntent and receive the signed license in JSON.
x402/MPP is reserved for future per-call API endpoints.'
version: 1.2.0
contact:
email: hello@bringyour.ai
license:
name: Proprietary — from $19 lifetime license
url: https://bringyour.ai/buy
servers:
- url: https://bringyour.ai
description: Production
tags:
- name: Ad Event
paths:
/api/v1/ad-event:
post:
summary: First-party ad funnel event
description: 'Records non-PII ad funnel events such as `page_view` and
`checkout_click` with UTM, gclid, first-party attribution ID, keyword,
match type, campaign, and landing path metadata. The endpoint does not accept harness files,
generated memories, user rules, API keys, repo paths, file contents, or
buyer email.'
operationId: recordAdEvent
requestBody:
required: false
content:
application/json:
schema:
type: object
responses:
'204':
description: Recorded
tags:
- Ad Event
get:
summary: Pixel-style ad funnel event
description: Records a non-PII ad event from query parameters.
operationId: recordAdEventPixel
responses:
'204':
description: Recorded
tags:
- Ad Event