> ## 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. # File a spec as an issue > Creates an issue in the factory's tracker with the given title and Markdown body, and answers with its key, URL and the `outerlayer work build` command that builds it. Where to file is decided from what the factory connected: when it could be more than one place the request is refused with the choices in `error.details`. Every attempt that reaches a tracker is recorded in the factory's write log. ## OpenAPI ````yaml /openapi.yaml post /v1/specs 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: >- 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/specs: post: tags: - Specs summary: File a spec as an issue description: >- Creates an issue in the factory's tracker with the given title and Markdown body, and answers with its key, URL and the `outerlayer work build` command that builds it. Where to file is decided from what the factory connected: when it could be more than one place the request is refused with the choices in `error.details`. Every attempt that reaches a tracker is recorded in the factory's write log. operationId: file-spec requestBody: content: application/json: schema: additionalProperties: false properties: body: description: The spec, as Markdown. minLength: 1 type: string repository: description: >- The repository to file in for GitHub, or the repository the work lands in for another tracker. maxLength: 256 minLength: 1 type: string scope: description: >- The Linear team or Jira project. Required when the connection covers several. maxLength: 128 minLength: 1 type: string title: maxLength: 256 minLength: 1 type: string tracker: description: Required when the factory can file in more than one tracker. maxLength: 32 minLength: 1 type: string required: - title - body type: object responses: '201': content: application/json: schema: properties: data: properties: key: type: string number: type: number repository: nullable: true type: string tracker: type: string updatedAt: nullable: true type: string url: type: string workBuild: description: The command that builds this issue. type: string required: - tracker - key - number - url - updatedAt - repository - workBuild type: object required: - data type: object description: The issue was created. '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 request body or query was not valid. '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. '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 key lacks the permission, or the tracker connection may not write (`tracker_write_not_permitted`). '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 request did not say where to file, or the tracker cannot be filed in: `tracker_required`, `tracker_invalid`, `repository_required`, `scope_required`, `tracker_cannot_file`, `issue_key_malformed`. The error `details` list the choices. '502': content: application/json: schema: properties: error: properties: code: type: string message: type: string required: - code - message type: object required: - error type: object description: The tracker could not be reached; retryable. '503': content: application/json: schema: properties: error: properties: code: type: string message: type: string required: - code - message type: object required: - error type: object description: >- The dashboard could not be reached or its answer could not be trusted (`spec_service_unavailable`); retryable. 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.