Cube Dev Embed API

openapi: 3.2.0
info:
  title: Cube Dev Embed API
  version: '2026-10-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-11: 23 operation(s) read from 8 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Cube Dev has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 15
    documentation: 8
    pages-with-code: 8
    pages-read: 8
  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://docs.cube.dev/reference/cli.md
  - https://docs.cube.dev/reference/control-plane-api
  - https://docs.cube.dev/reference/control-plane-api.md
  - https://docs.cube.dev/reference/core-data-apis/sql-api
  - https://docs.cube.dev/reference/core-data-apis/rest-api
  - https://docs.cube.dev/reference/embed-apis/generate-session
  - https://docs.cube.dev/reference/embed-apis/dashboard-comments
  - https://docs.cube.dev/reference/embed-apis/generate-session.md
servers:
- url: https://YOUR_CUBE_CLOUD_HOST
security:
- bearer: []
tags:
- name: Embed
paths:
  /api/v1/embed/dashboard/{publicid}/comments:
    get:
      operationId: get_api_v1_embed_dashboard_publicid_comments
      tags:
      - Embed
      summary: GET /api/v1/embed/dashboard/{publicId}/comments
      x-source: https://docs.cube.dev/reference/embed-apis/dashboard-comments
      parameters:
      - name: publicid
        in: path
        required: true
        schema:
          type: string
      - name: first
        in: query
        required: false
        schema:
          type: string
      - name: includeResolved
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl \"https://your-account.cubecloud.dev/api/v1/embed/dashboard/PUBLIC_ID/comments?includeResolved=true&first=20\"  -H \"Authorization: Embed-Token YOUR_EMBED_TOKEN\" \n ​ Errors \n Status When 400 Replying to a reply, resolving a reply’s id, a body that is empty or over 10,000 characters, or a query parameter out of range — search over 255 characters, first below 1. 401 The Embed-Token is invalid or e"
  /api/v1/embed/generate-session:
    post:
      operationId: post_api_v1_embed_generate_session
      tags:
      - Embed
      summary: POST /api/v1/embed/generate-session
      x-source: https://docs.cube.dev/reference/embed-apis/generate-session
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1EmbedGenerateSessionRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://your-account.cubecloud.dev/api/v1/embed/generate-session\"  -H \"Content-Type: application/json\"  -H \"Authorization: Api-Key YOUR_API_KEY\"  -d '{ \n \"deploymentId\": 32, \n \"externalId\": \"user@example.com\", \n \"userAttributes\": [ \n {\"name\": \"department\", \"value\": \"Sales\"} \n ], \n \"groups\": [\"analysts\"] \n }' \n Use session ID in signed embedding . \n ​ Revoke a session \n POST https://{"
  /api/v1/embed/session/{sessionid}:
    post:
      operationId: post_api_v1_embed_session_sessionid
      tags:
      - Embed
      summary: POST /api/v1/embed/session/revoke
      x-source: https://docs.cube.dev/reference/embed-apis/generate-session
      parameters:
      - name: sessionid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1EmbedSessionSessionidRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://your-account.cubecloud.dev/api/v1/embed/session/revoke\"  -H \"Content-Type: application/json\"  -H \"Authorization: Api-Key YOUR_API_KEY\"  -d '{ \"sessionId\": \"abc123def456...\" }' \n Returns 204 No Content on success, with no body. \n It requires an admin principal — an API key, embed JWT, or bearer token belonging\nto an admin user. \n Unlike Generate Session, an API key’s scope is "
        collapsed_from: 2 example path(s) differing only at sessionId
components:
  schemas:
    PostApiV1EmbedSessionSessionidRequest:
      type: object
      properties:
        sessionId:
          type: string
    PostApiV1EmbedGenerateSessionRequest:
      type: object
      properties:
        deploymentId:
          type: integer
        externalId:
          type: string
        userAttributes:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              value:
                type: string
        groups:
          type: array
          items:
            type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer