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

# Add labels to a test

> Requires the **Flag tests** permission.

Applies each named label to the test by hand. A name with no label in the organization creates the label, colored `#6366F1` with no description; an admin can change both in the web app's organization settings. A label already applied by hand is left as it is. A label a monitor applies gets a `user` source beside the monitor's.

Answers the test's labels after the change, in the shape of `Test.labels`, read in the same transaction as the write.

A label changes no status, so this sends no webhook and does not reconcile the test.

The `labels` filter of `GET /v2/tests` reads a copy of the assignments that lags by a minute or two, so a test can be missing from (or still in) a label's results that long after this answers. The labels on each test, here and on every read, are current.

The change is recorded as made by the person whose token made the call. An API token is recorded as no one: its source reads `user: null`.

`Idempotency-Key` is not honored. The change is idempotent by state, so a request whose outcome is unknown (a `504` or a dropped connection) is safe to send again.

A test in another organization is reported as `404`, not `403`.



## OpenAPI

````yaml /openapi-v2.json post /v2/tests/{testId}/add-labels
openapi: 3.1.0
info:
  title: Trunk API
  version: 2.0.0
  description: >-
    The Trunk public API. Every endpoint is scoped to a single organization and
    requires a credential.


    ## Authentication


    For automation, send an API key as `Authorization: Bearer <key>`. An
    organization admin creates one in the Trunk app under **Settings → Developer
    → API Keys**, and chooses the permissions it holds. A key with no
    permissions can read merge queues but change nothing in them. Each write's
    description names the permission it needs, if any. Permissions cover merge
    queues and test-result uploads, including the quarantine lookups a CI run
    makes before it uploads; any key can call the other Flaky Tests and Dynamic
    CI endpoints, including their writes.


    A short-lived token in the `x-trunk-token` header is what Trunk's own tools
    send, such as the `trunk` CLI after `trunk auth login`. Your own
    integrations should use an API key.


    A GitHub Actions job can upload impacted targets with no Trunk secret: the
    `trunk-io/login` action exchanges the run's own GitHub credential (its OIDC
    token, or on a pull request from a fork its `GITHUB_TOKEN`) for a
    short-lived first-party token. That token is accepted only by `PUT
    /v2/impacted-targets`, for the run's own repository — and on a fork pull
    request, only for that pull request and its head sha.


    ## Errors


    Errors from the API are an `ErrorResponse`: `{ "error": { "code", "message"
    } }`. Switch on `code`, which is stable; `message` is prose and may change
    at any time.


    Some responses don't have this shape. Trunk's edge answers `401`, `403` for
    some credential problems (including a request with no credential), `429`,
    and gateway errors such as `503` before the request reaches the API. The API
    itself answers `413` for a body over 512 KB and `504` for a request that
    runs past its time limit (usually 5 seconds), both as plain text. Read
    `error.code` only when the body is JSON with an `error` object, and
    otherwise branch on the status code.


    **An authorization denial on a read is reported as `404`, not `403`** —
    whether a resource exists must not leak across organizations, so a resource
    in another organization is indistinguishable from one that does not exist.
    `403 INSUFFICIENT_PERMISSIONS` means the credential is valid but is not
    permitted the action (or carries no organization).


    Every response from the API carries an `X-Request-Id` header; edge responses
    may not. Quote it in support requests.


    ## Rate limiting


    Most requests share one limit per organization (currently 100 requests per
    second), across every API key, user, and CLI session in it. Some requests
    have limits of their own and don't count toward it: `GET` requests on paths
    that start with `/v2/pull-requests`, `/v2/ci-jobs`, `/v2/ci-workflow-runs`,
    or `/v2/ci-failure-clusters` (5 per second per API key or user); the merge
    queue metrics endpoints (5 per second per organization); impacted-target
    uploads from a GitHub Actions login (10 per second per repository, and
    separately for its fork pull requests); test-result uploads (1000 per second
    per organization) and quarantine lookups (250 per second per organization).
    Exceeding a limit returns `429`; retry with backoff. The limit is enforced
    at the edge, which does not yet wrap its `429` in the `ErrorResponse`
    envelope or send `Retry-After`, so treat any `429` as rate limiting
    regardless of body.


    ## Compatibility


    Within v2, Trunk may add: new endpoints, new **optional** response fields,
    new members to any enum (including new `code` values, new queue-entry
    states, and new providers), and new optional request parameters. **Clients
    must tolerate values and fields they do not recognize** rather than failing
    closed — a client that switches exhaustively over an enum will break when a
    member is added. Removals and semantic changes require a new major version.


    ## Provider support


    Merge queues, verification runs and checks are **GitHub-only** today;
    `Check.provider` has a single member for that reason. `PUT
    /v2/impacted-targets` accepts GitHub and GitLab repositories. A GitHub
    Actions login (the `trunk-io/login` action, or `trunk auth login
    --github-actions`) uploads only for its own GitHub repository. The
    `Provider` enum lists values the repository index can store, not surfaces
    that are fully supported.


    ## Not yet available


    A pull request's numeric **position** in its queue is not exposed, and list
    responses are not ordered by queue position. `GET
    /v2/merge-queues/{id}/order` returns the order the engine will consider pull
    requests in, but an array index there is not a wait: use a pending entry's
    `directlyAhead` rather than counting, and `GET
    /v2/pull-requests/{id}/queue-entry-estimate` for when it is expected to
    merge (on queues that serve estimates). This API delivers no events of its
    own — poll it, or subscribe to [Merge Queue's
    webhooks](https://docs.trunk.io/merge-queue/webhooks). `Idempotency-Key` is
    not yet honored, so a mutation that times out must be reconciled by reading
    the resource back rather than blindly retried.
  contact:
    name: Trunk Support
    url: https://docs.trunk.io
servers:
  - url: https://api.trunk.io
    description: Production
security:
  - apiKey: []
  - trunkToken: []
tags:
  - name: mergeQueues
    x-group: Merge Queues
  - name: pullRequests
    x-group: Pull Requests
  - name: mergeQueueVerificationRuns
    x-group: Verification Runs
  - name: impactedTargets
    x-group: Impacted Targets
  - name: repositories
    x-group: Repositories
  - name: dynamicCi
    x-group: Dynamic CI
  - name: ciJobs
    x-group: CI Jobs
  - name: ciWorkflowRuns
    x-group: CI Workflow Runs
  - name: ciFailureClusters
    x-group: CI Failure Clusters
  - name: testCollections
    x-group: Test Collections
  - name: tests
    x-group: Tests
  - name: testUploads
    x-group: Test Uploads
  - name: detectionEvents
    x-group: Detection Events
  - name: monitors
    x-group: Monitors
  - name: monitorTests
    x-group: Monitor Tests
paths:
  /v2/tests/{testId}/add-labels:
    post:
      tags:
        - tests
      summary: Add labels to a test
      description: >-
        Requires the **Flag tests** permission.


        Applies each named label to the test by hand. A name with no label in
        the organization creates the label, colored `#6366F1` with no
        description; an admin can change both in the web app's organization
        settings. A label already applied by hand is left as it is. A label a
        monitor applies gets a `user` source beside the monitor's.


        Answers the test's labels after the change, in the shape of
        `Test.labels`, read in the same transaction as the write.


        A label changes no status, so this sends no webhook and does not
        reconcile the test.


        The `labels` filter of `GET /v2/tests` reads a copy of the assignments
        that lags by a minute or two, so a test can be missing from (or still
        in) a label's results that long after this answers. The labels on each
        test, here and on every read, are current.


        The change is recorded as made by the person whose token made the call.
        An API token is recorded as no one: its source reads `user: null`.


        `Idempotency-Key` is not honored. The change is idempotent by state, so
        a request whose outcome is unknown (a `504` or a dropped connection) is
        safe to send again.


        A test in another organization is reported as `404`, not `403`.
      operationId: tests.addLabels
      parameters:
        - schema:
            type: string
            minLength: 1
            description: The test's globally unique id.
            example: bfeebcf4-0000-8000-8000-000000000001
          required: true
          description: The test's globally unique id.
          name: testId
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestLabelsRequest'
      responses:
        '200':
          description: The test's labels after the change
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestLabels'
        '400':
          description: '`VALIDATION_FAILED`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                VALIDATION_FAILED:
                  summary: VALIDATION_FAILED
                  value:
                    error:
                      code: VALIDATION_FAILED
                      message: 'Invalid input: expected string, received undefined'
        '401':
          description: >-
            `AUTHENTICATION_REQUIRED` | `INVALID_TOKEN`. A malformed, expired,
            or deleted credential. Trunk's edge usually answers this before the
            request reaches the API, with a body that is not this envelope
            (`{"error": "unauthorized: invalid api key"}` for a bad API key, or
            plain text for a bad `x-trunk-token`), so branch on the status. A
            request with no credential at all gets `403` from the edge.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AUTHENTICATION_REQUIRED:
                  summary: AUTHENTICATION_REQUIRED
                  value:
                    error:
                      code: AUTHENTICATION_REQUIRED
                      message: No credential was supplied
                INVALID_TOKEN:
                  summary: INVALID_TOKEN
                  value:
                    error:
                      code: INVALID_TOKEN
                      message: The supplied token failed verification
        '403':
          description: '`INSUFFICIENT_PERMISSIONS`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INSUFFICIENT_PERMISSIONS:
                  summary: INSUFFICIENT_PERMISSIONS
                  value:
                    error:
                      code: INSUFFICIENT_PERMISSIONS
                      message: >-
                        The supplied credential is missing the required
                        permission
        '404':
          description: '`TEST_NOT_FOUND`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                TEST_NOT_FOUND:
                  summary: TEST_NOT_FOUND
                  value:
                    error:
                      code: TEST_NOT_FOUND
                      message: Test not found
        '429':
          description: >-
            `RATE_LIMIT_EXCEEDED`. Trunk's edge answers this, and does not yet
            wrap it in the error envelope or send `Retry-After`: treat any `429`
            as rate limiting, whatever its body, and retry with backoff.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                RATE_LIMIT_EXCEEDED:
                  summary: RATE_LIMIT_EXCEEDED
                  value:
                    error:
                      code: RATE_LIMIT_EXCEEDED
                      message: Rate limit exceeded; retry with backoff
        '500':
          description: '`INTERNAL_ERROR`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INTERNAL_ERROR:
                  summary: INTERNAL_ERROR
                  value:
                    error:
                      code: INTERNAL_ERROR
                      message: An unexpected error occurred
components:
  schemas:
    TestLabelsRequest:
      type: object
      properties:
        labels:
          type: array
          items:
            type: string
            pattern: ^[a-zA-Z0-9_ -]{1,64}$
            example: needs-triage
          minItems: 1
          maxItems: 50
          description: >-
            Label names, at most 50. A name listed twice counts once. Names
            match exactly, case included.
      required:
        - labels
      additionalProperties: false
      description: The labels to add to a test, or to remove from it, by name.
    TestLabels:
      type: object
      properties:
        labels:
          type: array
          items:
            $ref: '#/components/schemas/Label'
          maxItems: 100
      required:
        - labels
      description: A test's labels, folded across their sources as on `Test.labels`.
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              $ref: '#/components/schemas/ErrorCode'
            message:
              type: string
              description: >-
                Human-readable description of what went wrong. Not stable — do
                not parse.
              example: An unexpected error occurred
          required:
            - code
            - message
      required:
        - error
      description: >-
        The error envelope. Every error this API itself returns has this shape,
        except a `413` for a body over 512 KB and a `504` for a request that
        runs past its time limit, which are plain text. Responses from Trunk's
        edge, such as a `401`, a `403` for a missing credential, a `429` or a
        `503`, can arrive before the request reaches the API and may not have
        it, so read `error.code` only when the body is JSON with an `error`
        object.
    Label:
      type: object
      properties:
        id:
          type: string
          example: 2b3c4d5e-6f70-4a1b-8c9d-0e1f2a3b4c5d
        name:
          type: string
          example: slow-on-prs
        description:
          type: string
          example: Tests that only get slow on pull-request runs.
        color:
          type: string
          description: >-
            The label's hex color, as the web app shows it. A label created by
            `POST /v2/tests/{testId}/add-labels` starts as `#6366F1`.
          example: '#6366F1'
        assignedAt:
          type: string
          format: date-time
          description: >-
            The earliest of `sources[].assignedAt`. Exact when a user applied
            the label; see `MonitorLabelSource.assignedAt` for when a monitor
            did.
          example: '2026-05-01T00:00:00.000Z'
        sources:
          type: array
          items:
            $ref: '#/components/schemas/LabelSource'
          maxItems: 100
          description: >-
            Everything that put this label on the test. More than one entry
            means several sources applied the same label independently. `POST
            /v2/tests/{testId}/remove-labels` removes only the `user` source; a
            `monitor` source stays until the monitor stops applying the label.
      required:
        - id
        - name
        - description
        - color
        - assignedAt
        - sources
      description: >-
        A label on a test, folded across its sources — one entry per label,
        never one per assignment.
    ErrorCode:
      type: string
      enum:
        - AUTHENTICATION_REQUIRED
        - INVALID_TOKEN
        - INSUFFICIENT_PERMISSIONS
        - INTERNAL_ERROR
        - VALIDATION_FAILED
        - NOT_FOUND
        - INVALID_CURSOR
        - MERGE_QUEUE_NOT_FOUND
        - PR_ALREADY_ENQUEUED
        - PR_NOT_ENQUEUEABLE
        - UPSTREAM_ERROR
        - VERIFICATION_RUN_NOT_FOUND
        - PR_NOT_FOUND
        - IMPACTED_TARGETS_NOT_FOUND
        - REPOSITORY_NOT_FOUND
        - IMPACTED_TARGETS_UNSUPPORTED
        - QUEUE_ALREADY_EXISTS
        - QUEUE_HAS_ACTIVE_ENTRIES
        - MODE_CHANGE_IN_PROGRESS
        - PR_NOT_IN_ACTIVE_STATE
        - MERGE_QUEUE_NOT_CREATABLE
        - PR_TESTS_NOT_RESTARTABLE
        - ALLOWED_BOT_SUBMITTERS_FROZEN
        - ESTIMATE_NOT_ENABLED
        - PR_RERUN_FEATURE_DISABLED
        - PR_RERUN_NOT_PENDING_FAILURE
        - PR_RERUN_QUEUE_DOES_NOT_KEEP_FAILED_RUNS
        - PR_RERUN_NOT_A_REQUIRED_CHECK_FAILURE
        - PR_RERUN_CHECK_NOT_RERUNNABLE
        - PR_RERUN_RUN_TORN_DOWN
        - PR_RERUN_HOLD_LIMIT_REACHED
        - PR_RERUN_FORGE_NOT_SUPPORTED
        - PROVIDER_URL_NOT_FOUND
        - CI_HOST_UNSUPPORTED
        - CI_SCOPE_NOT_FOUND
        - PATHS_FILTER_CONFLICT
        - CI_JOB_NOT_FOUND
        - CI_FAILURE_CLUSTER_NOT_FOUND
        - TEST_COLLECTION_NOT_FOUND
        - TEST_NOT_FOUND
        - TEST_UPLOAD_NOT_FOUND
        - MONITOR_NOT_FOUND
        - MONITOR_LIMIT_EXCEEDED
        - MONITOR_NOT_ACTIVE
        - OUT_OF_RANGE
        - TEST_UNAVAILABLE
        - TICKETING_NOT_CONFIGURED
        - TICKETING_CREDENTIALS_INVALID
        - TICKETING_SITE_REFUSED
        - TICKET_NOT_FOUND
        - TICKET_NOT_LINKED
        - TICKET_LINK_CONFLICT
        - TEST_ALREADY_LINKED
        - TICKET_FIELDS_REJECTED
        - TICKET_CONTENT_UNAVAILABLE
        - TICKETING_CREATE_REFUSED
        - RATE_LIMIT_EXCEEDED
      description: >-
        Stable machine-readable error identifier. Switch on this, never on
        `message`. A shipped code's meaning never changes, but **new codes may
        be added within v2** — treat an unrecognized code as a generic failure
        of its HTTP status rather than failing closed.
      example: INTERNAL_ERROR
    LabelSource:
      oneOf:
        - $ref: '#/components/schemas/UserLabelSource'
        - $ref: '#/components/schemas/MonitorLabelSource'
      discriminator:
        propertyName: type
        mapping:
          user: '#/components/schemas/UserLabelSource'
          monitor: '#/components/schemas/MonitorLabelSource'
      description: >-
        Something that put a label on a test. A `user` source carries no monitor
        fields and a `monitor` source carries no user.
    UserLabelSource:
      type: object
      properties:
        type:
          type: string
          enum:
            - user
        user:
          anyOf:
            - $ref: '#/components/schemas/LabelUser'
            - type: 'null'
          description: >-
            Who applied the label. Null when an API token did, since a token
            resolves to no user, or when that user has since been deleted.
        assignedAt:
          type: string
          format: date-time
          description: When the label was applied.
          example: '2026-06-01T00:00:00.000Z'
      required:
        - type
        - user
        - assignedAt
      description: >-
        A label applied by hand: in the web app, or through `POST
        /v2/tests/{testId}/add-labels`.
    MonitorLabelSource:
      type: object
      properties:
        type:
          type: string
          enum:
            - monitor
        monitorId:
          type: string
          example: 1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d
        monitorType:
          $ref: '#/components/schemas/LabelingMonitorType'
        assignedAt:
          type: string
          format: date-time
          description: >-
            The monitor has applied this label since at least this time. Muting
            the monitor, then unmuting it, and editing its label action all
            re-create the assignment, so this can be later than the first time
            it applied the label.
          example: '2026-06-01T00:00:00.000Z'
      required:
        - type
        - monitorId
        - monitorType
        - assignedAt
      description: A label applied by a monitor.
    LabelUser:
      type: object
      properties:
        id:
          type: string
          example: 6f708192-a3b4-4c5d-8e9f-0a1b2c3d4e5f
        name:
          type:
            - string
            - 'null'
          description: >-
            Null only if the user record could not be resolved; the id still
            identifies them.
          example: Ada Lovelace
      required:
        - id
        - name
      description: The person who applied a label.
    LabelingMonitorType:
      type: string
      enum:
        - failureRate
        - passOnRetry
        - failureCount
        - newTest
        - skippedTest
        - slowTest
        - timeoutInflation
      description: A monitor type that can apply a label.
      example: failureRate
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key, sent as `Authorization: Bearer <key>`. An organization admin
        creates one in the Trunk app under **Settings → Developer → API Keys**
        and chooses the permissions it holds. A key with none can read merge
        queues but change nothing in them. Permissions cover merge queues and
        test-result uploads, including the quarantine lookups a CI run makes
        before it uploads; any key can call the other Flaky Tests and Dynamic CI
        endpoints, including their writes.
    trunkToken:
      type: apiKey
      in: header
      name: x-trunk-token
      description: >-
        A short-lived token that Trunk's own tools send in the `x-trunk-token`
        header: the `trunk` CLI after `trunk auth login`, and the
        `trunk-io/login` action in a GitHub Actions run. Your own integrations
        should use an API key instead. Never send `Authorization` and
        `x-trunk-token` on the same request.


        **A token from a GitHub Actions run can only upload impacted targets**
        (`PUT /v2/impacted-targets`), for the repository the run belongs to;
        every other endpoint refuses it.

````