> ## Documentation Index > Fetch the complete documentation index at: https://docs.withsplendor.com/llms.txt > Use this file to discover all available pages before exploring further. # Get dataset schema > Returns the fields Splendor has inferred for a dataset, including their types and indexing. Use the schema to learn which fields you can filter, aggregate, and project in SQL search. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/datasets/{dataset_id}/schema openapi: 3.1.0 info: description: >- Splendor is a search and retrieval API for your operational data. Ingest datasets — logs, documents, and structured records — and query them through one consistent interface that spans full-text, SQL, and semantic (vector) search. Every request authenticates with a bearer token and selects a workspace with the `X-Splendor-Tenant-Id` header. Read and query operations are available to any member; operations that create, change, or delete data require an admin role. All search modes return one shared envelope, and every result carries provenance back to the exact source object it came from. title: Splendor API version: 1.0.0 servers: - description: Production url: https://api.withsplendor.com security: - bearerAuth: [] tags: - description: Resolve the authenticated user and the tenants they can access. name: Identity - description: >- Build on Splendor as a platform: authenticate with a platform API key to provision an isolated tenant per end-customer and manage your platform keys. name: Platform - description: >- List datasets, inspect inferred schemas and readiness, and manage dataset lifecycle including deletion and schema rebuilds. name: Datasets & schema - description: >- Run full-text, SQL, and semantic search over your datasets, stream results, and resolve object media. name: Search & query - description: Save queries and materialize result sets for repeatable analysis. name: Views - description: >- Define named, versioned, parameterized SQL queries and manage their versions. name: Query Endpoints - description: Create and manage asynchronous exports of search results. name: Exports - description: >- Configure data sources, upload data through hosted multipart uploads, stream logs, and track ingest runs. name: Sources & ingest - description: >- Connect third-party systems by managing connector instances in the selected tenant. name: Connectors - description: Define and test detection rules that run against incoming data. name: Detections - description: Inspect discovered fields and promote them to fast, aggregatable fields. name: Fields - description: >- Operational visibility and recovery: audit logs, usage, dead-letter queue, reindex jobs, and data-deletion jobs. name: Operations paths: /v1/datasets/{dataset_id}/schema: get: tags: - Datasets & schema summary: Get dataset schema description: >- Returns the fields Splendor has inferred for a dataset, including their types and indexing. Use the schema to learn which fields you can filter, aggregate, and project in SQL search. operationId: getDatasetSchema parameters: - in: path name: dataset_id required: true schema: title: Dataset Id type: string - $ref: '#/components/parameters/SplendorTenantId' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DatasetSchemaResponse' description: Successful Response '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': content: application/json: schema: $ref: '#/components/schemas/ApiError' description: The requested resource was not found. '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error components: parameters: SplendorTenantId: description: Selects the tenant (workspace) the request acts within. in: header name: x-splendor-tenant-id required: true schema: type: string schemas: DatasetSchemaResponse: example: analyzer_version: v3 dataset_id: app-logs exact_shape_count: 3 generated_at: '2026-01-15T09:30:00Z' object_families: - document_count: 1240000 object_type_id: log_event observed_variants: - document_count: 1240000 schema: latency_ms: i64 message: text shape_hash: a1b2c3 schema: latency_ms: i64 message: text shape_hashes: - a1b2c3 revision: 4 total_document_count: 1240000 properties: analyzer_version: title: Analyzer Version type: string dataset_id: title: Dataset Id type: string exact_shape_count: title: Exact Shape Count type: integer generated_at: anyOf: - format: date-time type: string - type: 'null' title: Generated At object_families: items: $ref: '#/components/schemas/DatasetSchemaObjectFamilyItem' title: Object Families type: array revision: title: Revision type: integer total_document_count: title: Total Document Count type: integer required: - dataset_id - analyzer_version - revision - total_document_count - exact_shape_count - generated_at - object_families title: DatasetSchemaResponse type: object ApiError: description: >- Error envelope returned by every Splendor API endpoint. ``detail`` is either a plain message string (most errors) or a structured ``{code, message}`` object (validation and capacity errors that carry a stable machine-readable code). examples: - detail: Dataset not found - detail: code: semantic_search_capacity_exhausted message: Semantic search capacity is temporarily exhausted; retry shortly. properties: detail: anyOf: - type: string - $ref: '#/components/schemas/ErrorBody' title: Detail required: - detail title: ApiError type: object HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' title: Detail type: array title: HTTPValidationError type: object DatasetSchemaObjectFamilyItem: properties: document_count: title: Document Count type: integer object_type_id: title: Object Type Id type: string observed_variants: items: $ref: '#/components/schemas/DatasetSchemaVariantItem' title: Observed Variants type: array schema: additionalProperties: true title: Schema type: object shape_hashes: items: type: string title: Shape Hashes type: array required: - object_type_id - schema - document_count - shape_hashes - observed_variants title: DatasetSchemaObjectFamilyItem type: object ErrorBody: description: Structured error detail returned by validation and capacity errors. examples: - code: semantic_query_text_required message: Semantic vector search requires non-empty text. properties: code: title: Code type: string message: title: Message type: string required: - code - message title: ErrorBody type: object ValidationError: properties: ctx: title: Context type: object input: title: Input loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Error Type type: string required: - loc - msg - type title: ValidationError type: object DatasetSchemaVariantItem: properties: document_count: title: Document Count type: integer schema: additionalProperties: true title: Schema type: object shape_hash: title: Shape Hash type: string required: - shape_hash - document_count - schema title: DatasetSchemaVariantItem type: object responses: Unauthorized: content: application/json: schema: $ref: '#/components/schemas/ApiError' description: The bearer token is missing, malformed, or expired. Forbidden: content: application/json: schema: $ref: '#/components/schemas/ApiError' description: The token lacks access to the tenant or the role required. securitySchemes: bearerAuth: bearerFormat: JWT description: API token issued from the Splendor console. scheme: bearer type: http ````