Docs / Examples

Examples you can run locally

Check an ad response, export a report, receive signed events, or test a custom serving policy. These downloads give you source and local tests to start from, with a guide and coding-agent prompt for adapting each example. Local tests need no Riptide account.

Browse every capability and its agent prompt · Explore the API contract

Integration toolkit

Start here when you need to investigate an integration or move Riptide data into another application. For example, check a new ad tag before wiring up a player, give an analyst a CSV for a defined reporting period, or store creative-approval events for your own workflow.

Five tools inspect workspace configuration, probe serving endpoints, discover MCP tools, export reports and receive signed webhooks. The read clients return JSON or CSV; the receiver stores verified deliveries in a SQLite inbox. You choose the tool that fits the job.

Python 3.9+ · standard library only

What to expect

The local suite ends with OK after checking real HTTP requests against local fixtures, including no fill, failed requests, signature checks and duplicate deliveries. Connecting a tool to your workspace requires the URLs, permissions and resource IDs listed in its README.

Download ZIP Read the guide →

After extracting, run inside integration-recipes/

python3 -m unittest discover -p 'test_*.py' -v

Eight serving plugin examples

Use these examples when your serving integration needs behavior supplied by your own code: bids from an owned endpoint, a contextual audience rule, a net-price adjustment or a wrapper around approved banner markup. Each plugin has a defined place in the serving request.

The archive includes BidSource, DemandAttachment, DemandAdapter, Enricher, AudienceEvaluator, PricingModule, CreativeRenderer and VerificationVendor. Their small, configurable policies let you inspect request and response behavior before replacing them with your own policy.

Go 1.23+ · downloads public module dependencies

What to expect

The smoke command prints nine PASS lines covering all eight kinds and a configured demand adapter through local gRPC servers. It makes no external bidding calls. Live use requires a reachable service, operator conformance review and installation in an authorized tenant.

Download ZIP Read the guide →

After extracting, run inside extension-sidecar/

go test -race ./...
go run . -smoke

HTTP floor Decisioner

Start here when you want to test a floor-pricing rule before it affects auctions. You can inspect the rule's decimal calculations locally, then deploy it in shadow mode to compare its decisions while the baseline continues serving.

The example resolves a base floor, adds a fixed CPM increment and respects a maximum-bid boundary. It includes the HTTP contract, boundary tests and registration steps. The policy is a demonstration; its effect on your inventory needs a separate evaluation.

Go 1.22+ · downloads public module dependencies

What to expect

After the tests pass, the service listens on 127.0.0.1:8089. The README's curl request returns a 2.2500 CPM decision from a 2.0000 base floor. Deploy on public HTTPS before registering the service with Riptide.

Download ZIP Read the guide →

After extracting, run inside decisioner-http/

go test -race ./...
go run . -addr 127.0.0.1:8089

Connect to your own deployment

The Python tools read credentials from environment variables. Set the serving, control-plane, and agent-gateway URLs for the tools you use. Follow the README and --help output, then supply resource IDs from your sandbox. Reporting also requires a configured warehouse.

Choose an integration

Adapt with your coding agent

Every archive includes PROMPT.md. Each capability guide also includes a copyable prompt with the API contract, setup steps and checks to run. These are instructions you can give your coding agent to adapt the example. Supply your policy, deployment details and resource IDs, then review the resulting code and tests.