Overview This guide shows you how to generate an API key for your account so you can start using the Healthcare AI SaaS API.

Target keywords (5-7)

Full Article

API: Getting your API key

Overview

This guide shows you how to generate an API key for your account so you can start using the Healthcare AI SaaS API. The process takes only a few clicks.

Prerequisites

Step-by-Step Guide

  1. Log in to the platform
- Open your web browser and go to https://app.healthcareai.com.

- Enter your email and password, then click the Log In button in the top‑right corner.

- [Screenshot: Login screen showing email field, password field, and Log In button]

  1. Navigate to the API Settings page
- In the main navigation menu on the left, click Settings.

- From the dropdown that appears, select API Management.

- [Screenshot: Left sidebar with Settings highlighted, then API Management selected]

  1. Open the API Key creation dialog
- On the API Management page, locate the API Keys tab.

- Click the Create New Key button (blue button with a plus icon) positioned at the top right of the key list.

- [Screenshot: Blue "Create New Key" button highlighted]

  1. Enter a name and optional description
- In the Key Name field, type a descriptive name for your key (e.g., research‑team‑api‑v1).

- (Optional) Add a short description in the Description box to remind yourself of the key’s purpose.

- [Screenshot: Form fields labeled "Key Name" and "Description"]

  1. Generate the key
- Click the Generate button. The system will create the key and display it in a pop‑up.

- Copy the key immediately; it will only be shown once.

- [Screenshot: Pop‑up showing the generated key string and a "Copy" button]

  1. Store the key securely
- Paste the key into a secure password manager or a protected document.

- Do not share the key publicly or commit it to source control.

- [Screenshot: Example of a password manager entry field labeled "API Key"]

  1. Add the key to your code or integration
- In your application code, set the environment variable or configuration option to the value you just copied.

- Example (Python): 

import os


     API_KEY = os.getenv("HEALTHCARE_AI_API_KEY")

- [Screenshot: Code snippet with comment indicating where to insert the key]

  1. Test the connection
- Use the Test API button on the API Management page to verify that the key works.

- If the test returns a successful response, your key is ready for production use.

- [Screenshot: Test API button and success message]

Common Issues

IssueLikely CauseFix
“Invalid API key” errorThe key was entered incorrectly or has expired.Double‑check the copied key; regenerate a new key if needed.
“Insufficient permissions”The account lacks Admin/Developer rights.Request the appropriate role from your organization’s admin.
Key not appearing in the listThe key was not saved after generation.Regenerate the key and ensure you click Save (top‑right blue Save button) before leaving the page.
Rate‑limit exceededToo many requests using the key in a short period.Implement exponential back‑off or request a higher quota from support.
Key accidentally exposedThe key was committed to a public repository.Immediately revoke the key, generate a new one, and rotate any dependent credentials.

Related Articles

  1. API: Authentication Basics – Learn how the API uses token‑based authentication.
  2. API: Making Your First Request – Step‑by‑step example of a simple GET request.
  3. API: Rate Limiting & Quotas – How to monitor and manage request limits.

Still Need Help?

If you run into any problems or have questions, please contact support:

Our team is available 24/7 to assist you.

You’re now ready to use your API key with the Healthcare AI SaaS platform. Happy coding!

Ready to stop losing patients to voicemail?

See how MedReceptionist handles your call types in a 15-minute demo.

Book Your Demo