> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kallima.bio/llms.txt
> Use this file to discover all available pages before exploring further.

# Submit a codon export batch

> Submit one codon export job per variant in the batch.

Returns ``202 Accepted`` immediately. Poll ``GET /v1/codon-exports/{id}``
until ``variable_cds`` is populated.

Ownership: every ``variant_id`` in ``items`` must belong to the caller's
org; the first cross-org id returns ``404`` before any rows are inserted.

**Plan gate.** Requires Structure plan or above; free-plan callers
receive ``402``.

**Credits.** Each variant costs 1 codon-optimization credit. The total
is debited atomically — if any variant would exceed the balance the
whole batch is rejected with ``402``.

**Idempotency.** Send a unique ``Idempotency-Key`` per submission;
replays return the cached 202 without enqueuing a second batch.

Cost: **write** — burns rate + quota, and debits credits.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/codon-exports/batches
openapi: 3.1.0
info:
  title: Kallima API
  description: >-
    Antibody design API — humanization, structure, stability, immunogenicity,
    complex prediction, and codon optimization.
  version: 0.1.0
servers: []
security: []
tags:
  - name: identity
    description: >-
      Caller identity and credit balance — use ``GET /v1/me`` to inspect the
      resolved org, plan, and compute budget before submitting jobs.
  - name: projects
    description: >-
      Projects — top-level containers for source antibodies and therapeutic
      candidates.
  - name: source-antibodies
    description: Source (parental) antibody sequences registered under a project.
  - name: variants
    description: >-
      Variants descended from a therapeutic candidate — the unit of work for
      pipelines.
  - name: jobs
    description: >-
      Long-running pipeline jobs: humanization, structure, stability,
      immunogenicity. Submit and poll. Deprecated in favor of
      resource-per-job-type endpoints (``humanizations`` and the other Phase 3
      resources); scheduled for removal in ``/v2``.
  - name: humanizations
    description: >-
      Humanization pipeline runs — typed submit body and typed per-strategy
      results. First of the Phase 3 resource-per-job-type endpoints; the generic
      ``/v1/jobs`` shape is deprecated in favor of this.
  - name: structure-predictions
    description: >-
      ImmuneBuilder structure predictions — typed submit body and typed PDB /
      pLDDT / CDR results. Phase 3 resource-per-job-type endpoint.
  - name: stability-analyses
    description: >-
      Stability analyses — typed submit body and typed thermostability /
      aggregation / developability scorecard. Phase 3 resource-per-job-type
      endpoint.
  - name: immunogenicity-analyses
    description: >-
      Immunogenicity analyses — typed submit body and typed MHC-I / MHC-II /
      B-cell epitope + risk-score results. Phase 3 resource-per-job-type
      endpoint.
  - name: uploads
    description: >-
      Presigned Supabase Storage slots for caller-supplied files (e.g. antigen
      PDBs for complex prediction). The API never proxies bytes — clients PUT
      directly to the returned URL.
  - name: antigens
    description: >-
      Target protein sequences scoped to a project — the docking partner in a
      complex prediction. Register once, reference by ``antigen_id`` at submit
      time.
  - name: complex-predictions
    description: >-
      Boltz-2 antibody-antigen complex predictions — typed submit body and typed
      docked-PDB / iptm / interface-residues results. Phase 3
      resource-per-job-type endpoint. Complex runs are long-running (~20–40 min
      on GPU); always poll, never hold the connection.
  - name: therapeutic-candidates
    description: >-
      Therapeutic candidates — the top-of-lineage object under a project.
      Creating one auto-creates a baseline variant (``v1``) and its chain rows
      atomically; pipelines submit against the variant. Junction endpoints
      manage many-to-many links to source antibodies and antigens.
  - name: adc-designs
    description: >-
      ADC (antibody-drug conjugate) designs — catalog records attaching a linker
      + payload + conjugation method to a therapeutic candidate. Run the
      rule-based developability analysis via ``POST
      /v1/adc-designs/{id}/analysis``; pass ``structure_job_id`` to include
      SASA-based conjugation-site accessibility.
  - name: codon-exports
    description: >-
      Codon optimization exports — submit a batch of jobs (one per variant),
      poll until ``variable_cds`` is populated, then download the assembled CDS
      as FASTA, CSV, or GenBank+ZIP. Requires the Structure plan or above.
  - name: webhooks
    description: >-
      Webhook endpoint registration — register HTTPS URLs to receive signed
      event deliveries when jobs complete or fail. Signing uses HMAC-SHA256; see
      ``POST /v1/webhooks`` for verification details.
  - name: webhook-deliveries
    description: >-
      Webhook delivery log — inspect past delivery attempts and manually retry
      failed ones via ``POST /v1/webhook_deliveries/{id}/retry``.
