Skip to main content
POST
/
codon-exports
/
batch
Submit Codon Export Batch
curl --request POST \
  --url https://api.example.com/codon-exports/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "strategy": "<string>",
  "output_formats": [],
  "items": [
    {
      "variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "signal_peptides": {}
    }
  ],
  "options": {}
}
'
{
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "job_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "export_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create a batch of codon-export jobs (one job per variant).

​
strategy
string
required
​
host
enum<string>
required
Available options:
cho,
hek293,
ecoli,
pichia
​
output_formats
enum<string>[]
required
Minimum array length: 1
Available options:
fasta,
genbank,
csv
​
items
CodonExportItem · object[]
required
Minimum array length: 1
​
options
Options · object

Response

Successful Response

Response from POST /codon-exports/batch.

​
batch_id
string<uuid>
required
​
job_ids
string<uuid>[]
required
​
export_ids
string<uuid>[]
required