Benchling Custom Entities API

openapi: 3.0.3
info:
  title: Benchling AA Sequences Custom Entities API
  description: 'Curated OpenAPI for the Benchling life-sciences R&D cloud (LIMS + ELN + registry + inventory + workflows). Benchling exposes a tenant-scoped REST API at https://{tenant}.benchling.com/api/v2 covering the same objects scientists work with in the UI: DNA/RNA/protein sequences, custom entities and the registry, sample inventory, notebook entries, assay results and runs, lab automation, workflow tasks, requests, plus an events stream and Benchling Apps/webhooks.


    Every path and method in this document is grounded in Benchling''s own published OpenAPI specification (benchling.com/api/v2/openapi.yaml). This is a curated, representative subset of the full ~325-path Benchling spec - the core CRUD, bulk, and action endpoints per resource - not the exhaustive spec. For the authoritative, complete, always-current definition, fetch Benchling''s published spec.


    Authentication: personal user API keys use HTTP Basic (Authorization: Basic {api_key}); Benchling Apps use OAuth2 client credentials (POST /api/v2/token -> Bearer {access_token}). OIDC is available to act as a specific user with their permissions. Note the {tenant} placeholder in the server URL must be replaced with your Benchling tenant subdomain.'
  version: 2.0.0
  contact:
    name: Benchling Developer Platform
    url: https://docs.benchling.com/docs/developer-platform-overview
  termsOfService: https://www.benchling.com/terms
servers:
- url: https://{tenant}.benchling.com/api/v2
  description: Tenant-scoped Benchling API. Replace {tenant} with your subdomain.
  variables:
    tenant:
      default: your-tenant
      description: Your Benchling tenant subdomain (e.g. acme for acme.benchling.com).
security:
- basicAuth: []
- appBearerAuth: []
tags:
- name: Custom Entities
  description: Schema-driven custom entities registered in Benchling.
paths:
  /custom-entities:
    get:
      operationId: listCustomEntities
      tags:
      - Custom Entities
      summary: List custom entities
      parameters:
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/NextToken'
      responses:
        '200':
          description: A list of custom entities.
    post:
      operationId: createCustomEntity
      tags:
      - Custom Entities
      summary: Create a custom entity
      responses:
        '201':
          description: The created custom entity.
  /custom-entities/{custom_entity_id}:
    get:
      operationId: getCustomEntity
      tags:
      - Custom Entities
      summary: Get a custom entity
      parameters:
      - name: custom_entity_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A custom entity.
    patch:
      operationId: updateCustomEntity
      tags:
      - Custom Entities
      summary: Update a custom entity
      parameters:
      - name: custom_entity_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The updated custom entity.
  /custom-entities:bulk-create:
    post:
      operationId: bulkCreateCustomEntities
      tags:
      - Custom Entities
      summary: Bulk-create custom entities
      responses:
        '202':
          description: A bulk-create task was started.
  /custom-entities:bulk-upsert:
    post:
      operationId: bulkUpsertCustomEntities
      tags:
      - Custom Entities
      summary: Bulk-upsert custom entities by registry ID
      responses:
        '202':
          description: A bulk-upsert task was started.
components:
  parameters:
    NextToken:
      name: nextToken
      in: query
      required: false
      schema:
        type: string
      description: Pagination token from a previous response.
    PageSize:
      name: pageSize
      in: query
      required: false
      schema:
        type: integer
        default: 50
        maximum: 100
      description: Number of results per page.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'Personal user API key sent as HTTP Basic auth (Authorization: Basic {api_key}). Generate a key on your Benchling user settings page.'
    appBearerAuth:
      type: oauth2
      description: Benchling Apps authenticate with OAuth2 client credentials. Exchange client_id/client_secret at POST /api/v2/token for a Bearer access_token.
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.benchling.com/api/v2/token
          scopes: {}