> ## 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. # Set the CLI version this gateway names to its runners > Stores the `@outerlayer/cli` version that `follow` factories of this gateway move their runners to. The gateway names the higher of this version and the version it was built from, so a stored version never lowers what a deploy names. Needs this gateway's runner version key as a bearer token, and no factory named. The gateway refuses a version npm does not serve (422 `version_not_published`), a version below the one it names now (409 `version_below_current`), and a call while npm cannot be read (503 `npm_unavailable`). A gateway with no runner version key configured answers 403 to every caller. Setting the version already stored answers 200 with `changed` false and writes nothing. `runUrl` and `actor` are what the caller reports about the workflow run and the GitHub actor; the gateway records them in its audit log and cannot verify them. ## OpenAPI ````yaml /openapi.yaml put /v1/runner-version 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 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: >- 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/runner-version: put: tags: - Runner version summary: Set the CLI version this gateway names to its runners description: >- Stores the `@outerlayer/cli` version that `follow` factories of this gateway move their runners to. The gateway names the higher of this version and the version it was built from, so a stored version never lowers what a deploy names. Needs this gateway's runner version key as a bearer token, and no factory named. The gateway refuses a version npm does not serve (422 `version_not_published`), a version below the one it names now (409 `version_below_current`), and a call while npm cannot be read (503 `npm_unavailable`). A gateway with no runner version key configured answers 403 to every caller. Setting the version already stored answers 200 with `changed` false and writes nothing. `runUrl` and `actor` are what the caller reports about the workflow run and the GitHub actor; the gateway records them in its audit log and cannot verify them. operationId: set-runner-version requestBody: content: application/json: schema: properties: actor: maxLength: 100 minLength: 1 type: string runUrl: maxLength: 500 minLength: 1 type: string version: maxLength: 64 minLength: 1 type: string required: - version - runUrl - actor type: object responses: '200': content: application/json: schema: properties: data: properties: changed: description: >- False when the version was already stored and nothing was written. type: boolean effectiveVersion: description: The version this gateway now names to its runners. type: string previousVersion: description: >- The version stored before this call, or null when none was. nullable: true type: string version: description: The version now stored. type: string required: - version - previousVersion - effectiveVersion - changed type: object required: - data type: object description: The version is stored, or was already stored. '400': content: application/json: schema: properties: error: properties: code: type: string message: type: string required: - code - message type: object required: - error type: object description: A 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 wrong runner version 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: This gateway has no runner version key configured. '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 version is below the one this gateway names now (`version_below_current`), or the stored version changed twice during the call (`runner_version_changed`). '422': content: application/json: schema: properties: error: properties: code: type: string message: type: string required: - code - message type: object required: - error type: object description: npm does not serve this version (`version_not_published`). '503': content: application/json: schema: properties: error: properties: code: type: string message: type: string required: - code - message type: object required: - error type: object description: npm cannot be read, or the store is unavailable. security: - RunnerVersionKeyAuth: [] 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 RunnerVersionKeyAuth: description: >- This gateway's runner version key. The gateway holds only its SHA-256 hash. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.