Skip to content

MAVE Targeton API: User Guide

This user guide covers the following topics regarding the Targeton API provided by the MAVE Platform:

  1. The purpose of the Targeton API: Explains what the API provides and why it exists.
  2. How the API works: Describes the four-step processing pipeline that resolves a single name into a harmonised response.
  3. How to use the Targeton API: Covers the endpoint, request parameters, response structure, and error codes.
  4. Example responses: Provides concrete response examples for Screen Pellet and HDR Vector inputs.

The purpose of this document is to give consumers an overview of the Targeton API and what it is designed to achieve. It describes the high-level orchestration logic but does not explore the detailed technical implementation of the underlying Benchling integrations. If you need more details, please contact the MAVE team.

Overview

The MAVE Targeton API provides a single interface for retrieving Targeton metadata and associated LibAmp primer sequences from Benchling.

The API abstracts multiple underlying Benchling endpoints and returns a harmonised response for downstream MAVE workflows and QC processes.

Consumers only need to provide a single name value. The API handles all downstream orchestration and data aggregation automatically.

Nomenclature

Before reading the rest of the documentation, it is useful to be familiar with the following terms.

  • Targeton: A Targeton is a genomic target entity recorded in Benchling. It is associated with LibAmp primer sequences and oligo library metadata used in MAVE screening workflows.
  • Screen Pellet: A Screen Pellet is a Benchling entity representing a physical pellet used in a MAVE screen. It is linked to a Targeton and carries replicate and pellet day metadata.
  • HDR Vector: An HDR Vector Lot is a Benchling entity representing a homology-directed repair vector. It is used as a fallback entity when no Screen Pellet exists for the supplied name.
  • LibAmp Primer: LibAmp primers are paired forward (LibAmp_F) and reverse (LibAmp_R) primer sequences associated with a Targeton, used for library amplification.
  • Targeton Oligo Library: A Benchling schema that links a Targeton to its consequences and Valiant output artefacts. When multiple versions exist, the API selects the record with the highest version number.
  • Benchling: Benchling is the scientific data management platform used by the MAVE team to store and manage experimental entities, sequences, and metadata.