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

# artifactDataPreview

> Preview the data backing an artifact (first N rows after the header).
`limit` is optional and capped server-side to 500.



## OpenAPI

````yaml /api-reference/openapi.json get /api/artifacts/{artifactId}/data-preview
openapi: 3.0.3
info:
  title: Parable API
  description: >-
    The REST API for your Parable workspace: manage connectors and taps, explore
    your data catalog, upload artifacts, and administer users and roles.
  version: v1
servers:
  - url: https://api.askparable.com
    description: Production
security: []
paths:
  /api/artifacts/{artifactId}/data-preview:
    get:
      tags:
        - artifacts
      summary: artifactDataPreview
      description: |-
        Preview the data backing an artifact (first N rows after the header).
        `limit` is optional and capped server-side to 500.
      operationId: ArtifactsArtifactDataPreviewHandler
      parameters:
        - description: >-
            Workspace slug. Overrides subdomain-based workspace resolution when
            provided.
          in: header
          name: X-Tenant
          required: false
          schema:
            example: acme
            type: string
        - description: Optional request correlation ID echoed back in the response.
          in: header
          name: X-Request-ID
          required: false
          schema:
            example: 550e8400-e29b-41d4-a716-446655440000
            format: uuid
            type: string
        - description: artifactId parameter
          in: path
          name: artifactId
          required: true
          schema:
            description: UUID v4 with automatic base62 encoding for client-facing APIs
            type: string
        - in: query
          name: limit
          required: false
          schema:
            format: double
            type: number
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/ArtifactDataPreview'
                  links:
                    $ref: '#/components/schemas/ResponseLinks'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                  - data
                  - meta
                type: object
          description: Successful response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      security:
        - bearerAuth: []
components:
  schemas:
    ArtifactDataPreview:
      description: |-
        Server-side preview of the data backing an artifact, used by the schema
        editor. The schema describing the row shape is returned alongside the
        data so consumers can render without a separate fetch.
      properties:
        inference:
          $ref: '#/components/schemas/ArtifactInference'
          description: >-
            Persisted inference results for the artifact, when available. The

            embedded `schema` is the same `Parable_Schema` returned at the top

            level (i.e. `inference.schema == schema` when both are present), so

            the schema editor can be driven from a single shape. `model` is
            empty

            and the token counts are zero because those are inference-call-time

            signals and are not persisted with the artifact. Null when the

            artifact has no persisted `dataSchema` or when no inference metadata

            was captured (e.g. artifacts predating EDR-0021 Phase 1).
        rows:
          description: |-
            Preview rows, each conforming to `schema`. Capped server-side to 500
            rows.
          items:
            description: A Parable Schema in JSON
            type: object
          type: array
        schema:
          description: |-
            Schema describing each row (matches `TenantArtifact.dataSchema`).
            When the artifact has a persisted `dataSchema` this is that schema;
            otherwise the server synthesizes an all-String fallback so the row
            table is always renderable.
          type: object
        truncated:
          description: True when the underlying artifact has more rows than were returned.
          type: boolean
      required:
        - schema
        - rows
        - truncated
      type: object
    ResponseLinks:
      properties:
        first:
          nullable: true
          type: string
        last:
          nullable: true
          type: string
        next:
          nullable: true
          type: string
        prev:
          nullable: true
          type: string
      type: object
    ResponseMeta:
      properties:
        requestId:
          description: Unique identifier for the request
          type: string
        totalCount:
          description: Total count of items for paginated responses
          nullable: true
          type: integer
      required:
        - requestId
      type: object
    Error:
      properties:
        error:
          type: string
      type: object
    ArtifactInference:
      description: |-
        Schema inference output for an uploaded artifact. The inferred schema is
        returned as a first-class `Parable_Schema` (the same shape that lives on
        the persisted `TenantArtifact.dataSchema`). Per-column inference signal
        that does not belong inside the schema itself (confidence, demotion,
        sample failure stats) lives in `columnMetadata`, keyed by `fieldPath` to
        the matching `FieldDef` in the schema.
      properties:
        columnMetadata:
          description: >-
            Per-column inference signal. Each entry references a field in
            `schema`

            via its `fieldPath` (e.g. "Inferred.email").
          items:
            $ref: '#/components/schemas/ArtifactInferenceColumnMetadata'
          type: array
        model:
          description: Provider model identifier used for inference.
          type: string
        schema:
          description: |-
            The inferred schema. Field rationale from the model is folded into
            `FieldDef.description` so the schema is self-documenting.
          type: object
        tokenInputCount:
          description: Input tokens consumed by the inference call.
          format: int64
          type: integer
        tokenOutputCount:
          description: Output tokens produced by the inference call.
          format: int64
          type: integer
      required:
        - schema
        - columnMetadata
        - model
        - tokenInputCount
        - tokenOutputCount
      type: object
    ArtifactInferenceColumnMetadata:
      description: |-
        Per-column inference signal that is not encoded in the `Parable_Schema`
        itself. Linked back to the schema via `fieldPath`.
      properties:
        confidence:
          $ref: '#/components/schemas/ArtifactInferenceConfidenceEnum'
          description: Inferer's reported confidence for this column.
        demoted:
          description: |-
            True if the column was demoted by post-validation (model proposed a
            scalar that the sample data did not satisfy).
          type: boolean
        fieldPath:
          description: >-
            Path to the matching `FieldDef` in the inferred schema, formatted as

            "{typeName}.{fieldName}" (e.g. "Inferred.email"). Stable identifier
            the

            editor uses to merge this metadata with the schema.
          type: string
        firstSampleError:
          description: First sample-validation error message, when one occurred.
          type: string
        sampleFailures:
          description: Number of sample values that failed validation.
          format: int64
          type: integer
        sampleSeen:
          description: Number of sample values evaluated against the chosen type.
          format: int64
          type: integer
      required:
        - fieldPath
        - confidence
        - demoted
        - sampleSeen
        - sampleFailures
      type: object
    ArtifactInferenceConfidenceEnum:
      description: Confidence level reported by schema inference for a single column.
      enum:
        - low
        - medium
        - high
      type: string
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````