Docs
Documentation
Set up your workspace, connect an application, or run a private deployment. Find console walkthroughs, API and SDK references, serving guides, and examples for extensions and agents.
Working examples
Test an integration, connect a custom serving plugin, or try a floor policy with runnable examples and agent prompts.
Capability guides
Setup guides, examples, and agent prompts for Riptide features.
Complete API reference
Search every Admin API operation and download its OpenAPI contract.
Publishers, apps, placements and domains
Create publishers and placements, then check how ad requests find them.
Direct campaigns and creative delivery
Set up an order, line items, and creatives for a direct campaign.
Audiences, IP lists, dayparts and frequency caps
Define who can receive an ad and test which requests match.
Demand routes, deals and curated marketplaces
Connect your buyer endpoint and configure routes and negotiated deals.
Auction, VAST, OpenRTB and JSON decisions
Send test requests through VAST, OpenRTB, or the JSON Decision API.
CTV, audio, pods and SSAI
Test ad duration and media compatibility before connecting a player or stitched stream.
Beacons, conversions and attribution
Record ad events and compare them with delivery reports.
Supply transparency, verification and privacy
Verify seller authorization and apply consent and invalid-traffic policy.
Reporting, exports and scheduled delivery
Choose metrics and dimensions, run a report, and export CSV.
Delivery alerts, experiments and diagnostics
Find causes of under-delivery and test changes to pacing or targeting.
Verified webhook inbox
Receive signed events and store each event once.
MCP tools and governed agents
Discover available tools and configure agent permissions and action limits.
Decisioners and model promotion
Run an HTTP floor policy and compare it with the baseline in shadow mode.
White-label branding, domains and reseller tenants
Configure your brand and domains, and check that customer tenants remain isolated.
API keys, users, SSO and audit
Manage integration credentials, sign-in, and audit records.
Fees, invoices, payouts and reconciliation
Compare publisher revenue, demand costs, and platform charges.
Open Lake discovery, proposals and receipts
Review marketplace listings, negotiate terms, and inspect fees for a fill.
Stack products and extension installation
Publish an extension and check its installation in your tenant.
Private deployments and cell health
Deploy serving cells and check their health before sending traffic.
BidSource extension
Offer your own creative as a bid candidate in the auction.
DemandAttachment extension
Choose which eligible demand candidates attach to the rendered carrier ad.
DemandAdapter extension
Connect a buyer endpoint that uses your own request and response format.
Enricher extension
Add contextual segments while preserving the signals already on a request.
AudienceEvaluator extension
Evaluate an audience using your own matching rule.
PricingModule extension
Apply a net-price adjustment within the auction's pricing limits.
CreativeRenderer extension
Wrap approved banner markup for your application's display layout.
VerificationVendor extension
Apply an exact-host policy to verification signals and pixel behavior.
How-to video guides
Console walkthroughs with captions, transcripts, and written steps.
Create your first publisher
A publisher identifies who owns your inventory and groups their placements. Add one in the console, choose its public ID, and check the saved record before creating ad slots.
Create your first web video placement
A placement identifies an ad slot so a player can request ads for it. Create one for a preroll in a web video player, then verify its publisher, public ID, and format.
Getting started
Choose a setup guide for your inventory, campaigns, or buyer connection.
Getting started for publishers
Set up a publisher and placement, generate a tag, and check your first ad request.
Getting started for advertisers
Set a campaign budget and schedule, attach approved media, and check delivery.
Getting started for buyers
Connect a buyer endpoint to eligible inventory and set up a deal or marketplace listing.
Admin API
Authenticate API requests, handle retries, and manage Riptide with SDKs or MCP tools.
Publisher API
View publisher placements, run reports, schedule deliveries, and download payout statements.
MCP tools
Discover and invoke Riptide tools on the agent gateway.
Extensions
Choose a plugin, decision service, or MCP integration for the logic you want to customize.
Billing
How Riptide plans, metering, and invoices work.
Architecture
How account changes reach ad serving and how agents manage the platform.
Private deployments
Plan a dedicated Riptide deployment for your infrastructure and traffic.
VAST tag guide
Configure a VAST tag, choose request parameters, and check ad delivery.
OpenRTB guide
POST /ortb in OpenRTB 2.6: inbound fields, response fields, deals, seats, no-bid codes.
Decision API guide
POST /decision: structured JSON decisions with sealed beacon URLs and thin clients.
Beacons guide
Use tracking URLs for impressions, clicks, and conversions, and configure user sync.
Webhooks guide
Event payloads, the timestamped HMAC signature, the retry schedule and secret rotation.
TypeScript SDK
@riptide/admin-client: typed call(operationId) with retries, timeouts, idempotency keys and cursor pages.
Python SDK
Use the Python SDK to call the Admin API, handle errors, and paginate results.
Go SDK
Use the Go SDK to call the Admin API with timeouts, retries, and idempotency keys.
riptide CLI
Manage accounts and campaigns, query reports, and test integrations from the command line.
Need something not covered here?
Tell us what you are trying to set up and which information is missing. For request fields and responses, you can also search the complete API reference.