REST APIv4.2 · Production-grade

A Powerful API for Serious Builders

Build real products on Docyrus with a large, production-grade API surface designed for data-driven SaaS apps, secure portals, and AI Native experiences.

Tenant schemaOAuth2 protectedOpenAPI synced

Available endpoints

GET

/records/:id

Fetch tenant-scoped records with relationships and computed fields resolved.

POST

/records

Create records with the same validation and permission model used inside Docyrus apps.

PUT

/records/:id

Update live data, workflows, and automations without a separate orchestration layer.

Request example

GET /v1/ds/projects/REC_9381

Run request

Headers

Authorization: Bearer access token from your tenant OAuth2 flow
X-Tenant-Id: Tenant context attached to every API operation
Content-Type: JSON payloads for records, queries, and workflow actions

Sample response

{
  "success": true,
  "data": {
    "id": "REC_9381",
    "name": "Apollo Project",
    "status": "active",
    "owner": "usr_91"
  }
}

A modern API surface that stays aligned with Docyrus

The API page now follows the same component language as the rest of the developer hub: tokenized surfaces, readable hierarchy, and fewer one-off visual treatments.

Tenant-aware data endpoints

Full CRUD endpoints for every data source in your tenant, with filtering, sorting, and relationship resolution handled consistently.

GETPOSTPUT

Users schemaJSONata enabled

idstring

emailstring

org_relrelationship

OpenAPI contracts

Your tenant schema is represented as a live contract so SDK generation, testing, and handoff stay current.

JSON spec for code generation

YAML spec for review and governance

Interactive docs for team handoff

OAuth2-first security

Standard flows for browser, mobile, CLI, and server integrations without a separate auth stack.

PKCE Flow

Browser apps and mobile clients

Device Code

CLI tools and operator workflows

Client Credentials

Server-to-server workloads

Type-safe client libraries

Use @docyrus/api-client to skip boilerplate. Automatic token handling, retries, and TypeScript support stay aligned with the same API contract.

Client example

const ds = client.dataSource('projects');
const { data } = await ds.list({
  filter: { status: 'active' },
});

What You Can Build

From internal tools to client-facing SaaS platforms, Docyrus API provides the scale you need to ship real products without rebuilding authentication, data access, or multi-tenancy from scratch.

Use cases

Three common patterns that teams build on the Docyrus API.

Portal view

Acme customer portal

Live

Invoices

$24K settled

Tickets

4 open items

Recent activity

Invoice INV-892 uploaded2h

QBR agenda publishedTomorrow at 2:00 PM

Security audit scheduledMar 20

Acme agent

How can I help you today?

Summarize my open customer issues.

You have 4 open tickets. Highest priority: API rate limit exceeded for enterprise tenant ACME-EU.

Acme customer portal

Role-based data surface powered by Docyrus records

Live

Account snapshot

Invoices

$24K settled

Tickets

4 open items

Recent activity

Invoice INV-892 uploaded2h

QBR agenda publishedTomorrow at 2:00 PM

Security audit scheduledMar 20

Acme agent

How can I help you today?

Summarize my open customer issues.

You have 4 open tickets. Highest priority: API rate limit exceeded for enterprise tenant ACME-EU.

When is the next QBR?

Tomorrow at 2:00 PM. Source: Calendar, Meetings, Billing summary.

Customer Portals

Expose safe, role-based data surfaces to your end users with full tenant isolation.

AI Agent Tools

Give agents explicit, governed access to platform resources via scoped API keys.

Automation Pipelines

Coordinate complex business logic across multiple external tools and data sources.

Frequently asked questions about Docyrus API

What is Docyrus API?+

Docyrus API is a production-grade REST API for building apps, portals, and AI-native products on Docyrus.

When should developers use Docyrus API?+

Developers should use it when they need direct programmatic access to Docyrus data, authentication, and query capabilities.

What can teams ship with Docyrus API?+

Teams can ship secure SaaS products, automations, portals, and AI-enabled workflows against the same backend foundation.

How does Docyrus API fit with other Docyrus developer tools?+

It works alongside MCP tools, UI components, and Docyrus-hosted data models as the core programmable surface of the platform.

Build Faster on a Strong Foundation

Authenticate, call the API, and ship real SaaS products with production-grade stability and confidence.