---
updatedAt: 2026-03-13T22:23:24.000Z
agentTools:
  projectIndex: https://developers.tetrascience.com/llms.txt
---

# Introduction

Welcome to the TetraScience application programming interface (API) reference. This guide describes various REST API operations for the [Tetra OS](https://developers.tetrascience.com/docs/tetra-scientific-data-cloud), related request and response structures, and error codes.

The TetraScience API accepts [form-encoded](https://en.wikipedia.org/wiki/POST_\(HTTP\)#Use_for_submitting_web_forms) request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, [JSON Web Token (JWT) authentication](https://developers.tetrascience.com/reference/authentication), and HTTP methods (verbs).

# Common Workflows

The TetraScience API provides methods to programmatically do the following:

* [Search for and view information about specific files](https://developers.tetrascience.com/reference/data-lake-1)
* [Modify files](https://developers.tetrascience.com/reference/dl-fi-add-labels)
* [Manage Tetra Integrations](https://developers.tetrascience.com/reference/agents-get)
* [Create and run Tetra Data Pipelines](https://developers.tetrascience.com/reference/pipelines)
* [Get details on specific pipeline workflows](https://developers.tetrascience.com/reference/workflows)
* [Manage artifacts](https://developers.tetrascience.com/reference/getprotocolartifacts)
* [Manage system administration settings for logins, tenants, organizations, and users](https://developers.tetrascience.com/reference/get_login-config)
* [Manage event subscriptions](https://developers.tetrascience.com/reference/getsubscription)

# Example API Setups

For example TetraScience API setups, see the [ts-scientific-data-cloud-api-examples](https://github.com/tetrascience/ts-scientific-data-and-ai-cloud-api-examples) GitHub repo.

# API URLs

Each [TDP environment](https://developers.tetrascience.com/docs/release-schedule#/environments-updated-with-each-tdp-release) has a unique API URL that must be used to call TetraScience API endpoints. To identify which API URL to use in your requests, review the following deployment URLs and confirm which one you use to access your target TDP environment. Then, use its listed **API URL** in your requests.

## Tetra-Hosted MT Deployment API URLs

Tetra-hosted multi-tenant (MT) deployments use the following API URLs:

| Region | Deployment URL                | Deployment  | API URL                                         |
| ------ | ----------------------------- | ----------- | ----------------------------------------------- |
| US     |                               |             |                                                 |
|        | platform.tetrascience.com     | MT          | `https://api.tetrascience.com/v1/`              |
|        | platform-us.tetrascience.com  | MT 2        | `https://api.platform-us.tetrascience.com/v1/`  |
|        | gxp.tetrascience.com          | MT GxP Prod | `https://api.gxp.tetrascience.com/v1/`          |
| EU     |                               |             |                                                 |
|        | platform-eu.tetrascience.com  | MT          | `https://api.platform-eu.tetrascience.com/v1/`  |
|        | platform-eu2.tetrascience.com | MT 2        | `https://api.platform-eu2.tetrascience.com/v1/` |
|        | gxp-eu-val.tetrascience.com   | MT GxP Val  | `https://api.gxp-eu-val.tetrascience.com/v1/`   |
|        | gxp-eu.tetrascience.com       | MT GxP Prod | `https://api.gxp-eu.tetrascience.com/v1/`       |

## Tetra-Hosted ST Deployment API URLs

Tetra-hosted single-tenant (ST) deployments use the following API URL format: `https://api.<customer tenant>.tetrascience.com/v1/`

## Customer-Hosted Deployment API URLs

Customer-hosted deployments use the following API URL format: `https://api.<your TDP deployment URL>/v1/`

<Callout icon="📘" theme="info">
  NOTE

  For new TDP environments, TetraScience no longer supports customer-hosted deployments. For more information about managing legacy, customer-hosted TDP deployments, see the following resources in the TetraConnect Hub:

  * [Customer Hosted Deployment Overview](https://tetrascience.zendesk.com/hc/en-us/articles/28431797931789-Customer-Hosted-Deployment-Overview)
  * [Customer Hosted and Tetra Managed Deployment Overview](https://tetrascience.zendesk.com/hc/en-us/articles/28431778522381-Customer-Hosted-and-Tetra-Managed-Deployment-Overview)

  For access, see [Access the TetraConnect Hub](https://developers.tetrascience.com/docs/access-the-tetrascience-knowledge-base).
</Callout>

<br />