SDKs

The riptide CLI

Use the riptide CLI to manage resources, run reports, test ad tags, and install extensions from your terminal. The walkthrough below creates a sandbox tenant, loads sample inventory, and checks a VAST response.

Check your first ad in five commands

Follow this walkthrough to check the path from sample inventory to an ad response before connecting your own application. It creates a sandbox tenant, loads sample data and checks VAST output. The commands require permission to create a tenant and load sample data, and use a local console on :8082 and serving endpoint on :8080. For a managed deployment, use your control-plane host and tenant serving domain.

riptide auth login --console http://localhost:8082 --api-key rt_key_...

Save your console URL and operator API key.

riptide tenant create --name Sandbox --slug sandbox --region us --cell cell-local-1 --sandbox

Create a sandbox tenant on the serving cell. Save the tenant ID returned by this command.

```
riptide sample-data load --tenant <tenant-id>
```
Load sample inventory and a campaign: a publisher, video and banner placements, an advertiser, an order, an approved VAST creative, direct and house line items, an audience, and a fee schedule.
```
riptide tag --serve http://localhost:8080 --pub sandbox-pub --tag sandbox-preroll
```
Print the sample placement’s VAST tag URL. Its publisher and placement IDs use your tenant slug.
```
riptide conformance vast --serve http://localhost:8080 --pub sandbox-pub --tag sandbox-preroll
```
After the serving plan is compiled, fetch the tag and check for a VAST 4.x document with an InLine ad, an Impression, and a MediaFile.

Commands

Command	What it does
`riptide auth login --console URL --api-key rt_key_...`	Save the console URL and credential in a config file readable only by your user. Set RIPTIDE_CONSOLE_URL, RIPTIDE_API_KEY, or RIPTIDE_TENANT_ID to override saved values.
`riptide list publishers --tenant ID`	List every page of publishers. Other resources support get, create, update, and archive as defined by the API.
`riptide api <operationId> [--param k=v] [--query k=v] [--body @file] [--all]`	Call an operation by its OpenAPI ID. Use --list to see available operations.
`riptide reports run --from --to --metrics requests,impressions --grain day`	Run a report for the selected dates and metrics.
`riptide stack-product publish <listing-id> \| install <listing-id> --config-json '{...}'`	Publish or install a marketplace stack product.
`riptide tenant create ... --sandbox / riptide sample-data load`	Create a sandbox tenant or load its sample data.
`riptide tag / riptide conformance vast\|ortb`	Generate a tag URL or check VAST and OpenRTB responses.
`riptide ext init decisioner\|sidecar <dir>`	Clone a public extension starter without its history.

Output is JSON on stdout, diagnostics on stderr; exit 0 on success, 1 on an API or transport error, 2 on incorrect usage. Errors include code, hint, and request_id. Calls use the Go SDK's retry, timeout, and idempotency behavior. Install: go install riptide.dev/cmd/riptide@latest from a checkout or the module path.

Call the API from your application

Use a TypeScript, Python or Go SDK when terminal commands need to become part of an application. The API guide links to each client and explains the authentication and request conventions they share.

API and SDK guide API reference