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

# Run dashboard view

> Runs one view of the dashboard — what a click opens in a drawer or a modal — and answers when it is over. A data view (`kind` table | stats | chart) runs its sources with the `context` the trigger resolved (plus the page's current `filters`) and returns the component to draw. A form view runs its declared tool ONCE with the submitted `values` (the fields of its `schema`) and its fixed parameters, and returns the tool's output; the page then refreshes the dashboard (`on_success`). A thread view with a `reply_tool` runs it the same way with `values: { <reply_field>: text }`; a read-only thread view answers 400 (the page renders it from GET /v1/messages). No model runs. A session token runs with its user's credentials; an API key names the user with X-User-Id. The run is listed under the dashboard's workflow like a refresh.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/dashboards/{id}/views/{viewId}/run
openapi: 3.1.0
info:
  title: Sidenet API
  version: 1.0.0
  description: >-
    Sidenet HTTP endpoints exposed by the Sidenet Studio. All routes require an
    api key that can be generated through the studio in studio.sidenet.ai.
servers:
  - url: https://api.sidenet.ai
security:
  - bearerAuth: []
paths:
  /v1/dashboards/{id}/views/{viewId}/run:
    post:
      tags:
        - Dashboards
      summary: Run dashboard view
      description: >-
        Runs one view of the dashboard — what a click opens in a drawer or a
        modal — and answers when it is over. A data view (`kind` table | stats |
        chart) runs its sources with the `context` the trigger resolved (plus
        the page's current `filters`) and returns the component to draw. A form
        view runs its declared tool ONCE with the submitted `values` (the fields
        of its `schema`) and its fixed parameters, and returns the tool's
        output; the page then refreshes the dashboard (`on_success`). A thread
        view with a `reply_tool` runs it the same way with `values: {
        <reply_field>: text }`; a read-only thread view answers 400 (the page
        renders it from GET /v1/messages). No model runs. A session token runs
        with its user's credentials; an API key names the user with X-User-Id.
        The run is listed under the dashboard's workflow like a refresh.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: viewId
          in: path
          required: true
          schema:
            type: string
          description: The view id (`spec.views[].id`).
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                context:
                  type: object
                  additionalProperties: true
                  description: >-
                    The view's context keys, resolved from the click (e.g. `{
                    "id": "b-42" }`).
                  example:
                    id: b-42
                values:
                  type: object
                  additionalProperties: true
                  description: >-
                    Form views: the submitted field values (validated against
                    the view's `schema`).
                  example:
                    arrival: '2026-11-02'
                    notes: Late check-in
                filters:
                  type: object
                  additionalProperties: true
                  description: >-
                    The page's current filter values (presets allowed); the
                    dashboard defaults when omitted.
      responses:
        '200':
          description: The view ran
          content:
            application/json:
              schema:
                type: object
                properties:
                  run_id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - succeeded
                      - failed
                  error:
                    type: string
                    nullable: true
                  component:
                    type: object
                    nullable: true
                    description: >-
                      Data views: the rendered payload, in the chat tool-call
                      part shape (`{ toolCallId, toolName, args, result }`).
                  result:
                    description: 'Form views: the tool''s output.'
        '404':
          description: Dashboard or view not found
        '409':
          description: No active version
        '422':
          description: The context or values do not fit the view
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  issues:
                    type: array
                    items:
                      type: object
                      properties:
                        path:
                          type: string
                        message:
                          type: string
      security:
        - bearerAuth: []
        - sessionToken: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Organization API key, generated in studio.sidenet.ai. Backend only —
        never in a browser.
    sessionToken:
      type: http
      scheme: bearer
      description: >-
        Session token (`snat_…`) minted by POST /v1/token. Carries the
        organization and the end user; safe in a browser.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.