API Reference

Object Not Found Error

Get Analysis

Returns a list of Analyses you have access to.
Results are sorted, with the most recent appearing first.

Pagination Error

List Analyses

Analyses

Returns details for a specific Analysis Template.

Get Analysis Template

Returns a list of Analysis Templates you have access to.
Results are sorted, with the most recent appearing first.

List Analysis Templates

Creates an Analysis Template using the structure of an existing Analysis.
Analysis Templates can be used to create new Analyses that share the same structure.
All parameters for the Analysis are preserved.

Create Analysis Template

Analysis Templates

Get details for an Annotation.
Annotations are made on an Entity present in a Dataset.

Get Annotation

List Annotations you have access to.
Results are sorted, with the most recent appearing first.

List Annotations

Annotations

Get Campaign

Returns a list of Campaigns you have access to.
Results are sorted, with the most recent appearing first.

List Campaigns

Create a new Campaign.
Campaigns can be used to track related Analyses.
Campaigns can only be created in the API.

Create Campaign

Update Campaign

Campaigns

Register Dataset Schema

Get Dataset Schema

Returns a list of Dataset Schemas you have access to.
Results are sorted, with the most recent appearing first.

List Dataset Schemas

Dataset Schemas

Get Dataset

Returns a list of Datasets you have access to.
Results are sorted, with the most recent appearing first.

Filter the results by tags. Tags are case-sensitive.

Filter the results by name exactly. Name is case-sensitive.

List Datasets

Download Dataset

Non Csvfile Error

Invalid Staged File Error

Create Dataset

Datasets

Summary

Get Datatable

Download Datatable

Datatables

Get Entity

Returns a list of Entities you have access to.
Results are sorted, with the most recent appearing first.

List Entities

Create a custom Entity.
A custom Entiy can be used to define how a Campaign, Schema, and other data relate.
Entities are can be used across many Datasets and Datatables.

Create Custom Entity

Update Entity

Entities

Register Entity Schema

Return details for a specific Entity Schema.

Get Entity Schema

Returns a list of Entity Schemas you have access to.
Results are sorted, with the most recent appearing first.

List Entity Schemas

Entity Schemas

Return details for a File.
A File is stored whenever a user uploads a file in the UI or the API.

Get File

Returns a list of Files you have access to.
Results are sorted, with the most recent appearing first.

List Files

Download File

Create File

Files

Get Plot

Plot Does Not Have SVG Error

Download Plot

Returns a list of Plots you have access to.
Results are sorted, with the most recent appearing first.

List Plots

Plots

Storing Files

Creates a URL to upload a file to.
The upload location expires 60 minutes after recieving a response from this endpoint.

Get Presigned Url For Upload

Storage

Get Task

Tasks

Returns a list of Users in your Organization.
Results are sorted, with the most recent appearing first.

List Users

Get User

Users

Analysis

PaginatedAnalyses

AnalysisTemplate

CreateAnalysisTemplate

The ID of the analysis to use as a template.

PaginatedAnalysisTemplates

Annotation

PaginatedAnnotations

CreateCampaign

PaginatedCampaigns

UpdateCampaign

DatasetSchema

PaginatedDatasetSchemas

RegisterDatasetSchema

CreateDataset

Dataset

PaginatedDatasets

Datatable

CreateCustomEntity

PaginatedEntities

UpdateEntity

EntitySchema

EnvConfig

PaginatedEntitySchemas

RegisterEntitySchema

InvalidStagedFileBody

ObjectNotFoundBody

CreateFile

DownloadFileResponse

PaginatedFiles

CreatedFilterParams

DatetimeFilterEnum

UpdatedFilterParams

PaginatedResponse

PaginationToken

SortEnum

Greater than filter for createdAt timestamp. Format is ISO 8601.

created_gt

Less than filter for createdAt timestamp. Format is ISO 8601.

created_lt

Filter the results by creator id. To access a user's id, use the listUsers endpoint.

creator_id

The maximum number of results to return. Defaults to 50. Minimum is 1. Maximum is 100.

limit

nextToken

sort

Greater than filter for updatedAt timestamp. Format is ISO 8601.

updated_gt

Less than filter for updatedAt timestamp. Format is ISO 8601.

updated_lt

DownloadPlotResponse

PaginatedPlots

Plot

PlotDoesNotHaveSvgErrorBody

Campaign

CampaignId

CampaignSummary

Creator

DatasetBase

DatasetCreatorSummary

DatasetId

DatasetNodeSummary

DatasetRecordId

UploadableFileTypes

DatatableBase

AminoAcidSequence

AminoAcidStructure

CellLine

ChemicalMolecule

Control

CreateAminoAcidSequence

CreateAminoAcidStructure

CreateChemical

CreateControl

CreateEntitiesRequest

CreateEntity

CreateEntityBase

CreateRnaSequence

CustomEntity

DNASequence

Entity

EntityBase

EntityId

EntityTypesEnum

RNASequence

File

ComposableFilter

Filter

FilterJoinEnum

FilterOperatorEnum

LeafFilter

HitType

Outlier

OutlierId

BaseSharePermission

InviteUserByEmail

InviteUserObject

PermissionAccessScopeEnum

PermissionActionLevelEnum

Sort

CreateTag

DatetimeColumnEnum

SortableTypes

PresignedResponse

UploadUrlResponse

CreateDatasetTaskResult

DownloadDataTaskResult

FailedTaskResponse

InitialTaskResponse

ProcessingTaskResponse

SuccessTaskResponse

SuccessTaskResult

TaskId

TaskResponse

PaginatedUsers

User

SphinxBio | User Guide

1	curl -X POST https://api.sphinxbio.com/v1/files \
2	-H "Content-Type: application/json" \
3	-d '{
4	"name": "protein_structure.pdb",
5	"stagedUploadPath": "https://storage.example.com/upload/protein_structure.pdb"
6	}'

1	{
2	"id": "file_12345",
3	"name": "gene_sequence.txt",
4	"mimetype": "text/plain",
5	"creator": {
6	"id": "user_67890",
7	"email": "researcher@example.com"
8	},
9	"createdAt": "2023-01-01T12:00:00Z",
10	"updatedAt": "2023-01-02T12:00:00Z"
11	}