Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TetraScience Protocols API

The Protocols API from TetraScience — 11 operation(s) for protocols.

TetraScience Protocols API is one of 35 APIs that TetraScience publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Protocols. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, a changelog, and authentication docs.

This API exposes 11 operations across 11 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 4.0.

Requests are made against 5 base URLs: https://api.tetrascience.com, https://api.tetrascience-uat.com, https://api.tetrascience-dev.com, https://api.tetrascience-uat.com, api.tetrascience.com.

11 operations 11 paths 11 schemas 10 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.0
Base URL
https://api.tetrascience.com
Authentication
API Key, API Key, API Key
License
Proprietary
Resource Areas
1

Authentication & Security 3

TetraScience Protocols API declares 3 security schemes for authenticating requests. An API key is passed in the header as ts-auth-token (token). An API key is passed in the header as x-org-slug (orgSlug). An API key is passed in the header as ts-auth-token (tsAuthToken). By default, every request must be authenticated.

  • token — JWT Token for authentication
  • orgSlug — Your organization slug

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 10 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Protocols 11
GET
/v1/artifacts/ids/{namespace}/{slug}/{version}/files
Get available file slugs for IDS
getIdsArtifactFileSlugs 4 params → 200400404
GET
/v1/artifacts/protocols/{namespace}
List all protocols for namespace
getProtocolArtifactByNamespace 3 params → 200404
GET
/v1/artifacts/protocols/{namespace}/{slug}
List all protocols for namespace/slug
getProtocolArtifactByNamespaceAndSlug 4 params → 200404
GET
/v1/artifacts/protocols/{namespace}/{slug}/{version}/files/{fileSlug}
Get contents for a protocol file
getProtocolArtifactByNamespaceSlugAndFileSlug 6 params → 200400404
GET
/v1/artifacts/protocols/{namespace}/{slug}/{version}
Get single protocol
getProtocolArtifactByNamespaceSlugAndVersion 4 params → 200404
GET
/v1/artifacts/protocols/{namespace}/{slug}/{version}/files
Get available file slugs for protocol
getProtocolArtifactFileSlugs 4 params → 200400404
GET
/v1/artifacts/protocols/{namespace}/{slug}/{version}/labels
Get labels for a protocol
getProtocolArtifactLabels 4 params → 200404
GET
/v1/artifacts/protocols/{namespace}/{slug}/{version}/relationships
Get related artifacts
getProtocolArtifactRelationships 4 params → 200404
GET
/v1/artifacts/protocols
List all protocols
getProtocolArtifacts 3 params → 200
GET
/v1/artifacts/task-scripts/{namespace}/{slug}/{version}/files
Get available file slugs for task-script
getTaskScriptArtifactFileSlugs 4 params → 200400404
POST
/v1/artifacts/protocols/search
Search for items
searchProtocols 3 params → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ArtifactObjectBase (9 properties), Relationships (4 properties), Key (4 properties), SupportedPlatformVersion (2 properties). Each schema is shown below with its type and property counts.

Relationships
object
4 properties
LabelList
array
SupportedPlatformVersion
object
2 properties
IdsFileSlug
string
TaskScriptFileSlug
string
ArtifactNamespace
string
ArtifactObjectBase
object
9 properties 5 required
Key
object
4 properties 4 required
ProtocolFileSlug
string
ProtocolObjectList
array
ProtocolObject

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tetrascience-protocols-api-openapi.yml Raw ↑

Other APIs TetraScience publishes across the network.

TetraScience Access Groups API
TetraScience Agents API
TetraScience ai-workflows API
TetraScience Attributes API
TetraScience Audit Trail API
TetraScience clusters API
TetraScience Commands API
TetraScience Connectors API
TetraScience Data Acquisition API
TetraScience Data App Providers API
TetraScience Data Apps API
TetraScience databricks API