Cosmonic Get Started API

openapi: 3.1.0
info:
  title: Cosmonic Get Started API
  version: '2026-10-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-11: 4 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Cosmonic has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 13
    documentation: 0
    pages-with-code: 13
    pages-read: 13
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://cosmonic.com/docs/desktop/Quickstart
  - https://cosmonic.com/docs/desktop/daemon
  - https://cosmonic.com/docs/desktop/install/verify-signatures
  x-docs-section: desktop
servers:
- url: https://raw.githubusercontent.com
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://cosmonic.com/docs/desktop/Quickstart
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl http://hello-world.localhost:8200/ \n You should get a greeting back. (On systems whose resolver doesn't handle .localhost\
          \ subdomains, such as some Linux distributions without systemd-resolved , send the hostname as a header instead: curl -H 'Host: hello-world.localhost'\
          \ http://127.0.0.1:8200/ .) In the app, expanding the workload's row shows its components, capabilities, version and digest, a"
  /pkiops/certs/Microsoft%20Identity%20Verification%20Root%20Certificate%20Authority%202020.crt:
    get:
      operationId: get_pkiops_certs_Microsoft_20Identity_20Verification_20Root_20Certificate_20Auth
      tags:
      - Pkiops
      summary: GET /pkiops/certs/Microsoft%20Identity%20Verification%20Root%20Certificate%20Authority%202020.crt
      x-source: https://cosmonic.com/docs/desktop/install/verify-signatures
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSL -o ms-root.crt  \"https://www.microsoft.com/pkiops/certs/Microsoft%20Identity%20Verification%20Root%20Certificate%20Authority%202020.crt\"\
          \ \n openssl x509 -inform DER -in ms-root.crt -out ms-root.pem \n Then verify: \n osslsigncode verify -CAfile ms-root.pem cosmonic-desktop-\
          \ < versio n > -x64.exe \n Look for Signature verification: ok and a signer of Cosmonic Corp . (If\nyou skip -CAfile , se"
  /v1/workloads:
    get:
      operationId: get_v1_workloads
      tags:
      - Workloads
      summary: GET /v1/workloads
      x-source: https://cosmonic.com/docs/desktop/daemon
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -sS --unix-socket /tmp/cosmonic/cosmonicd.sock http://localhost/v1/workloads  | jq ''.[0].status.state'' # → "running" '
  /v1/{v1id}:
    post:
      operationId: post_v1_v1id
      tags:
      - Api
      summary: POST /v1/synthesize
      x-source: https://cosmonic.com/docs/desktop/daemon
      parameters:
      - name: v1id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1V1IdRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -sS --unix-socket /tmp/cosmonic/cosmonicd.sock  -X POST http://localhost/v1/synthesize  -H ''content-type: application/json''  -d
          ''{"source":"ghcr.io/cosmonic-labs/control-demos/hello-world:0.1.2"}''  | jq .workload > workload.json '
        collapsed_from: 2 example path(s) differing only at v1Id
components:
  schemas:
    PostV1V1IdRequest:
      type: object
      properties:
        source:
          type: string
tags:
- name: Api
- name: Pkiops
- name: Workloads