Quickstart

Confirm credentials and the standard response envelope before building a full workflow.

Prerequisites#

Staging API key from the Vudy dashboard (vudy_sandbox_…)
Ability to send HTTPS requests (curl or JavaScript fetch)

1. Check platform status (public)#

curl -sS https://api-stg.vudy.app/v1/maintenance

const res = await fetch("https://api-stg.vudy.app/v1/maintenance");
const body = await res.json();
console.log(body);
// { success: true, data: { status: "ok" | "limited" | "maintenance" } }

`status`	Meaning
`ok`	Login and KYC-gated flows are open
`limited`	Login open; KYC-gated payments may be blocked
`maintenance`	OTP auth is closed

2. Call a configuration endpoint with your API key#

curl -sS https://api-stg.vudy.app/v1/config/chains \
  -H "x-api-key: vudy_sandbox_YOUR_KEY"

const res = await fetch("https://api-stg.vudy.app/v1/config/chains", {
	headers: {
		"x-api-key": process.env.VUDY_API_KEY, // vudy_sandbox_…
	},
});
const body = await res.json();

if (!body.success) {
	throw new Error(`${body.error.code}: ${body.error.message}`);
}

console.log(body.data.chains);

Success looks like:

{
	"success": true,
	"data": {
		"chains": []
	}
}

Errors use:

{
	"success": false,
	"error": {
		"code": "SERVER_VALIDATION_API_AUTH_01",
		"message": "Human-readable explanation",
		"details": {}
	}
}

3. What to build next#

Goal	Guide
Integrate with AI coding agents	Skills
Create a user and session	Onboarding with OTP
Discover and execute a channel	Channel payments
Create a payable request	Vudy payment requests
Understand envelopes and HTTP statuses	Responses and errors

For production, switch the base URL to https://api.vudy.app and use a vudy_production_… key. See Environments.