paths:
  /v1/codon-exports/batches:
    post:
      tags:
        - codon-exports
      summary: Submit a codon export batch
      description: >-
        Submit one codon export job per variant in the batch.


        Returns ``202 Accepted`` immediately. Poll ``GET
        /v1/codon-exports/{id}``

        until ``variable_cds`` is populated.


        Ownership: every ``variant_id`` in ``items`` must belong to the caller's

        org; the first cross-org id returns ``404`` before any rows are
        inserted.


        **Plan gate.** Requires Structure plan or above; free-plan callers

        receive ``402``.


        **Credits.** Each variant costs 1 codon-optimization credit. The total

        is debited atomically — if any variant would exceed the balance the

        whole batch is rejected with ``402``.


        **Idempotency.** Send a unique ``Idempotency-Key`` per submission;

        replays return the cached 202 without enqueuing a second batch.


        Cost: **write** — burns rate + quota, and debits credits.
      operationId: submit_batch_v1_codon_exports_batches_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CodonExportBatchSubmit'
        required: true
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodonExportBatchCreatedV1'
        '400':
          description: Malformed request body or parameter.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Missing or invalid API token.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '402':
          description: >-
            Payment required — insufficient credits or the caller's plan is
            below the required tier.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Resource does not exist in the caller's organization.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: Request failed validation.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: >-
            Rate limit or monthly write quota exceeded. `Retry-After` holds the
            number of seconds until the next admitted request.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          headers:
            Retry-After:
              description: Seconds until the caller may retry. Present on 429 responses.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Limit:
              description: Per-minute rate ceiling for this API token's plan.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests remaining in the current rate window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: HTTP-date when the rate window resets.
              schema:
                type: string
                format: http-date
            X-Quota-Limit:
              description: Monthly write ceiling for this API token's plan.
              schema:
                type: integer
            X-Quota-Remaining:
              description: Writes remaining in the current monthly window.
              schema:
                type: integer
            X-Quota-Reset:
              description: >-
                HTTP-date when the monthly write quota resets (always the 1st of
                next month UTC).
              schema:
                type: string
                format: http-date
      security:
        - HTTPBearer: []
components:
  schemas:
    CodonExportBatchSubmit:
      properties:
        strategy:
          type: string
          title: Strategy
          description: >-
            Codon optimization strategy. See ``GET
            /v1/codon-exports/strategies`` for the list of registered strategy
            names.
          examples:
            - cai_max
        host:
          type: string
          enum:
            - cho
            - hek293
            - ecoli
            - pichia
          title: Host
          description: Target expression host. Drives codon table selection.
          examples:
            - cho
        output_formats:
          items:
            type: string
            enum:
              - fasta
              - genbank
              - csv
          type: array
          minItems: 1
          title: Output Formats
          description: >-
            Formats to make available for download (``fasta``, ``csv``,
            ``genbank``).
          examples:
            - - fasta
              - csv
        options:
          additionalProperties: true
          type: object
          title: Options
          description: >-
            Strategy-specific options (see ``option_schema`` in the strategy
            catalogue).
        items:
          items:
            $ref: '#/components/schemas/CodonExportItemBody'
          type: array
          minItems: 1
          title: Items
          description: One entry per variant to export.
      type: object
      required:
        - strategy
        - host
        - output_formats
        - items
      title: CodonExportBatchSubmit
      description: Body for ``POST /v1/codon-exports/batches``.
      example:
        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
    CodonExportBatchCreatedV1:
      properties:
        object:
          type: string
          const: codon_export_batch
          title: Object
          description: Polymorphic discriminator. Always ``codon_export_batch``.
          default: codon_export_batch
        batch_id:
          type: string
          title: Batch Id
          description: Opaque batch identifier (UUID).
        job_ids:
          items:
            type: string
          type: array
          title: Job Ids
          description: One job UUID per submitted variant.
        export_ids:
          items:
            type: string
          type: array
          title: Export Ids
          description: One export UUID per submitted variant.
      type: object
      required:
        - batch_id
        - job_ids
        - export_ids
      title: CodonExportBatchCreatedV1
      description: Response from ``POST /v1/codon-exports/batches``.
    ProblemDetails:
      additionalProperties: true
      description: RFC 9457 problem+json body returned by every non-2xx response.
      example:
        code: insufficient_credits
        credit_balance: 0
        credit_cost: 1
        detail: Humanization costs 1 credit; balance is 0.
        instance: /v1/jobs
        request_id: req_01JBX6Y6ZK6N8Q7YJ0F5VX2C3D
        status: 402
        title: Insufficient credits
        type: https://docs.kallima.bio/errors/insufficient_credits
      properties:
        type:
          description: >-
            Stable URI identifying the error class. Dereferenceable at
            docs.kallima.bio/errors/{code}.
          examples:
            - https://docs.kallima.bio/errors/insufficient_credits
          title: Type
          type: string
        title:
          description: Short human-readable summary of the error class.
          examples:
            - Insufficient credits
          title: Title
          type: string
        status:
          description: HTTP status code. Matches the response status line.
          examples:
            - 402
          title: Status
          type: integer
        detail:
          description: Human-readable explanation with values substituted.
          examples:
            - Humanization costs 1 credit; balance is 0.
          title: Detail
          type: string
        instance:
          description: The specific request URI that failed.
          examples:
            - /v1/jobs
          title: Instance
          type: string
        code:
          description: >-
            Machine-readable short code. SDKs switch on this, not on `title`.
            See app.errors.ErrorCode for the full taxonomy.
          examples:
            - insufficient_credits
          title: Code
          type: string
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: ULID stamped on every request. Include when contacting support.
          examples:
            - req_01JBX6Y6ZK6N8Q7YJ0F5VX2C3D
          title: Request Id
      required:
        - type
        - title
        - status
        - detail
        - instance
        - code
      title: ProblemDetails
      type: object
    CodonExportItemBody:
      properties:
        variant_id:
          type: string
          title: Variant Id
          description: >-
            Variant to export. Must belong to the caller's org; cross-org ids
            return ``404``.
          examples:
            - 11112222-3333-4444-5555-666677778888
        signal_peptides:
          additionalProperties:
            type: string
          type: object
          title: Signal Peptides
          description: >-
            Override the default signal peptide per chain role (``H``, ``L``,
            ``VHH``, …). Missing keys get auto-by-role defaults.
      type: object
      required:
        - variant_id
      title: CodonExportItemBody
      description: Per-variant configuration inside a batch submit body.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````