Skip to main content

Enrollment and API Keys

Onboarding overview​

  • Wait for Tiep to approve your tenant. The organization admin we onboard receives a sign in with email link that grants access to your workspace.
  • Once inside the Tiep Platform, decide whether you want to create facilities manually through the UI or programmatically through the public API.
  • Every facility requires its own API keys—keep that in mind as you design your integration workflow.

Generate an organization API key​

  1. Sign in to the platform with the admin account that manages your tenant.
  2. Navigate to API Keys in the left navigation and open the Organization tab.
  3. Select Create API key, enter a descriptive label (for example, Provisioning), and confirm.
  4. Copy the key immediately—the full value is displayed once—and store it in your secret manager.

Use this organization-level key whenever you call endpoints that operate across facilities, such as programmatic facility creation.

Create facilities​

With the organization API key in hand, you can provision facilities either manually or through the API. Each approach ultimately produces the same facility record and enables you to continue with the rest of the integration.

Create a facility in the UI​

  1. In the platform, go to Facilities and select New Facility.
  2. Complete the form with the facility metadata (name, HIS identifier, location, and optional tags).
  3. Submit the form. The facility appears in the list immediately and is available for further configuration.

Create a facility via API​

If you prefer to automate facility provisioning, call the Facilities endpoint.

  1. Issue POST https://api.tiep.ai/v1/facilities with the X-API-Key header set to the organization API key you generated earlier.
  2. Provide the facility metadata in the request body (internal identifier, name, HIS identifier, location metadata, etc.). The internal_id must match your facility id so future API calls can reference it reliably.
  3. Use the internal facility id whenever you create doctors or launch consultations scoped to that site.

Facility API keys​

Once a facility exists, create one or more facility API keys to scope doctor creation, consultations, and report generation.

Generate a facility API key​

  1. Open the facility and navigate to API Keys.
  2. Select Create API key, provide a descriptive name, and confirm.
  3. Copy the generated value immediately—this is the only time the full key is displayed.
  4. Store the key securely. You need it to create doctors assigned to this facility and to call Tiep AI models (for example, transcription and report extraction endpoints).
  5. Rotate keys periodically and delete unused keys to keep your workspace secure.
tip

Each facility can maintain up to three active API keys. Treat them like production secrets and rotate them regularly.

Ready to generate reports? Continue with the report generation guide.