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

# Run Screen

> Screen for disparity, and keep the run as evidence.

**Who may call it:** governance-officer or admin. A workspace API key is refused here: this is an act that belongs to a named person.



## OpenAPI

````yaml /api/openapi.json post /v1/fairness/screens
openapi: 3.1.0
info:
  title: RotaGrant API
  version: 0.1.0
  description: >-
    The HTTP API of a RotaGrant deployment, made from the product's own route
    definitions at the commit named in `x-rotascale-source`. Nothing here is
    written by hand.


    There is no shared endpoint. RotaGrant runs in your environment, and your
    deployment serves its own copy of this description at `/api/docs`. That copy
    is the authority on what your version has and which features are switched
    on; this one is the reference for one commit of the main line. The version
    is 0.1.0: routes and shapes can still change.


    Every route says who may call it. Most need a bearer token from the identity
    provider your deployment uses, held by a person with the role named. The
    routes an SDK calls also accept a workspace API key. A few are open, and say
    why.
servers:
  - url: https://{deployment}
    description: Your own deployment. There is no shared endpoint.
    variables:
      deployment:
        default: rotagrant.internal.example
        description: The host your deployment answers on.
security: []
paths:
  /v1/fairness/screens:
    post:
      tags:
        - Fairness
      summary: Run Screen
      description: >-
        Screen for disparity, and keep the run as evidence.


        **Who may call it:** governance-officer or admin. A workspace API key is
        refused here: this is an act that belongs to a named person.
      operationId: run_screen_v1_fairness_screens_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunIn'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - bearerToken: []
components:
  schemas:
    RunIn:
      properties:
        attribute:
          type: string
          maxLength: 64
          minLength: 1
          title: Attribute
        agent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Agent Id
        since:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Since
        until:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Until
        purpose:
          type: string
          maxLength: 2000
          minLength: 10
          title: Purpose
      type: object
      required:
        - attribute
        - purpose
      title: RunIn
    ScreenOut:
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
        attribute:
          type: string
          title: Attribute
        market_profile:
          type: string
          title: Market Profile
        profile_source:
          type: string
          title: Profile Source
        legal_basis:
          type: string
          title: Legal Basis
        conditions:
          items:
            $ref: '#/components/schemas/ConditionOut'
          type: array
          title: Conditions
        reference:
          anyOf:
            - type: string
            - type: 'null'
          title: Reference
        decisions:
          type: integer
          title: Decisions
        undisclosed:
          type: integer
          title: Undisclosed
        cohorts:
          items:
            $ref: '#/components/schemas/CohortOut'
          type: array
          title: Cohorts
        verdict:
          type: string
          title: Verdict
        caveats:
          items:
            type: string
          type: array
          title: Caveats
        run_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Run By
        run_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Run At
        purpose:
          anyOf:
            - type: string
            - type: 'null'
          title: Purpose
      type: object
      required:
        - attribute
        - market_profile
        - profile_source
        - legal_basis
        - conditions
        - decisions
        - undisclosed
        - cohorts
        - verdict
        - caveats
      title: ScreenOut
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ConditionOut:
      properties:
        name:
          type: string
          title: Name
        state:
          type: string
          title: State
        detail:
          type: string
          title: Detail
      type: object
      required:
        - name
        - state
        - detail
      title: ConditionOut
    CohortOut:
      properties:
        value:
          type: string
          title: Value
        'n':
          type: integer
          title: 'N'
        allowed:
          type: integer
          title: Allowed
        rate:
          anyOf:
            - type: number
            - type: 'null'
          title: Rate
        suppressed:
          type: boolean
          title: Suppressed
        suppressed_note:
          anyOf:
            - type: string
            - type: 'null'
          title: Suppressed Note
        gap:
          anyOf:
            - type: number
            - type: 'null'
          title: Gap
        ratio:
          anyOf:
            - type: number
            - type: 'null'
          title: Ratio
        z:
          anyOf:
            - type: number
            - type: 'null'
          title: Z
        verdict:
          type: string
          title: Verdict
      type: object
      required:
        - value
        - 'n'
        - allowed
        - suppressed
        - verdict
      title: CohortOut
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A token from the identity provider your deployment federates with. It
        identifies a person; their roles in the workspace decide what they may
        do.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.