Skip to content

How to Use the Targeton API

You can find the full Targeton API Reference here.

Endpoint

GET /targeton

Request

Query Parameters

Parameter Type Required Description
name string Yes Benchling entity name (Screen Pellet or HDR Vector Lot)

Example Requests

GET /targeton?name=GREB_A_4_pel370

GET /targeton?name=IVAR_hdr086

Response Structure

Field Description
library_type screen or plasmid
supplier_name Benchling Targeton API identifier
targeton_text_value Human-readable Targeton name
targeton_api_id Benchling Targeton API identifier
replicate Replicate value for Screen Pellet records; null for HDR Vector
pellet_day Pellet day value for Screen Pellet records; null for HDR Vector
consequences_link Targeton consequences output link; null if not configured
valiant_output_link Valiant output link; null if not configured
LibAmp_F Forward primer sequence
LibAmp_R Reverse primer sequence

Error Responses

Validation Error

Returned when the required name parameter is missing.

HTTP Status: 400 Bad Request

{
  "error": "VALIDATION_ERROR",
  "message": "name is required"
}

Entity Not Found

Returned when neither a Screen Pellet nor an HDR Vector Lot exists for the supplied name.

HTTP Status: 404 Not Found

{
  "error": "NOT_FOUND",
  "message": "No matching entity found"
}

Benchling Failure

Returned when a downstream Benchling request fails or times out.

HTTP Status: 503 Service Unavailable

{
  "error": "DOWNSTREAM_FAILURE",
  "message": "Failed to retrieve data from Benchling"
}

Authentication

Both APIs use the same credentials. See Authentication & Access for the full OAuth 2.0 client credentials flow.

Notes

  • The API automatically selects the latest available Targeton Oligo Library version.
  • Primer records may be partially populated if only one primer sequence exists for the Targeton.
  • consequences_link and valiant_output_link may be null if not configured in Benchling.
  • Responses include correlation identifiers in headers for observability and tracing.

Example Python Usage

import requests

response = requests.get(
    "https://api.example.com/targeton",
    params={"name": "GREB_A_4_pel370"}
)

print(response.json())

Support

For any of the following:

  • Missing Targeton records
  • Incorrect primer mappings
  • Benchling data inconsistencies
  • Downstream failures

please contact the MAVE team.