> ## Documentation Index > Fetch the complete documentation index at: https://docs.boat.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get CI overview > Setup steps, jobs boat did not run, linked GitHub accounts and repositories, 7-day stats and jobs. ## OpenAPI ````yaml openapi/boat-v1.yaml GET /ci openapi: 3.1.0 info: title: Boat Public API v1 version: 1.0.0 description: > Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1. servers: - url: https://boat.dev/api/v1 security: - BoatBearerAuth: [] tags: - name: Boat description: >- Unified Boat account, setup, lifecycle, prompting, event history, desktop access, and SSH operations. paths: /ci: get: tags: - Boat summary: Get CI overview description: > GitHub Actions on boat (`runs-on: boat`): the setup steps and the next one, jobs boat did not run and why, the linked GitHub accounts with every repository they can see, 7-day stats, and the jobs. The same data as the dashboard's CI tab and `boat ci`. `account` and `repo` narrow everything (problems, counts, stats, jobs); `state` narrows only the job list. Covers what you linked and what is linked to the organization in scope. Needs an API key with `account.read`. operationId: getCiOverview parameters: - name: account in: query schema: type: string description: Only this GitHub account (organization or user login). - name: repo in: query schema: type: string description: Only this repository, as owner/name. - name: state in: query schema: type: string enum: - all - active - failed default: all description: >- active = queued or running. failed = failed, never started, or refused. - name: limit in: query schema: type: integer minimum: 1 maximum: 500 default: 200 responses: '200': description: The overview. content: application/json: schema: $ref: '#/components/schemas/CiOverviewResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' components: schemas: CiOverviewResponse: allOf: - $ref: '#/components/schemas/SuccessBase' - type: object required: - setup - installations - counts - stats - jobs properties: type: type: string const: ci.overview setup: type: object description: >- The four setup steps, the next one to do, and jobs boat did not run (grouped by repository and reason). properties: complete: type: boolean next: type: - string - 'null' enum: - install - repositories - workflow - first-pass - null steps: type: array items: type: object properties: id: type: string title: type: string done: type: boolean detail: type: string problems: type: array items: type: object properties: jobId: type: string repo: type: string message: type: string at: type: string format: date-time count: type: integer installations: type: array items: $ref: '#/components/schemas/CiInstallation' filter: type: object properties: account: type: - string - 'null' repo: type: - string - 'null' state: type: string enum: - all - active - failed counts: type: object description: >- Jobs in the last 7 days in the account and repo scope, per state tab. properties: all: type: integer active: type: integer failed: type: integer stats: type: object properties: jobs: type: integer running: type: integer successRate: type: - number - 'null' medianWaitSeconds: type: - number - 'null' medianRunSeconds: type: - number - 'null' costDollars: type: number perDay: type: array items: type: object properties: day: type: string format: date success: type: integer failure: type: integer other: type: integer jobs: type: array items: $ref: '#/components/schemas/CiJob' SuccessBase: type: object required: - ok - type properties: ok: type: boolean examples: - true type: type: string description: Stable success envelope discriminator added by v1. CiInstallation: type: object required: - id - accountLogin - accountType - manageUrl - repositories properties: id: type: string description: GitHub App installation id. accountLogin: type: string examples: - acme accountType: type: string enum: - Organization - User teamId: type: - string - 'null' description: The organization that pays; null = the personal wallet. allowPublicRepos: type: boolean manageUrl: type: string description: Where to choose the repositories on GitHub. repositories: type: array items: $ref: '#/components/schemas/CiRepository' CiJob: type: object required: - id - repo - jobName - label - machineClass - state - queuedAt properties: id: type: string description: GitHub workflow job id. examples: - '122395651084' repo: type: string examples: - acme/api runId: type: string jobName: type: string examples: - test workflowName: type: - string - 'null' examples: - ci headBranch: type: - string - 'null' examples: - main headSha: type: - string - 'null' htmlUrl: type: - string - 'null' description: The job on GitHub. label: type: string description: The runs-on label that matched. examples: - boat-large/debug machineClass: type: string enum: - small - default - large - xlarge state: $ref: '#/components/schemas/CiJobState' error: type: - string - 'null' description: Why boat refused or could not start the job. sandboxId: type: - string - 'null' description: The sandbox this job's runner started. sandboxState: type: - string - 'null' enum: - live - busy - kept - deleted - null description: kept = a failed /debug job's sandbox, kept 30 minutes. queuedAt: type: string format: date-time runStartedAt: type: - string - 'null' format: date-time finishedAt: type: - string - 'null' format: date-time waitSeconds: type: - number - 'null' description: Queued on GitHub until a runner took it. runSeconds: type: - number - 'null' costDollars: type: - number - 'null' description: Sandbox time of the job at the size's rate. ErrorEnvelope: type: object required: - ok - type - status - code - message - error - requestId properties: ok: type: boolean examples: - false type: type: string examples: - sandbox.error status: type: integer examples: - 409 code: type: string examples: - provider_not_configured message: type: string examples: - Prompting is locked until Codex is configured on the Agents page. requestId: type: string examples: - req_01HX... error: type: object required: - code - message - status properties: code: type: string message: type: string status: type: integer details: type: object additionalProperties: true CiRepository: type: object required: - fullName - private - htmlUrl - status - jobs7d properties: fullName: type: string examples: - acme/api private: type: boolean htmlUrl: type: string status: type: string enum: - ok - no-jobs - failing - public-blocked description: public-blocked = public repository, jobs never run. jobs7d: type: integer description: Jobs in the last 7 days. lastState: oneOf: - type: 'null' - $ref: '#/components/schemas/CiJobState' lastAt: type: - string - 'null' format: date-time lastError: type: - string - 'null' CiJobState: type: string description: >- queued and running are active. failed = boat could not start a sandbox; refused = boat never runs it (unknown label, public repository). enum: - queued - running - success - failure - cancelled - skipped - failed - refused responses: BadRequest: description: Invalid request body or parameters. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: invalid: value: ok: false type: sandbox.error status: 400 code: invalid_json message: Request body must be valid JSON. error: code: invalid_json message: Request body must be valid JSON. status: 400 requestId: req_01HX... Unauthorized: description: Missing or invalid bearer token. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: unauthorized: value: ok: false type: sandbox.error status: 401 code: unauthorized message: Unauthorized error: code: unauthorized message: Unauthorized status: 401 requestId: req_01HX... securitySchemes: BoatBearerAuth: type: http scheme: bearer bearerFormat: sandbox_api_key description: >- Boat bearer token in the form `boat_...`. Service API keys authenticate sandbox operations. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.