API Reference

Underpeaks exposes a REST API for every model in your project.

Jump to: Hosted · Self-Hosted (Core)

Use it to:

• Read and write content from any frontend, mobile app, or script
• Build custom clients beyond your generated Flutter or Next.js app
• Integrate Underpeaks data into other systems

Hosted

Base URL:

https://studio.underpeaks.com/api-public/v1/{project}/builder/{model}

• {project} — your project ID
• {model} — your model's name

Requests are scoped by tenant and plan — see Authentication.

Studio also exposes hosted-only endpoints for AI completion, transactional email, SMS/OTP, and S3 presigned uploads, backed by connected third-party integrations.

Self-Hosted (Core)

Base URL:

https://your-instance.com/api-public/v1/{project}/{table}

• {project} — your project ID
• {table} — the model's table_name

Integration-backed endpoints (AI, email, OTP, S3 presign) aren't available on Core — Core stays focused on your CMS data and generated apps.

Response format

All responses are JSON. List responses are wrapped with pagination metadata; single-record responses return the record directly. Every error response has the shape { "error": "message" }.

See Endpoints for the exact request and response shape of each operation.