Start a Demo Session

POST

auth

demo

Start a demo sandbox session

curl --request POST \
  --url https://billing.example.com/auth/demo \
  --header 'Authorization: <api-key>'

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://billing.example.com/auth/demo', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/auth/demo",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/auth/demo"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/auth/demo")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "demo": true,
    "email": "jsmith@example.com",
    "api_key": "<string>"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

Opens a dashboard session as the seeded demo user in the shared sandbox and returns the demo account’s email and API key. The session cookie (recurso_session) is the same one a password login issues, so everything downstream — the dashboard, roles, audit actors — behaves as it would for a real user. The sandbox is reset on a schedule; anything you create in it is temporary. The route exists only on deployments started with DEMO_MODE enabled. On every other deployment the route is not registered and the server answers 404. No credentials or request body are required.

Example Request

curl -X POST https://api.recurso.dev/auth/demo \
  -c cookies.txt

Example Response

{
  "data": {
    "demo": true,
    "email": "demo@demo.recurso.dev",
    "api_key": "sk_test_12345"
  }
}

Fields

Field	Type	Description
`demo`	boolean	Always `true`; marks the session as a sandbox session.
`email`	string	The demo user’s email address.
`api_key`	string	A test-mode API key for the demo tenant, for calling `/v1` endpoints with `Authorization: Bearer` — see Authentication.

Errors

Status	Code	When	Fix
`404`	—	The server is not running in `DEMO_MODE`; the route does not exist.	Use the hosted demo, or start your own deployment with `DEMO_MODE=true`.
`500`	`internal_error`	The demo user exists but a session could not be opened.	Retry; if it persists, contact support.
`503`	`internal_error`	The sandbox is still bootstrapping its demo tenant and user.	Wait a few seconds and retry.

The 500 and 503 errors use the standard envelope — see Errors. The 404 does not: outside DEMO_MODE the route is never registered, so the router answers with its plain-text 404 page not found and no JSON body or error code.

Authorizations

Authorization

string

header

required

Response

Demo session opened. Sets the recurso_session cookie.

data

object

Show child attributes

Start a demo sandbox session

curl --request POST \
  --url https://billing.example.com/auth/demo \
  --header 'Authorization: <api-key>'

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://billing.example.com/auth/demo', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/auth/demo",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/auth/demo"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/auth/demo")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "demo": true,
    "email": "jsmith@example.com",
    "api_key": "<string>"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Example Request

Example Response

Fields

Errors

Authorizations

Response

​Example Request

​Example Response

​Fields

​Errors

Authorizations

Response

Example Request

Example Response

Fields

Errors