> ## 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. # Translate SQL > Validates a SQL query against a dataset's schema and returns its translated form without executing it. Use this to check a query and surface errors before running it with SQL search. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/sql/translate 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/sql/translate: post: tags: - Search & query summary: Translate SQL description: >- Validates a SQL query against a dataset's schema and returns its translated form without executing it. Use this to check a query and surface errors before running it with SQL search. operationId: translateSql parameters: - $ref: '#/components/parameters/SplendorTenantId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SqlSearchRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SqlTranslateResponse' description: Successful Response '400': content: application/json: schema: $ref: '#/components/schemas/ApiError' description: The request is invalid. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '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: SqlSearchRequest: properties: cursor: anyOf: - minLength: 1 type: string - type: 'null' title: Cursor dataset_scope: default: selected enum: - selected - all title: Dataset Scope type: string datasets: items: type: string title: Datasets type: array limit: default: 100 maximum: 1000 minimum: 0 title: Limit type: integer sql: anyOf: - minLength: 1 type: string - type: 'null' title: Sql view_id: anyOf: - minLength: 1 type: string - type: 'null' title: View Id title: SqlSearchRequest type: object SqlTranslateResponse: example: aggregations: [] dsl: max_hits: 20 query: term: status: error group_by_fields: [] is_aggregation: false limit_source: sql selected_fields: - logical: status physical: status_keyword type: keyword sort_fields: [] used_fields: - logical: status physical: status_keyword type: keyword warnings: [] properties: aggregations: items: type: string title: Aggregations type: array dsl: additionalProperties: true title: Dsl type: object group_by_fields: items: $ref: '#/components/schemas/SqlFieldReference' title: Group By Fields type: array is_aggregation: default: false title: Is Aggregation type: boolean limit_source: enum: - default - sql title: Limit Source type: string selected_fields: items: $ref: '#/components/schemas/SqlFieldReference' title: Selected Fields type: array sort_fields: items: $ref: '#/components/schemas/SqlFieldReference' title: Sort Fields type: array used_fields: items: $ref: '#/components/schemas/SqlFieldReference' title: Used Fields type: array warnings: items: type: string title: Warnings type: array required: - dsl - limit_source title: SqlTranslateResponse 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 SqlFieldReference: properties: logical: title: Logical type: string physical: title: Physical type: string type: enum: - text - keyword - i64 - f64 - datetime - bool - ip title: Type type: string required: - logical - physical - type title: SqlFieldReference 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 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 ````