Skip to main content
This guide walks you through every step from creating your Max AI developer account to making your first API call.

​
Step 1: Get a Developer Account

To access the Max AI API, you need a developer account.
  1. Contact the Max AI team to request developer access. Reach out via maxcare.ai or your sales contact.
  2. The Max AI team will provision a developer account for you.
  3. You’ll receive credentials to sign in at app.maxcare.ai.

​
Step 2: Create Your App

Once you have a developer account, create your first app in the Max AI dashboard:
  1. Sign in at app.maxcare.ai
  2. Navigate to the Marketplace section
  3. Click Create App
  4. Fill in the required information:
    • App name — A human-readable name for your app
    • Description — What your app does
    • App URL — Your app’s first page that’s embedded in Max AI when users click on your App name.
    • Category — The category that best describes your app
    • Billing plan — How clinics will be billed for your app
    • Required scopes — Which data your app needs access to (see Scopes)
  5. Submit your app for review
New apps are created in Draft status. You must submit your app for review before it can be installed by clinics. The Max AI team will review your submission and approve or deny it with feedback.

​
Step 3: Get Your API Key

After your app is approved:
  1. Go to your app’s settings page in the dashboard
  2. Under API Keys, click Generate New Key
  3. Copy the key immediately — it is only shown once
Your API key looks like this: 
max_prd_ak_SBA...01S
Keep your API key secret. Never expose it in client-side code, public repositories, or logs. If your key is compromised, revoke it immediately and generate a new one.

​
Step 4: Identify the Target Organization

Every API request requires an Organization ID in the X-Organization-Id header. This identifies which clinic’s data you’re accessing. You can get the Organization ID in two ways:
  • From the App Bridge — If you’re building an embedded app, the @max-ai/app-bridge SDK provides the Organization ID automatically via the app context.
  • From the API — Call the /v1/marketplace/me endpoint to retrieve your app’s identity, including the Organization ID for the currently authenticated connection.

​
Step 5: Make Your First Request

Verify your setup by calling the /v1/marketplace/me endpoint. This returns your app’s identity and the organization you’re connected to. 
curl -X GET "https://api.maxcare.ai/v1/marketplace/me" \
  -H "Authorization: Bearer max_prd_ak_SBA...01S" \
  -H "X-Organization-Id: org_abc123"

​
Successful Response

{
  "code": "success",
  "data": {
    "app": {
      "id": "app_01J5K8N2XRQV3M7YGWT4HB6E9C",
      "slug": "my-healthcare-app",
      "liveVersionId": "ver_01J5K8N2XRQV3M7YGWT4HB6E9C"
    },
    "organization": {
      "id": "org_abc123",
    },
    "scopes": [
      "read:patients",
      "read:appointments",
      "read:providers",
      "read:bills"
    ]
  }
}
If you see a successful response, congratulations — your app is set up and authenticated.

​
Next Steps

Authentication

Deep dive into API authentication and headers.

Scopes

Understand which scopes grant access to which endpoints.

App Development

Use the template app and SDK to build faster.

API Reference

Browse all available endpoints.