API reference¶

Generated from the service's own OpenAPI document. Nothing on this page is written by hand, which is the only way a reference and an implementation stay in agreement.

Every path on this page is relative to /v1 on https://api.auroraomics.org — so /api-keys is https://api.auroraomics.org/v1/api-keys. A breaking change gets a new prefix; within one prefix, changes are additive.

Not open yet

These endpoints are documented ahead of launch. The API host does not answer and keys are not being minted. See the home page.

Endpoints¶

Aurora Omics public API, OpenAPI 3.1.0, API version 1.0.0, mounted at /v1.

GET /¶

Service discovery

Status	Meaning	Body
`200`	Successful Response	`Discovery`

GET /api-keys¶

List my API keys

Status	Meaning	Body
`200`	Successful Response	array of `KeyRow`

POST /api-keys¶

Mint an API key

Request body: application/json — MintKeyBody

Status	Meaning	Body
`201`	Successful Response	`MintedKey`
`422`	Validation Error	`HTTPValidationError`

GET /api-keys/terms¶

The terms version a mint must accept

Status	Meaning	Body
`200`	Successful Response	`object`

DELETE /api-keys/{key_id}¶

Revoke one of my API keys

Parameter	In	Required	Type
`key_id`	path	yes	`integer`

Request body: application/json — RevokeBody or null

Status	Meaning	Body
`204`	Successful Response	—
`422`	Validation Error	`HTTPValidationError`

POST /auth/request-code¶

Request a sign-in code

Request body: application/json — RequestCodeBody

Status	Meaning	Body
`200`	Successful Response	`RequestCodeOut`
`422`	Validation Error	`HTTPValidationError`

POST /auth/verify-code¶

Exchange the code for a short-lived token

Request body: application/json — VerifyCodeBody

Status	Meaning	Body
`200`	Successful Response	`VerifyCodeOut`
`422`	Validation Error	`HTTPValidationError`

GET /genes¶

Search the gene set

Parameter	In	Required	Type
`q`	query	no	`string`
`limit`	query	no	`integer`

Status	Meaning	Body
`200`	Successful Response	`GeneSetOut`
`422`	Validation Error	`HTTPValidationError`

POST /genes/resolve¶

Resolve names to Ensembl ids

Request body: application/json — ResolveBody

Status	Meaning	Body
`200`	Successful Response	`ResolveOut`
`422`	Validation Error	`HTTPValidationError`

GET /jobs¶

List my jobs

Parameter	In	Required	Type
`limit`	query	no	`integer`
`cursor`	query	no	`string`

Status	Meaning	Body
`200`	Successful Response	`JobPage`
`422`	Validation Error	`HTTPValidationError`

DELETE /jobs/{job_id}¶

Purge a job

Parameter	In	Required	Type
`job_id`	path	yes	`string`

Status	Meaning	Body
`204`	Successful Response	—
`422`	Validation Error	`HTTPValidationError`

GET /jobs/{job_id}¶

Read one job

Parameter	In	Required	Type
`job_id`	path	yes	`string`

Status	Meaning	Body
`200`	Successful Response	`Job`
`422`	Validation Error	`HTTPValidationError`

POST /jobs/{job_id}/cancel¶

Cancel a job

Parameter	In	Required	Type
`job_id`	path	yes	`string`

Status	Meaning	Body
`200`	Successful Response	`Job`
`422`	Validation Error	`HTTPValidationError`

GET /jobs/{job_id}/result¶

Download the result

Parameter	In	Required	Type
`job_id`	path	yes	`string`

Status	Meaning	Body
`200`	Successful Response	`JobResult`
`422`	Validation Error	`HTTPValidationError`

POST /predictions¶

Submit a prediction

Parameter	In	Required	Type
`Idempotency-Key`	header	no	`string` or `null`

Request body: application/json — PredictionBody

Status	Meaning	Body
`202`	Successful Response	`Job`
`422`	Validation Error	`HTTPValidationError`

POST /uploads¶

Start an upload

Request body: application/json — UploadInitBody

Status	Meaning	Body
`201`	Successful Response	`UploadInit`
`422`	Validation Error	`HTTPValidationError`

POST /uploads/{upload_id}/complete¶

Finalise an upload and read its verdict

Parameter	In	Required	Type
`upload_id`	path	yes	`string`

Status	Meaning	Body
`200`	Successful Response	`UploadVerdict`
`422`	Validation Error	`HTTPValidationError`

Schemas¶

Discovery¶

Property	Type	Required
`api_version`	`string`	yes
`docs`	`string`	yes
`lanes`	array of `string`	yes
`llms_txt`	`string`	yes
`models`	`string`	yes
`openapi`	`string`	yes
`retention`	`object`	yes
`service`	`string`	yes

No other properties are accepted.

