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

# Preview SQL

> Preview the results of a SQL query.
The query runs as the current user impersonated in Trino.

**Required roles**: `nx1_semantic_modeller` or `nx1_semantic_admin`



## OpenAPI

````yaml post /api/semantic-models/sql/preview
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/semantic-models/sql/preview:
    post:
      tags:
        - Semantic models
      summary: Preview SQL
      description: |-
        Preview the results of a SQL query.
        The query runs as the current user impersonated in Trino.

        **Required roles**: `nx1_semantic_modeller` or `nx1_semantic_admin`
      operationId: preview_sql_api_semantic_models_sql_preview_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SQLPreviewRequest'
        required: true
      responses:
        '200':
          description: SQL preview results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SQLPreviewResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    SQLPreviewRequest:
      properties:
        sql:
          type: string
          title: Sql
          description: SQL query to preview.
        limit:
          type: integer
          maximum: 1000
          minimum: 1
          title: Limit
          description: Row limit.
          default: 50
      type: object
      required:
        - sql
      title: SQLPreviewRequest
      description: Request to preview SQL execution.
    SQLPreviewResponse:
      properties:
        columns:
          items:
            type: string
          type: array
          title: Columns
        rows:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Rows
        row_count:
          type: integer
          title: Row Count
        truncated:
          type: boolean
          title: Truncated
          description: Whether results were truncated.
          default: false
      type: object
      required:
        - columns
        - rows
        - row_count
      title: SQLPreviewResponse
      description: Response from SQL preview.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````