Welcome to the TetraScience application programming interface (API) reference. This guide describes various REST API operations for the Tetra Scientific Data and AI Cloud, related request and response structures, and error codes.
The TetraScience API accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, JSON Web Token (JWT) 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
- Modify files
- Manage Tetra Integrations
- Create and run Tetra Data Pipelines
- Get details on specific pipeline workflows
- Manage artifacts
- Manage system administration settings for logins, tenants, organizations, and users
- Manage event subscriptions
Example API Setups
For example TetraScience API setups, see the ts-scientific-data-cloud-api-examples GitHub repo.
API URLs
Each TDP environment 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/
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:
For access, see Access the TetraConnect Hub.