> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ai-cmo.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Start a workspace run



## OpenAPI

````yaml /openapi.json post /api/v1/workspaces/{workspace}/runs
openapi: 3.0.3
info:
  title: ai-cmo.dev Services API
  version: 1.0.0
servers: []
security: []
tags:
  - name: Meta
    description: Health and the generated API description.
  - name: Auth
    description: Signup, login, sessions and email verification.
  - name: Device authorization
    description: Browser-approved API key provisioning for agents and the MCP server.
  - name: Setup tokens
    description: Single-use tokens that bootstrap a connector or agent.
  - name: MCP
    description: The canonical MCP install prompt.
  - name: Workspaces
    description: Workspace creation, settings, profile and competitors.
  - name: API keys
    description: 'Key lifecycle: create, deliver, acknowledge, rotate, revoke.'
  - name: Connections
    description: Connector status, tests, configuration and credentials.
  - name: Runs
    description: Measurement runs and their jobs.
  - name: Research
    description: The five-stage research pipeline.
  - name: Prompts
    description: The measurement prompt set.
  - name: Recommendations
    description: Recommendation board and guarded lifecycle transitions.
  - name: Reports
    description: Stable report identities and the report catalog.
  - name: Scores & metrics
    description: GEO score, scoreboard, metrics, timeseries and SEO.
  - name: Credits & billing
    description: Micro-USD credits, top-ups and Stripe checkout.
  - name: Team
    description: Members, roles and invitations.
  - name: Chat
    description: The workspace assistant (SSE) and its threads.
  - name: Webhooks
    description: Inbound webhooks.
paths:
  /api/v1/workspaces/{workspace}/runs:
    post:
      tags:
        - Runs
      summary: Start a workspace run
      operationId: startWorkspaceRun
      parameters:
        - name: workspace
          in: path
          required: true
          schema:
            type: string
            pattern: ^[a-z0-9-]+$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartRun'
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStatus'
      security:
        - cookieAuth: []
        - bearerAuth:
            - runs:write
components:
  schemas:
    StartRun:
      type: object
      properties:
        preset:
          type: string
          enum:
            - standard
            - lite
            - smoke
            - exa
        idempotencyKey:
          type: string
          minLength: 1
          maxLength: 200
      required:
        - preset
      additionalProperties: false
    JobStatus:
      type: object
      properties:
        id:
          type: string
        brand:
          type: string
        kind:
          type: string
        pid:
          type: integer
          exclusiveMinimum: true
          minimum: 0
        logPath:
          type: string
        startedAt:
          type: string
        finishedAt:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - running
            - succeeded
            - failed
            - cancelled
        progress:
          type: object
          properties:
            completedCalls:
              type: integer
              nullable: true
            totalCalls:
              type: integer
              nullable: true
            percent:
              type: number
              minimum: 0
              maximum: 100
            source:
              type: string
              enum:
                - calls
                - bytes
          required:
            - completedCalls
            - totalCalls
            - percent
            - source
          additionalProperties: false
        lastLines:
          type: array
          items:
            type: string
      required:
        - id
        - brand
        - kind
        - pid
        - logPath
        - startedAt
        - finishedAt
        - status
        - progress
        - lastLines
      additionalProperties: false
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: geo.session
      description: Signed HttpOnly browser session cookie
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: gp_live_<43 base64url characters>
      description: Workspace-bound machine API key

````