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

# Send review notes on several criteria as one agent job

> Stores one plain comment on each named criterion's thread and one `fail` on the item's general thread whose body lists the notes, in a single statement: either every row is stored or none is. The `fail` is what asks an agent to amend, so one send starts one job. Only a person can send notes (`verdict_needs_person` otherwise), and only on an item that is reviewable (`not_reviewable`). Retrying with the same `clientSendId` returns the rows already stored.



## OpenAPI

````yaml /openapi.yaml post /v1/work-items/{workItemId}/notes
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/work-items/{workItemId}/notes:
    post:
      tags:
        - Work Items
      summary: Send review notes on several criteria as one agent job
      description: >-
        Stores one plain comment on each named criterion's thread and one `fail`
        on the item's general thread whose body lists the notes, in a single
        statement: either every row is stored or none is. The `fail` is what
        asks an agent to amend, so one send starts one job. Only a person can
        send notes (`verdict_needs_person` otherwise), and only on an item that
        is reviewable (`not_reviewable`). Retrying with the same `clientSendId`
        returns the rows already stored.
      operationId: post-work-item-review-notes
      parameters:
        - in: path
          name: workItemId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                clientSendId:
                  pattern: ^[A-Za-z0-9_.-]{1,100}$
                  type: string
                notes:
                  items:
                    properties:
                      body:
                        maxLength: 2000
                        minLength: 1
                        type: string
                      criterion:
                        pattern: ^[A-Za-z0-9_.:-]{1,64}$
                        type: string
                    required:
                      - criterion
                      - body
                    type: object
                  maxItems: 50
                  minItems: 1
                  type: array
                schemaVersion:
                  enum:
                    - 1
                  type: number
              required:
                - schemaVersion
                - clientSendId
                - notes
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      created:
                        type: boolean
                      failId:
                        type: string
                      noteIds:
                        items:
                          type: string
                        type: array
                    required:
                      - failId
                      - noteIds
                      - created
                    type: object
                required:
                  - data
                type: object
          description: The send already existed (idempotent retry).
        '201':
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      created:
                        type: boolean
                      failId:
                        type: string
                      noteIds:
                        items:
                          type: string
                        type: array
                    required:
                      - failId
                      - noteIds
                      - created
                    type: object
                required:
                  - data
                type: object
          description: The notes and the fail were recorded.
        '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.
        '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.
        '403':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: >-
            An agent session or a machine key sent the notes, or the caller
            lacks work.review.
        '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 is not reviewable, or this clientSendId already recorded a
            different send.
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.