Documentation Center

Quick Start Guide

Launch your first workflow in minutes. Follow the guided path below to authenticate, configure the SDK and trigger your inaugural request.

1. 01

   Create your workspace

   Register in the dashboard, invite your teammates and copy your workspace API key from Settings → Access tokens.

2. 02

   Install the toolkit

   Add the CRLabz SDK or preferred integration to your project using your package manager of choice.

3. 03

   Configure environment

   Add the CRLABZ_API_KEY variable to your environment file and select the target environment (sandbox, staging or production).

4. 04

   Trigger your first call

   Use the `projects.create` helper or the REST endpoint to create a sample project and validate connectivity.

// Install the package
pnpm add @crlabz/sdk

// Initialize the SDK (commented out for deployment)
// import { CRLabzSDK } from '@crlabz/sdk'

// const sdk = new CRLabzSDK({
//   apiKey: process.env.CRLABZ_API_KEY!,
//   environment: 'production',
// })

// Make your first API call (commented out for deployment)
// const project = await sdk.projects.create({
  name: 'My Project',
  type: 'web-app',
})

import { CRLabzProvider, useProjects } from '@crlabz/react-sdk'

function Projects() {
  const { data, isLoading } = useProjects()

  if (isLoading) return <span>Loading...</span>

  return (
    <ul>
      {data?.map((project) => (
        <li key={project.id}>{project.name}</li>
      ))}
    </ul>
  )
}

export function App() {
  return (
    <CRLabzProvider apiKey={process.env.NEXT_PUBLIC_CRLABZ_KEY || 'demo-key'}>
      <Projects />
    </CRLabzProvider>
  )
}

Installation

Install the SDKs, CLIs or language clients that match your stack. Every artifact is published with semantic versioning and signed builds.

Configuration

Configure authentication, retries and logging for each environment. The SDK automatically loads configuration from environment variables.

1. 01

   Create environment files

   Set CRLABZ_API_KEY and CRLABZ_ENVIRONMENT per environment. Never commit secrets—use your platform's secrets manager.

2. 02

   Tune retries

   Define retry strategy with exponential backoff and jitter using the sdk.client.configure method.

3. 03

   Enable observability

   Forward logs and metrics using the built-in logger integrations for Datadog, OpenTelemetry or custom transports.

First Project

Use curated templates to bootstrap new projects. Roll back instantly with preview environments tied to every branch.

1. 01

   Select a template

   Choose from web app, data pipeline, automation workflow or bring your own stack via custom templates.

2. 02

   Provision services

   CRLabz orchestrates storage, secrets and background workers. Track provisioning live inside the dashboard.

3. 03

   Promote to staging

   Validate using preview URLs with automatic seed data and share with stakeholders before going live.

Authentication

Authenticate with OAuth 2.1, API keys or signed JWTs. All requests must include TLS 1.3 with strong cipher suites.

Endpoints

Discover every REST and GraphQL endpoint with sample payloads, expected responses and schema diffs between versions.

Rate Limits

Plan-aware limits keep the platform responsive for everyone. We provide soft warnings, adaptive scaling and transparent quota resets.

Error Handling

Consistent error envelopes keep debugging simple. Pair them with observability hooks to surface actionable insights instantly.

React Integration

Ship dynamic interfaces using React hooks and server components powered by CRLabz.

Next.js Setup

Use CRLabz within the Next.js App Router. Deploy edge-ready APIs without extra boilerplate.

Vue.js Integration

Compose reactive dashboards with Vue 3, Pinia and CRLabz composables.

Mobile SDKs

Offline-first mobile SDKs with delta sync and encrypted persistence.

Security Guidelines

Protect your workspace with defense-in-depth controls and audit trails.

Performance Tips

Unlock millisecond responses with caching, batching and streaming primitives.

Code Standards

Adopt conventions that keep teams productive and codebases consistent.

Testing

Test everything from unit logic to end-to-end workflows with production-like fixtures.

Common Issues

Resolve the most reported issues in minutes using curated playbooks.

Debugging

Trace requests across services and triage incidents with precision.

1. 01

   Capture correlation IDs

   Every response includes an `x-crlabz-trace` header. Log it to stitch platform telemetry with your system.

2. 02

   Replay in the explorer

   Paste the trace ID into the API explorer to replay the failing request with redacted secrets.

3. 03

   Escalate with context

   Attach HAR files, logs and screenshots when contacting support to jump to the resolution stage.

Support

Our specialists respond 24/7 for production incidents. Browse playbooks, open tickets or join office hours.

Community

Connect with thousands of builders shipping with CRLabz. Share knowledge, attend livestreams and access private betas.