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

# List Samples

> List samples for an experiment.



## OpenAPI

````yaml /openapi.json get /v1/experiments/{experiment_id}/samples
openapi: 3.1.0
info:
  description: Customer-owned evaluation lifecycle API.
  title: HeyBee Public API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.heybee.app
security: []
paths:
  /v1/experiments/{experiment_id}/samples:
    get:
      tags:
        - Samples
      summary: List Samples
      description: List samples for an experiment.
      operationId: list_samples_v1_experiments__experiment_id__samples_get
      parameters:
        - in: path
          name: experiment_id
          required: true
          schema:
            format: uuid
            title: Experiment Id
            type: string
        - in: query
          name: page
          required: false
          schema:
            default: 1
            minimum: 1
            title: Page
            type: integer
        - in: query
          name: page_size
          required: false
          schema:
            default: 50
            maximum: 100
            minimum: 1
            title: Page Size
            type: integer
        - description: Include signed file URLs (slower).
          in: query
          name: include_file_urls
          required: false
          schema:
            default: false
            description: Include signed file URLs (slower).
            title: Include File Urls
            type: boolean
        - description: Include materialized Hugging Face text content for text samples.
          in: query
          name: include_hf_text_content
          required: false
          schema:
            default: false
            description: Include materialized Hugging Face text content for text samples.
            title: Include Hf Text Content
            type: boolean
        - in: query
          name: anchor_value
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Anchor Value
        - in: query
          name: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Query
        - in: query
          name: sort_by
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Sort By
        - in: query
          name: sort_dir
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Sort Dir
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - in: header
          name: X-API-Key
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SampleListResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    SampleListResponse:
      description: List of samples.
      properties:
        page:
          title: Page
          type: integer
        page_size:
          title: Page Size
          type: integer
        samples:
          items:
            $ref: '#/components/schemas/SampleResponse'
          title: Samples
          type: array
        total:
          title: Total
          type: integer
      required:
        - samples
        - total
        - page
        - page_size
      title: SampleListResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    SampleResponse:
      description: Sample response.
      properties:
        anchor_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Anchor Id
        anchor_text:
          anyOf:
            - type: string
            - type: 'null'
          title: Anchor Text
        anchor_value:
          anyOf:
            - type: string
            - type: 'null'
          title: Anchor Value
        asset_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Asset Id
        availability_status:
          default: active
          title: Availability Status
          type: string
        candidate_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Candidate Id
        candidate_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Candidate Key
        candidate_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Candidate Label
        candidate_metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Candidate Metadata
        comparisons:
          anyOf:
            - type: integer
            - type: 'null'
          title: Comparisons
        content:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Content
        content_hash:
          anyOf:
            - type: string
            - type: 'null'
          title: Content Hash
        content_origin:
          default: local_storage
          title: Content Origin
          type: string
        created_at:
          format: date-time
          title: Created At
          type: string
        elo_rating:
          anyOf:
            - type: number
            - type: 'null'
          title: Elo Rating
        experiment_id:
          format: uuid
          title: Experiment Id
          type: string
        file_path:
          title: File Path
          type: string
        file_url:
          anyOf:
            - type: string
            - type: 'null'
          description: Signed download URL (short-lived)
          title: File Url
        id:
          format: uuid
          title: Id
          type: string
        ingestion_batch_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Ingestion Batch Id
        is_exam_only:
          default: false
          title: Is Exam Only
          type: boolean
        losses:
          anyOf:
            - type: integer
            - type: 'null'
          title: Losses
        mean_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Mean Score
        output_type:
          enum:
            - text
            - image
            - audio
            - video
          title: Output Type
          type: string
        parameters:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Parameters
        remote:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Remote
        score_count:
          default: 0
          title: Score Count
          type: integer
        source_kind:
          default: local
          enum:
            - local
            - huggingface
          title: Source Kind
          type: string
        source_manifest_row:
          anyOf:
            - type: integer
            - type: 'null'
          title: Source Manifest Row
        source_sample_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Source Sample Id
        suggestion_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Suggestion Id
        thumbnail_url:
          anyOf:
            - type: string
            - type: 'null'
          description: Signed thumbnail URL (short-lived)
          title: Thumbnail Url
        wins:
          anyOf:
            - type: integer
            - type: 'null'
          title: Wins
      required:
        - id
        - experiment_id
        - output_type
        - file_path
        - anchor_value
        - parameters
        - created_at
      title: SampleResponse
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: Supabase JWT
      scheme: bearer
      type: http
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey

````