---
title: "Update a map from a sequencing consensus"
method: POST
path: "/map_update_from_consensus"
tags: ["Files & formats"]
---

# Update a map from a sequencing consensus

`POST /map_update_from_consensus`

## Request

- Base URL: `https://seqbench.com/api/v1`
- URL: `https://seqbench.com/api/v1/map_update_from_consensus`
- Auth: none required

Write the differences a whole-plasmid sequencing consensus shows into the map, keeping the map's annotation: every feature is shifted, grown or shrunk with the edit, a feature whose boundary an edit cuts is trimmed (and named), and differences in a known nanopore error context (Dam/Dcm methylation sites, long homopolymers) are left out unless keepArtifacts is set. Returns the updated map as a GenBank record and as SnapGene .dna bytes (base64), plus a change log. Use it when the clone is what you want and the MAP is out of date — a change every clone carries, a redesigned primer, a different allele — not to absorb one clone's mutation. `positions` limits the update to those design positions (e.g. only the changes shared by every clone).

## Request body

- object
  - `design` string, required: The map to update: your annotated GenBank record (what keeps the features), FASTA or bare bases.
  - `consensus` string, required: The assembled consensus from the sequencing service, raw or FASTA. One record.
  - `circular` boolean: Treat both as circular (right for a plasmid).
  - `keepArtifacts` boolean: Also write differences that sit in a known nanopore error context. Off by default: those are usually read-out artifacts, and writing one into the map makes it wrong.
  - `positions` integer[]: Write only the differences at these design positions (1-based). Omitted: every difference.

## Response `200`

Tool ran successfully.

- SuccessResponse: Standard success envelope returned by every single-tool call.
  - `ok` unknown, required
  - `tool` string, required: The tool slug that ran.
  - `result` object, required: Tool-specific output object. Its shape depends on the tool — call `GET /{tool}` or see the docs for each tool's fields.
  - `gate` GateResult
    - `pass` boolean, required: True if and only if every hard check passed.
    - `checks` GateCheck[], required
      - `id` string, required
      - `label` string, required
      - `severity` 'hard' | 'soft', required
      - `pass` boolean, required
      - `message` string, required
      - `value` number
      - `threshold` string
    - `notChecked` string[], required: Honest list of what this gate does NOT verify.
  - `provenance` Provenance, required
    - `apiVersion` string, required
    - `tool` union, required: Tool slug, or an array of slugs (one per step) for a workflow.
      - string
      - string[]
    - `generatedAt` string, date-time, required: ISO 8601 timestamp of when the result was generated.

## Other responses

- `400`: Invalid argument or the tool could not run.
- `404`: Unknown tool.
- `429`: Rate limited (metered tools only). Body carries code `rate_limited` and retryable `true`; honor the Retry-After header.
- `503`: A metered tool is momentarily at capacity. The identical request should succeed after Retry-After; body carries code `upstream_unavailable`.

---

[API](https://skmtc.dev/seqbench/apis/seqbench-api.md) · [All operations](https://skmtc.dev/seqbench/apis/seqbench-api/llms.txt) · [OpenAPI document](https://skmtc.dev/seqbench/apis/seqbench-api/revisions/132575216865?raw)