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

# Record a work item's acceptance criteria

> Records the work item's acceptance criteria as one list of 1 to 200 criteria, each with an id, its text and the artifact kind that proves it (or null). The list is the only source for the item's Criteria tab, its count and its status. Every recorded list is kept with who recorded it and when; the current list is the newest. When the item has no list, any caller with the permission may record one. When it has one, a replacement from an agent session, or from a key bound to no member, is refused with 409 unless the repository's default-branch policy sets `criteria.replace: anyone`; a person can always replace it. The item is named by `item.number`, and a request naming none is refused with nothing stored. Recording a list nominates the item for re-evaluation.



## OpenAPI

````yaml /openapi.yaml post /v1/criteria
openapi: 3.0.3
info:
  contact:
    email: hello@outerlayer.ai
    url: https://www.outerlayer.ai
  description: >-
    The OuterLayer Gateway API lets you ingest coding-agent sessions and record
    evidence of work programmatically.


    Most teams reach it through the `outerlayer` CLI, which calls it for them.

    Call it directly to build your own integration or to automate what the
    dashboard does.


    Versioning: every endpoint is prefixed with `/v1/`. Breaking changes ship
    under a new version prefix (`/v2/`, etc.) with a 90-day-minimum deprecation
    window; anything additive lands on the current prefix.


    Vocabulary: the dashboard calls this API's `app` a **factory** — the unit
    that owns a set of repositories, the agent sessions worked on them, and the
    evidence they produce. They are the same entity. The API keeps `app` in its
    paths, headers, and field names because those are a published contract; only
    the product surface was renamed.
  title: OuterLayer Gateway API
  version: '1.0'
servers:
  - description: Production (OuterLayer Cloud)
    url: https://api.outerlayer.ai
  - description: Local dev server (self-hosted gateway)
    url: http://localhost:9418
security:
  - AppId: []
    BearerAuth: []
tags:
  - description: >-
      What a CLI login token can read about its owner without naming a factory,
      such as the factories they can use.
    name: Account
  - description: >-
      Coding-agent session ingest (outerlayer sync) and content-addressed
      session images.
    name: Agents
  - description: >-
      Evidence artifacts (screenshots, recordings, reports, logs) emitted as
      proof of a change and anchored to pull requests.
    name: Artifacts
  - description: >-
      Pass/fail outcomes of checks run in your own CI or compute, anchored to
      pull requests with the run URL as proof.
    name: Emitted Results
  - description: >-
      The acceptance criteria of a work item, recorded as one list. The Criteria
      tab, its count and the item status read that list.
    name: Criteria
  - description: >-
      What any agent found wrong about a change under review or about a rule it
      ran on, recorded on a work item.
    name: Findings
  - description: >-
      Add or remove a source's statement that it is working on an issue or pull
      request, and read what is currently live.
    name: Work Items
  - description: >-
      What the factory's GitHub App installation lets builds do on each
      connected repository, and whether each default branch requires a pull
      request.
    name: Repositories
  - description: >-
      A runner host's heartbeat — its CLI version, slots and last request for
      work — and the factory's list of hosts with a derived status.
    name: Hosts
  - description: Query server feature availability.
    name: Capabilities
  - description: Per-model LLM pricing data. Public, unauthenticated.
    name: Pricing
  - description: >-
      Create, list, and revoke factory API keys. Plaintext returned exactly once
      at creation.
    name: API Keys
  - description: >-
      Factory CRUD — a factory is owned by an organization and is the unit every
      other resource hangs off. Lets a headless agent provision one without the
      dashboard.
    name: Apps
  - description: >-
      Agent-coding session list and full transcript reads, with actor-privacy
      controls for machine keys.
    name: Sessions
  - description: >-
      Per-model token spend and fleet-wide agent behavior tiles, including
      two-window comparisons.
    name: Metrics
  - description: Synced-commit history of the app's `.outerlayer/` context tree.
    name: Context
  - description: >-
      Session→PR attribution: which agent sessions produced which pull requests,
      and what each attributed PR cost.
    name: PRs
  - description: Service health checks.
    name: Health
  - description: >-
      Org member and role administration, authenticated with an org-scoped
      management API key (`olk_…`) minted in the dashboard's settings.
    name: Org Management
  - description: OAuth 2.1 discovery metadata for MCP connector clients.
    name: OAuth
paths:
  /v1/criteria:
    post:
      tags:
        - Criteria
      summary: Record a work item's acceptance criteria
      description: >-
        Records the work item's acceptance criteria as one list of 1 to 200
        criteria, each with an id, its text and the artifact kind that proves it
        (or null). The list is the only source for the item's Criteria tab, its
        count and its status. Every recorded list is kept with who recorded it
        and when; the current list is the newest. When the item has no list, any
        caller with the permission may record one. When it has one, a
        replacement from an agent session, or from a key bound to no member, is
        refused with 409 unless the repository's default-branch policy sets
        `criteria.replace: anyone`; a person can always replace it. The item is
        named by `item.number`, and a request naming none is refused with
        nothing stored. Recording a list nominates the item for re-evaluation.
      operationId: post-criteria
      requestBody:
        content:
          application/json:
            schema:
              properties:
                criteria:
                  items:
                    additionalProperties: false
                    properties:
                      id:
                        pattern: ^[A-Za-z0-9_.:-]{1,64}$
                        type: string
                      proof:
                        enum:
                          - video
                          - screenshot
                          - report
                          - log
                          - test
                          - file
                          - null
                        nullable: true
                        type: string
                      text:
                        maxLength: 2000
                        minLength: 1
                        type: string
                    required:
                      - id
                      - text
                      - proof
                    type: object
                  maxItems: 200
                  minItems: 1
                  type: array
                item:
                  properties:
                    number:
                      exclusiveMinimum: true
                      minimum: 0
                      type: integer
                  required:
                    - number
                  type: object
                sessionId:
                  type: string
              required:
                - criteria
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      count:
                        type: integer
                      replaced:
                        type: boolean
                      workItemId:
                        type: string
                    required:
                      - workItemId
                      - count
                      - replaced
                    type: object
                required:
                  - data
                type: object
          description: >-
            The work item the list was recorded on, how many criteria it holds,
            and whether it replaced an earlier list.
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: >-
            Malformed body, a repeated or malformed criterion id, or nothing to
            attach the list to.
        '401':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Missing or invalid API key.
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: No such work item.
        '409':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: >-
            The item already has a list and the caller may not replace it
            (`criteria_replace_refused`), or another replacement won while this
            one was recorded (`criteria_changed`).
        '503':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: >-
            GitHub was rate limiting or failing while the repository policy was
            read (`github_unavailable`, safe to retry).
components:
  securitySchemes:
    AppId:
      description: Factory id the request is scoped to.
      in: header
      name: X-Outerlayer-App-Id
      type: apiKey
    BearerAuth:
      description: API key (sk_outerlayer_*)
      scheme: bearer
      type: http

````

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