Skip to main content
POST
/
v1
/
codon-exports
/
batches
Submit a codon export batch
curl --request POST \
  --url https://api.example.com/v1/codon-exports/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "host": "cho",
  "items": [
    {
      "signal_peptides": {
        "H": "aaaabbbb-cccc-dddd-eeee-ffffaaaabbbb"
      },
      "variant_id": "11112222-3333-4444-5555-666677778888"
    }
  ],
  "output_formats": [
    "fasta",
    "csv"
  ],
  "strategy": "cai_max"
}
'
{
  "batch_id": "<string>",
  "job_ids": [
    "<string>"
  ],
  "export_ids": [
    "<string>"
  ],
  "object": "codon_export_batch"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Body for POST /v1/codon-exports/batches.

​
strategy
string
required

Codon optimization strategy. See GET /v1/codon-exports/strategies for the list of registered strategy names.

Example:

"cai_max"

​
host
enum<string>
required

Target expression host. Drives codon table selection.

Available options:
cho,
hek293,
ecoli,
pichia
Example:

"cho"

​
output_formats
enum<string>[]
required

Formats to make available for download (fasta, csv, genbank).

Minimum array length: 1
Available options:
fasta,
genbank,
csv
Example:
["fasta", "csv"]
​
items
CodonExportItemBody · object[]
required

One entry per variant to export.

Minimum array length: 1
​
options
Options · object

Strategy-specific options (see option_schema in the strategy catalogue).

Response

Successful Response

Response from POST /v1/codon-exports/batches.

​
batch_id
string
required

Opaque batch identifier (UUID).

​
job_ids
string[]
required

One job UUID per submitted variant.

​
export_ids
string[]
required

One export UUID per submitted variant.

​
object
string
default:codon_export_batch

Polymorphic discriminator. Always codon_export_batch.

Allowed value: "codon_export_batch"