> ## 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.

# Get Rlhf State

> Campaign state for the trainer to poll: current round, whether it is trainable, latest checkpoint.



## OpenAPI

````yaml /openapi.json get /v1/rlhf/experiments/{experiment_id}/state
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/rlhf/experiments/{experiment_id}/state:
    get:
      tags:
        - RLHF
      summary: Get Rlhf State
      description: >-
        Campaign state for the trainer to poll: current round, whether it is
        trainable, latest checkpoint.
      operationId: get_rlhf_state_v1_rlhf_experiments__experiment_id__state_get
      parameters:
        - in: path
          name: experiment_id
          required: true
          schema:
            format: uuid
            title: Experiment Id
            type: string
        - 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/RlhfCampaignState'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    RlhfCampaignState:
      description: >-
        What the trainer polls: current round, whether it is trainable, latest
        checkpoint.
      properties:
        axes:
          items:
            type: string
          title: Axes
          type: array
        current_round:
          anyOf:
            - $ref: '#/components/schemas/RlhfRound'
            - type: 'null'
        experiment_id:
          title: Experiment Id
          type: string
        latest_checkpoint:
          anyOf:
            - $ref: '#/components/schemas/RlhfCheckpointRef'
            - type: 'null'
        min_decisive_pairs_per_axis:
          title: Min Decisive Pairs Per Axis
          type: integer
        objective:
          anyOf:
            - type: string
            - type: 'null'
          title: Objective
        per_axis:
          items:
            $ref: '#/components/schemas/RlhfAxisProgress'
          title: Per Axis
          type: array
        round_count:
          title: Round Count
          type: integer
        trainable:
          default: false
          title: Trainable
          type: boolean
      required:
        - experiment_id
        - axes
        - round_count
        - min_decisive_pairs_per_axis
      title: RlhfCampaignState
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    RlhfRound:
      description: 'One round of the loop: the checkpoint that generated its cohort + state.'
      properties:
        checkpoint_candidate_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Checkpoint Candidate Id
        checkpoint_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Checkpoint Key
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        id:
          title: Id
          type: string
        opened_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Opened At
        parent_round_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Parent Round Id
        round_index:
          title: Round Index
          type: integer
        state:
          title: State
          type: string
        trainable_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Trainable At
        trainable_thresholds:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Trainable Thresholds
        trained_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Trained At
        training_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Training At
      required:
        - id
        - round_index
        - state
      title: RlhfRound
      type: object
    RlhfCheckpointRef:
      properties:
        candidate_id:
          title: Candidate Id
          type: string
        candidate_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Candidate Key
      required:
        - candidate_id
      title: RlhfCheckpointRef
      type: object
    RlhfAxisProgress:
      description: >-
        Round-scoped labeled-pair volume on one axis, vs the trainable
        threshold.
      properties:
        axis_key:
          title: Axis Key
          type: string
        decisive:
          title: Decisive
          type: integer
        met:
          title: Met
          type: boolean
        threshold:
          title: Threshold
          type: integer
      required:
        - axis_key
        - decisive
        - threshold
        - met
      title: RlhfAxisProgress
      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

````