> ## 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.

# Get snippet details

> Returns a snippet including its code and display type.



## OpenAPI

````yaml /openapi-public.json get /snippets/{id}
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:
  /snippets/{id}:
    get:
      tags:
        - Snippets
      summary: Get snippet details
      description: Returns a snippet including its code and display type.
      operationId: snippets.get
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 54
            description: Snippet ID
          required: true
          description: Snippet ID
          name: id
          in: path
      responses:
        '200':
          description: Snippet details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Snippet'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    Snippet:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 54
          example: snp_j572abc123def456
        html_url:
          type: string
          maxLength: 2048
          format: uri
          description: Absolute dashboard URL for this resource. OUTPUT_ONLY.
          example: https://akua.dev/dashboards/snippets/snp_j572abc123def456
        name:
          type: string
          example: Cluster Resource Audit
        description:
          type:
            - string
            - 'null'
          example: Checks resource requests and limits
        code:
          type: string
          example: async () => { ... }
          description: >-
            Async JavaScript function body executed in a sandboxed runtime. Has
            access to platform.request() for API calls.
        display_type:
          type: string
          enum:
            - table
            - stat
            - json
            - logs
            - timeseries
          description: Controls how the snippet result is rendered in dashboard widgets
          example: table
        visibility:
          type: string
          enum:
            - workspace
            - session
          description: >-
            Whether the snippet is reusable workspace state or scoped to an
            agent session.
        origin:
          type: string
          enum:
            - user
            - agent
            - system
          description: Who authored the snippet descriptor.
        agent_session_id:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 54
        agent_turn_id:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 54
        purpose:
          type: string
          enum:
            - general
            - prepared_action
            - reactive_read
            - widget
        workspace_id:
          type: string
          minLength: 1
          maxLength: 53
          example: ws_j572abc123def456
        created_by:
          type: string
          description: User ID of the snippet creator
        created_at:
          type: integer
          minimum: 0
          description: Unix timestamp (seconds)
        updated_at:
          type: integer
          minimum: 0
          description: Unix timestamp (seconds)
        etag:
          type: string
      required:
        - id
        - html_url
        - name
        - description
        - code
        - display_type
        - visibility
        - origin
        - agent_session_id
        - agent_turn_id
        - purpose
        - workspace_id
        - created_by
        - created_at
        - updated_at
        - etag
    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
    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
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at
        https://akua.dev/developers/api-tokens

````