> ## Documentation Index > Fetch the complete documentation index at: https://docs-stg.outerlayer.ai/llms.txt > Use this file to discover all available pages before exploring further. # Add a mock to a work item > Adds a mock: an image that shows what to build. `attachmentId` names an image that the upload route stored on this item first, a PNG or a JPEG of at most 8 MiB. An item holds 20 current mocks, and a name is 1 to 80 characters. The caller is a member's CLI login with `spec.update`, which records the member, or the item key of an agent job. An agent's mock records the agent, the lease and the member who asked: the author of the newest message that a person sent to the agent, no later than the start of the lease. A job that no member's message started is refused (`mock_no_asker`). A plain API key is refused (`member_login_required`). An upload whose mock is then refused leaves an attachment that no mock names, and the cleanup of unused attachments removes it. ## OpenAPI ````yaml /openapi.yaml post /v1/work-items/{workItemId}/mocks 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: >- The route a fleet machine asks for its next managed build on. A fleet machine is a machine OuterLayer operates. name: Fleet - description: >- The CLI version a gateway names to its runners, set with the gateway's runner version key. name: Runner version - 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: >- Find, file and edit the issue a spec lives in, through OuterLayer, with no tracker credential on the caller's side. name: Specs - 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: >- The runs of a schedule automation: a runner claims a run, asks for its read token and ends it, and the run's agent reports each issue it found or that it found nothing. name: Schedule runs - 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}/mocks: post: tags: - Work Items summary: Add a mock to a work item description: >- Adds a mock: an image that shows what to build. `attachmentId` names an image that the upload route stored on this item first, a PNG or a JPEG of at most 8 MiB. An item holds 20 current mocks, and a name is 1 to 80 characters. The caller is a member's CLI login with `spec.update`, which records the member, or the item key of an agent job. An agent's mock records the agent, the lease and the member who asked: the author of the newest message that a person sent to the agent, no later than the start of the lease. A job that no member's message started is refused (`mock_no_asker`). A plain API key is refused (`member_login_required`). An upload whose mock is then refused leaves an attachment that no mock names, and the cleanup of unused attachments removes it. operationId: post-work-item-mock parameters: - in: path name: workItemId required: true schema: type: string requestBody: content: application/json: schema: additionalProperties: false properties: attachmentId: description: The id the upload route answered for the image. format: uuid type: string criterionIds: description: >- The ids of the criteria the mock shows, as the item's spec writes them. items: maxLength: 200 minLength: 1 type: string maxItems: 50 type: array name: description: 'The mock''s name: 1 to 80 characters.' maxLength: 80 minLength: 1 type: string required: - attachmentId - name type: object responses: '201': content: application/json: schema: properties: data: properties: attachmentId: description: The mock's current image. type: string filename: description: The file name of the current image. type: string id: description: The mock. type: string name: type: string required: - id - name - attachmentId - filename type: object required: - data type: object description: The mock was added. '400': content: application/json: schema: properties: error: properties: code: type: string message: type: string required: - code - message type: object required: - error type: object description: >- The body is not valid, such as a name over 80 characters (`invalid_request_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 credential. '402': content: application/json: schema: properties: error: properties: code: type: string message: type: string required: - code - message type: object required: - error type: object description: >- The organization is read-only (`billing_read_only`). Nothing is stored. '403': content: application/json: schema: properties: error: properties: code: type: string message: type: string required: - code - message type: object required: - error type: object description: >- The credential lacks `spec.update`, is not a member's CLI login or an agent job (`member_login_required`), no member asked the agent for this (`mock_no_asker`), or the item key is for another item or for a lease that ended (`item_key_out_of_scope`). Nothing is stored. '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 (`work_item_not_found`), no such mock on it (`mock_not_found`), or the attachment is not on it (`mock_attachment_not_found`). '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 mock is no longer current (`mock_not_current`), the item holds 20 current mocks (`mock_limit_reached`), or a current mock already holds the file (`mock_attachment_in_use`). '422': content: application/json: schema: properties: error: properties: code: type: string message: type: string required: - code - message type: object required: - error type: object description: >- The file is not a PNG or JPEG image (`mock_not_an_image`), or a criterion is not recorded for the item (`mock_unknown_criterion`). 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.