API Quickstart - drio Docs

This page is for developers and technical reviewers. Use the API when you want to automate the same lifecycle that happens in the dashboard: create an app, inspect its draft state, and publish a release.

Before You Start

You need:

a drio account
an OAuth access token for protected routes
a clear reason to automate instead of using the dashboard directly

If you do not have a token yet, start with Authentication. The auth flow means:

discover the authorization server from drio
register a client with the advertised AuthKit issuer
authorize with PKCE against AuthKit
exchange the returned code at AuthKit's token endpoint

Keep the same client_id and registered redirect_uri across the flow.

The Shortest Useful Flow

Most integrations start with these three steps:

create an app
inspect the app and its draft
publish a release

1. Create An App

Use a bearer token to create an app directly. You can optionally attach a starter template id if you want the app to open with a curated starter flow.

curl -X POST https://getdrio.com/api/v2/apps \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Support",
    "slug": "acme-support",
    "description": "Support copilot",
    "company_url": "https://acme.com",
    "starter_template_id": "support-faq"
  }'

The response returns the app summary, including the app id and initialized current_draft.

2. Inspect The App And Draft

Fetch the app to see its current draft and latest published release summary.

curl https://getdrio.com/api/v2/apps/app_123 \
  -H "Authorization: Bearer ACCESS_TOKEN"

Fetch the draft directly when you need explicit draft state:

curl https://getdrio.com/api/v2/apps/app_123/draft \
  -H "Authorization: Bearer ACCESS_TOKEN"

Use the draft change summary when you want to know what will go out in the next release:

curl https://getdrio.com/api/v2/apps/app_123/draft/changes \
  -H "Authorization: Bearer ACCESS_TOKEN"

3. Publish A Release

Publishing creates a new immutable release from the current draft and rotates the app to a fresh successor draft.

curl -X POST https://getdrio.com/api/v2/apps/app_123/releases \
  -H "Authorization: Bearer ACCESS_TOKEN"

The response returns:

the new published release
the next_draft created for subsequent edits

When To Use The API

The API is a good fit when your team wants to:

automate app creation from another internal system
standardize release workflows across multiple apps
inspect current draft state in external tooling
support a technical due diligence or operations workflow

this archived docs set describes v2
archived v1 docs remain available for migration reference only