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

# List workspace snippet runs

> Returns durable snippet execution activity for the selected workspace, newest first.



## OpenAPI

````yaml /openapi-public.json get /snippet_runs
openapi: 3.1.0
info:
  title: Akua API
  version: 1.0.0
  description: >-
    Public API for managing Akua workspaces, clusters, products, and installs.


    Authenticate with a workspace API token via the `Authorization: Bearer
    sk_akua_...` header.


    A workspace-owned token implies its workspace. Broad tokens select the
    active workspace via the optional `Akua-Context` header.
  contact:
    name: Akua API support
    email: support@akua.dev
    url: https://akua.dev/docs
servers:
  - url: https://api.akua.dev/v1
    description: Production
security: []
tags:
  - name: Auth
    description: Authentication and token management.
  - name: Agents
    description: Agent identities and configuration.
  - name: Agent sessions
    description: Durable agent conversations and tasks.
  - name: Agent turns
    description: Submitted agent work and event emission.
  - name: Agent events
    description: Normalized agent event history and streams.
  - name: Custom domains
    description: Workspace custom domains and routing targets.
  - name: Cloudflare
    description: Cloudflare account credentials and gateway control.
  - name: Clusters
    description: Kubernetes clusters and cluster access operations.
  - name: ComputeConfigs
    description: Workspace compute provider configurations.
  - name: Entitlements
    description: Effective workspace capabilities and limits.
  - name: Dashboards
    description: Dashboard and widget resources.
  - name: Installs
    description: Installation and render operations.
  - name: Machines
    description: Compute machines and lifecycle events.
  - name: Notifications
    description: User notification state.
  - name: Offer Channels
    description: Private offer channels and policy versions.
  - name: Offers
    description: Marketplace offers and redemption tracking.
  - name: Operations
    description: Long-running operation status and controls.
  - name: Order Drafts
    description: Draft checkout orders and checkout sessions.
  - name: Organizations
    description: Organizations, memberships, and managed workspaces.
  - name: Packages
    description: Software packages, versions, and input schemas.
  - name: Products
    description: Marketplace product catalog resources.
  - name: Preview hostnames
    description: Install preview hostnames and routing state.
  - name: Quotas
    description: Workspace quota limits and usage.
  - name: Regions
    description: Available deployment regions.
  - name: Registry
    description: Container registry credentials and repositories.
  - name: Repository change requests
    description: Fork-backed repository change reviews and lifecycle actions.
  - name: Repositories
    description: Source repositories available to the workspace.
  - name: Secrets
    description: Workspace secrets and secret versions.
  - name: Snippets
    description: Reusable snippets and snippet runs.
  - name: Workspace subdomains
    description: Workspace subdomain identity.
  - name: Workspaces
    description: Workspace resources, members, and billing state.
paths:
  /snippet_runs:
    get:
      tags:
        - Snippet Runs
      summary: List workspace snippet runs
      description: >-
        Returns durable snippet execution activity for the selected workspace,
        newest first.
      operationId: snippetRuns.list
      parameters:
        - schema:
            type: string
            description: Pagination cursor from a previous response's `next_cursor`.
          required: false
          description: Pagination cursor from a previous response's `next_cursor`.
          name: cursor
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
            description: Items per page (1-100, default 50)
            example: 50
          required: false
          description: Items per page (1-100, default 50)
          name: limit
          in: query
        - schema:
            type: string
            enum:
              - succeeded
              - failed
              - timed_out
          required: false
          name: state
          in: query
        - schema:
            type: string
            enum:
              - manual
              - dashboard_open
              - dashboard_refresh
              - agent
          required: false
          name: source
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 54
          required: false
          name: snippet
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 55
          required: false
          name: dashboard
          in: query
        - schema:
            type: string
            enum:
              - basic
              - full
            default: basic
            description: Control whether output and error details are included.
          required: false
          description: Control whether output and error details are included.
          name: view
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 53
            description: >-
              Optional workspace/scope context for the request. Carries a single
              workspace wire id (`ws_…`) today. Only needed for broad tokens — a
              workspace-owned token implies its workspace.
            example: ws_j572abc123def456
          required: false
          description: >-
            Optional workspace/scope context for the request. Carries a single
            workspace wire id (`ws_…`) today. Only needed for broad tokens — a
            workspace-owned token implies its workspace.
          name: akua-context
          in: header
      responses:
        '200':
          description: Workspace snippet-run history
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnippetRunList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    SnippetRunList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SnippetRun'
        has_more:
          type: boolean
          description: True if more items exist after this page.
        next_cursor:
          type:
            - string
            - 'null'
          description: Opaque cursor for the next page, or null if no more pages.
      required:
        - data
        - has_more
        - next_cursor
    ApiErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ApiErrorEntry'
        result:
          type: object
          properties: {}
          description: Always empty for error responses
      required:
        - success
        - errors
        - result
    SnippetRun:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 54
        snippet_id:
          type: string
          minLength: 1
          maxLength: 54
        source:
          type: string
          enum:
            - manual
            - dashboard_open
            - dashboard_refresh
            - agent
          description: Origin that initiated the persisted snippet run.
        snippet_name:
          type: string
        snippet_etag:
          type: string
        dashboard_id:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 55
        dashboard_name:
          type:
            - string
            - 'null'
        widget_id:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 54
        widget_title:
          type:
            - string
            - 'null'
        run_by:
          type: string
        agent_session_id:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 54
        agent_turn_id:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 54
        state:
          type: string
          enum:
            - succeeded
            - failed
            - timed_out
          description: Terminal run state in past participle form.
        overrides:
          type: object
          additionalProperties: {}
          description: >-
            Legacy execution metadata retained for compatibility. It is not
            applied as runtime input.
        output: {}
        error:
          $ref: '#/components/schemas/SnippetRunError'
        duration_ms:
          type: number
        stats:
          type: object
          properties:
            cpu_time_ms:
              type: number
            wall_time_ms:
              type: number
            heap_used_bytes:
              type: number
          required:
            - cpu_time_ms
            - wall_time_ms
            - heap_used_bytes
        created_at:
          type: integer
          minimum: 0
          description: Unix timestamp (seconds)
        etag:
          type: string
      required:
        - id
        - snippet_id
        - source
        - snippet_name
        - snippet_etag
        - dashboard_id
        - dashboard_name
        - widget_id
        - widget_title
        - run_by
        - agent_session_id
        - agent_turn_id
        - state
        - duration_ms
        - stats
        - created_at
        - etag
    ApiErrorEntry:
      type: object
      properties:
        code:
          type: integer
          example: 7002
          description: Machine-readable error code
        message:
          type: string
          example: Resource not found
          description: Human-readable error message
        path:
          type: array
          items:
            type: string
          example:
            - body
            - name
          description: Field path that caused the error, when applicable
        metadata:
          type: object
          additionalProperties:
            type: string
      required:
        - code
        - message
    SnippetRunError:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        details: {}
      required:
        - code
        - message
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at
        https://akua.dev/developers/api-tokens

````