Orbi StudioDocs
Dashboard

Health check-ups

Friendly people answer your questions quickly, by phone, chat or email. Every detail is handled by people who care about getting it right.

10 min read Updated May 10, 2026 v3.7.2

Overview

Family plans cover check-ups and vaccinations for everyone under one roof. Video consultations let you speak with a doctor from the comfort of home. Modern equipment means faster diagnoses and more comfortable treatment. Children are welcome, and our paediatric team knows how to make them smile.

Same-day appointmentsWe keep things simple, so you can focus on what matters to you.Certified specialistsBook online in two minutes and see a doctor as soon as today.Online resultsStart in minutes and get help from a real person whenever you need it.

Installation

Install the SDK with the package manager your project already uses. It needs Node 18 or newer.

terminal
$ npm install @orbi-studio/sdk
terminal
$ yarn add @orbi-studio/sdk
terminal
$ pnpm add @orbi-studio/sdk
Using a server without Node? The same endpoints are available over plain HTTPS; see the API reference below.

Configuration

Friendly reminders make sure you never miss a check-up or a dose. We measure success by how many patients come back and tell their friends. Create a file named orbi-studio.config.json in the project root:

orbi-studio.config.json
{
  "project": "orbi-studio",
  "region": "us-east",
  "categories": ["cardiology", "dental", "pediatrics"],
  "retries": 4,
  "timeoutMs": 9000,
  "webhooks": { "enabled": true }
}
OptionTypeDefaultDescription
projectstring-Your project key from the dashboard.
regionstring"us-east"Data centre closest to your patients.
retriesnumber3How often a failed call is retried.
timeoutMsnumber10000Time before a request is cancelled.
webhooks.enabledbooleanfalseSend events to your endpoint.

Your first request

Modern equipment means faster diagnoses and more comfortable treatment.

  1. Create an API keyOpen the dashboard, choose Settings › API keys and copy a new secret key.
  2. Store it safelyKeep the key in an environment variable, never in your source code.
  3. Make the callRun the snippet below; it prints the first page of results.
index.js
import { Client } from "@orbi-studio/sdk";

const client = new Client({ apiKey: process.env.API_KEY });

// list the newest services in one category
const page = await client.services.list({ category: "cardiology", limit: 20 });

for (const item of page.data) {
  console.log(item.name, item.price);
}
Heads up: test keys only return sample data. Switch to a live key before you go to production.

API reference

Every endpoint returns JSON and uses standard HTTP status codes.

GET/v1/servicesList services with paging and filters.
POST/v1/servicesCreate a new service.
PATCH/v1/services/{id}Update some fields of a service.
DELETE/v1/services/{id}Archive a service; it can be restored for 30 days.
response.json
{
  "data": [
    { "id": "service_2929", "name": "Blood test", "price": 123 }
  ],
  "has_more": true
}

Troubleshooting

Every detail is handled by people who care about getting it right. Lab results arrive in your patient portal, usually within 48 hours.

We work with most insurance providers and explain any costs upfront. Our specialists take time to listen and explain every step of your treatment.

Same-day appointments are available for urgent needs on weekdays. Family plans cover check-ups and vaccinations for everyone under one roof.

Next steps

Your records are private, secure and always available when you need them.

Was this page helpful?
All screens