GeneOut¶

Property	Type	Required
`biotype`	`string` or `null`	yes
`ensembl_gene_id`	`string` or `null`	yes
`hgnc_id`	`string` or `null`	yes
`in_ensembl`	`boolean`	yes
`symbol`	`string`	yes

No other properties are accepted.

GeneSetOut¶

Property	Type	Required
`ensembl_release`	`integer`	yes
`fetch_date`	`string`	yes
`matches`	array of `GeneOut`	yes
`n_genes`	`integer`	yes

No other properties are accepted.

HTTPValidationError¶

Property	Type	Required
`detail`	array of `ValidationError`	no

Job¶

Property	Type	Required
`created_at`	`string`	yes
`error`	`object` or `null`	yes
`eta_seconds`	`integer` or `null`	yes
`events`	array of `JobEvent`	no
`expires_at`	`string` or `null`	yes
`finished_at`	`string` or `null`	yes
`id`	`string`	yes
`items`	`integer` or `null`	yes
`landed`	`boolean`	yes
`lane`	`string`	yes
`model`	`string`	yes
`observation`	`string`	yes
`queue_position`	`integer` or `null`	yes
`started_at`	`string` or `null`	yes
`state`	`string`	yes
`updated_at`	`string`	yes

No other properties are accepted.

JobEvent¶

Property	Type	Required
`at`	`string`	yes
`name`	`string`	yes
`seconds`	`number` or `null`	yes

No other properties are accepted.

JobPage¶

Property	Type	Required
`jobs`	array of `Job`	yes
`next_cursor`	`string` or `null`	yes

No other properties are accepted.

JobResult¶

Property	Type	Required
`expires_at`	`string` or `null`	yes
`format`	`string`	yes
`size_bytes`	`integer`	yes
`url`	`string`	yes

No other properties are accepted.

KeyRow¶

Property	Type	Required
`created_at`	`string`	yes
`expires_at`	`string`	yes
`id`	`integer`	yes
`last_used_at`	`string` or `null`	yes
`name`	`string`	yes
`prefix`	`string`	yes
`revoked_at`	`string` or `null`	yes
`scopes`	array of `string`	yes
`terms_version`	`string`	yes
`tier`	`string`	yes

No other properties are accepted.

MintKeyBody¶

Property	Type	Required
`accept_terms_version`	`string`	yes
`name`	`string`	no
`scopes`	array of `string`	no

No other properties are accepted.

MintedKey¶

Property	Type	Required
`created_at`	`string`	yes
`expires_at`	`string`	yes
`id`	`integer`	yes
`key`	`string`	yes
`name`	`string`	yes
`prefix`	`string`	yes
`scopes`	array of `string`	yes
`terms_version`	`string`	yes
`tier`	`string`	yes

No other properties are accepted.

PredictionBody¶

Property	Type	Required
`covariates`	`object`	no
`model`	`string`	yes
`observations`	`object`	yes
`options`	`PredictionOptions`	no

No other properties are accepted.

PredictionOptions¶

Property	Type	Required
`land_in_workspace`	`boolean`	no
`retain`	`boolean`	no

No other properties are accepted.

RequestCodeBody¶

Property	Type	Required
`email`	`string`	yes

RequestCodeOut¶

Property	Type	Required
`sent`	`boolean`	no

No other properties are accepted.

ResolveBody¶

Property	Type	Required
`genes`	array of `string`	yes

No other properties are accepted.

ResolveOut¶

Property	Type	Required
`genes`	array of `GeneOut`	yes

No other properties are accepted.

RevokeBody¶

Property	Type	Required
`reason`	`string`	no

No other properties are accepted.

UploadInit¶

Property	Type	Required
`chunk_size_bytes`	`integer`	yes
`expires_at`	`string`	yes
`upload_id`	`string`	yes
`url`	`string`	yes

No other properties are accepted.

UploadInitBody¶

Property	Type	Required
`filename`	`string`	yes
`kind`	`string`	yes
`sha256`	`string`	yes
`size_bytes`	`integer`	yes

No other properties are accepted.

UploadVerdict¶

Property	Type	Required
`completed_at`	`string` or `null`	yes
`kind`	`string`	yes
`size_bytes`	`integer`	yes
`status`	`string`	yes
`upload_id`	`string`	yes
`verdict`	`object`	yes

No other properties are accepted.

ValidationError¶

Property	Type	Required
`ctx`	`object`	no
`input`	any	no
`loc`	array of `string` or `integer`	yes
`msg`	`string`	yes
`type`	`string`	yes

VerifyCodeBody¶

Property	Type	Required
`code`	`string`	yes
`email`	`string`	yes

VerifyCodeOut¶

Property	Type	Required
`approved`	`boolean`	yes
`token`	`string`	yes

No other properties are accepted.