# Splendor

## Docs

- [Complete Airbyte OAuth](https://docs.withsplendor.com/api-reference/connectors-&-airbyte/complete-airbyte-oauth.md): Completes an OAuth flow for an Airbyte source. Requires an admin role.
- [Create a connector](https://docs.withsplendor.com/api-reference/connectors-&-airbyte/create-a-connector.md): Creates a connector instance for a third-party system. Requires an admin role.
- [Create an Airbyte connection](https://docs.withsplendor.com/api-reference/connectors-&-airbyte/create-an-airbyte-connection.md): Creates the Airbyte connection that maps a provisioned source to a Splendor destination. Requires an admin role.
- [Create an Airbyte source](https://docs.withsplendor.com/api-reference/connectors-&-airbyte/create-an-airbyte-source.md): Begins onboarding an Airbyte-backed source. Returns the source so you can provision credentials and create a connection. Requires an admin role.
- [Delete a connector](https://docs.withsplendor.com/api-reference/connectors-&-airbyte/delete-a-connector.md): Deletes a connector instance. Requires an admin role.
- [Discover an Airbyte schema](https://docs.withsplendor.com/api-reference/connectors-&-airbyte/discover-an-airbyte-schema.md): Runs Airbyte schema discovery for a provider and returns the streams and fields it exposes, so you can configure a connection. Requires an admin role.
- [Enqueue ingest from an Airbyte sync](https://docs.withsplendor.com/api-reference/connectors-&-airbyte/enqueue-ingest-from-an-airbyte-sync.md): Enqueues a Splendor ingest job from the data produced by a completed Airbyte sync. Requires an admin role.
- [Get a connector](https://docs.withsplendor.com/api-reference/connectors-&-airbyte/get-a-connector.md): Returns a connector instance's configuration.
- [List connector providers](https://docs.withsplendor.com/api-reference/connectors-&-airbyte/list-connector-providers.md): Lists the available connector provider definitions you can create connectors and Airbyte sources from.
- [List connectors](https://docs.withsplendor.com/api-reference/connectors-&-airbyte/list-connectors.md): Lists the connector instances configured in the selected tenant.
- [Provision an Airbyte source](https://docs.withsplendor.com/api-reference/connectors-&-airbyte/provision-an-airbyte-source.md): Provisions an Airbyte source for authentication, returning what the next step (such as an OAuth flow) requires. Requires an admin role.
- [Refresh an Airbyte run](https://docs.withsplendor.com/api-reference/connectors-&-airbyte/refresh-an-airbyte-run.md): Polls Airbyte and refreshes the stored status of a sync run. Requires an admin role.
- [Start an Airbyte sync](https://docs.withsplendor.com/api-reference/connectors-&-airbyte/start-an-airbyte-sync.md): Starts an Airbyte sync run for a source. Poll the run to follow its status. Requires an admin role.
- [Update a connector](https://docs.withsplendor.com/api-reference/connectors-&-airbyte/update-a-connector.md): Updates a connector instance's configuration. Requires an admin role.
- [Check readiness for many datasets](https://docs.withsplendor.com/api-reference/datasets-&-schema/check-readiness-for-many-datasets.md): Checks readiness for multiple datasets in one call, with optional filtering by status, lifecycle state, or identifier prefix. Use this to wait on a batch of datasets after ingesting.
- [Delete a dataset](https://docs.withsplendor.com/api-reference/datasets-&-schema/delete-a-dataset.md): Deletes a dataset and enqueues a managed data-deletion job that removes its records and indexed data. Returns the deletion job so you can track it to completion. Requires an admin role.
- [Get a schema rebuild job](https://docs.withsplendor.com/api-reference/datasets-&-schema/get-a-schema-rebuild-job.md): Returns the status and progress of a dataset schema rebuild job.
- [Get dataset readiness](https://docs.withsplendor.com/api-reference/datasets-&-schema/get-dataset-readiness.md): Reports which capabilities are available for a dataset yet: schema inference, text search, and semantic search. Ingestion and indexing are asynchronous, so poll readiness before relying on a search mode.
- [Get dataset schema](https://docs.withsplendor.com/api-reference/datasets-&-schema/get-dataset-schema.md): 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.
- [List datasets](https://docs.withsplendor.com/api-reference/datasets-&-schema/list-datasets.md): Lists the datasets in the selected tenant with their current state. Use a returned `dataset_id` to scope a search, export, or schema lookup.
- [Rebuild a dataset schema](https://docs.withsplendor.com/api-reference/datasets-&-schema/rebuild-a-dataset-schema.md): Triggers a job that re-infers a dataset's schema from its records. Use this after changing how data is parsed or when the schema has drifted. Returns the job to poll. Requires an admin role.
- [Create a detection](https://docs.withsplendor.com/api-reference/detections/create-a-detection.md): Creates a detection rule that evaluates incoming data and can notify a webhook on matches. Requires an admin role.
- [Delete a detection](https://docs.withsplendor.com/api-reference/detections/delete-a-detection.md): Deletes a detection rule. Requires an admin role.
- [Get a detection](https://docs.withsplendor.com/api-reference/detections/get-a-detection.md): Returns a detection rule's full definition, including its logic and notification configuration.
- [List detection runs](https://docs.withsplendor.com/api-reference/detections/list-detection-runs.md): Lists past executions of a detection rule with their outcomes.
- [List detections](https://docs.withsplendor.com/api-reference/detections/list-detections.md): Lists the detection rules configured in the selected tenant.
- [Test detection code](https://docs.withsplendor.com/api-reference/detections/test-detection-code.md): Dry-runs detection rule code against sample input and returns the result without creating or executing a rule. Use this to validate logic while authoring. Requires an admin role.
- [Update a detection](https://docs.withsplendor.com/api-reference/detections/update-a-detection.md): Updates a detection rule. Requires an admin role.
- [Create an export](https://docs.withsplendor.com/api-reference/exports/create-an-export.md): Starts an asynchronous export of a search's full result set. Returns the export job; poll it for status and the download location when complete. Use exports for exhaustive traversal of large result sets.
- [Delete an export](https://docs.withsplendor.com/api-reference/exports/delete-an-export.md): Deletes an export job and removes its stored artifact.
- [Get an export](https://docs.withsplendor.com/api-reference/exports/get-an-export.md): Returns an export job's status and, when complete, the details needed to download the exported artifact.
- [List exports](https://docs.withsplendor.com/api-reference/exports/list-exports.md): Lists the export jobs in the selected tenant with their status.
- [List fields](https://docs.withsplendor.com/api-reference/fields/list-fields.md): Lists the fields discovered across the tenant's datasets along with their indexing configuration.
- [Promote a field](https://docs.withsplendor.com/api-reference/fields/promote-a-field.md): Promotes a field to a fast, indexed field so it can be used efficiently in filters and aggregations. Requires an admin role.
- [Get current user](https://docs.withsplendor.com/api-reference/identity/get-current-user.md): Returns the authenticated user along with the tenants they can access and their role in each. Call this before selecting a tenant: use a returned `tenant_id` as the `X-Splendor-Tenant-Id` header on subsequent requests. Each tenant also reports its plan and whether role enforcement (RBAC) is enabled.
- [Cancel a reindex job](https://docs.withsplendor.com/api-reference/operations/cancel-a-reindex-job.md): Cancels an in-flight reindex job. Requires an admin role.
- [Create a reindex job](https://docs.withsplendor.com/api-reference/operations/create-a-reindex-job.md): Starts a job that reindexes a dataset. Returns the job so you can poll or cancel it. Requires an admin role.
- [Get a data-deletion job](https://docs.withsplendor.com/api-reference/operations/get-a-data-deletion-job.md): Returns the status of a managed data-deletion job.
- [Get a dead-letter failure](https://docs.withsplendor.com/api-reference/operations/get-a-dead-letter-failure.md): Returns the detail and error message for a dead-letter queue failure.
- [Get a reindex job](https://docs.withsplendor.com/api-reference/operations/get-a-reindex-job.md): Returns the status and progress of a reindex job.
- [Get usage metrics](https://docs.withsplendor.com/api-reference/operations/get-usage-metrics.md): Returns usage metrics for the tenant, such as API call and search volumes by mode.
- [List audit records](https://docs.withsplendor.com/api-reference/operations/list-audit-records.md): Lists audit log records for the selected tenant.
- [List data-deletion jobs](https://docs.withsplendor.com/api-reference/operations/list-data-deletion-jobs.md): Lists the managed data-deletion jobs in the selected tenant.
- [List dead-letter failures](https://docs.withsplendor.com/api-reference/operations/list-dead-letter-failures.md): Lists ingest and processing tasks that failed and landed in the dead-letter queue.
- [List reindex jobs](https://docs.withsplendor.com/api-reference/operations/list-reindex-jobs.md): Lists reindex jobs in the selected tenant with their status.
- [Retry a dead-letter failure](https://docs.withsplendor.com/api-reference/operations/retry-a-dead-letter-failure.md): Re-enqueues a failed task from the dead-letter queue. Requires an admin role.
- [Get a presigned object image URL](https://docs.withsplendor.com/api-reference/search-&-query/get-a-presigned-object-image-url.md): Returns a short-lived presigned URL for an object's image, for rendering previews of image results. The URL is scoped to the authenticated tenant.
- [Run a search](https://docs.withsplendor.com/api-reference/search-&-query/run-a-search.md): Runs a search over one or more datasets and returns the shared search envelope. Supports full-text queries, structured filters, time ranges, and aggregations; set `semantic` to true for vector search. The response includes a `search_id` handle for paging, export, or saving a view, and makes truncati…
- [Run a SQL search](https://docs.withsplendor.com/api-reference/search-&-query/run-a-sql-search.md): Executes a SQL query against the dataset's inferred schema and returns the shared search envelope. SQL responses add a `columns` list, and each result places its projected values in `row`. Supports cursor continuation.
- [Stream search results as JSONL](https://docs.withsplendor.com/api-reference/search-&-query/stream-search-results-as-jsonl.md): Streams every result for a search handle as newline-delimited JSON, one normalized result per line. Use this to pull a search's results into a script or notebook without paging by cursor.
- [Translate SQL](https://docs.withsplendor.com/api-reference/search-&-query/translate-sql.md): 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.
- [Abort a hosted upload](https://docs.withsplendor.com/api-reference/sources-&-ingest/abort-a-hosted-upload.md): Aborts an in-progress multipart upload session and discards its parts.
- [Complete a hosted upload](https://docs.withsplendor.com/api-reference/sources-&-ingest/complete-a-hosted-upload.md): Completes a multipart upload after all parts are uploaded and enqueues the uploaded object for ingestion. Track progress with the upload readiness endpoint or ingest runs.
- [Create a hosted source](https://docs.withsplendor.com/api-reference/sources-&-ingest/create-a-hosted-source.md): Creates a hosted source backed by Splendor-managed storage, which you load through the hosted upload flow. Requires an admin role.
- [Create a source](https://docs.withsplendor.com/api-reference/sources-&-ingest/create-a-source.md): Creates a data source that records can be ingested into. Requires an admin role.
- [Delete a hosted upload session](https://docs.withsplendor.com/api-reference/sources-&-ingest/delete-a-hosted-upload-session.md): Deletes a hosted upload session and its staged data. Requires an admin role.
- [Delete a source](https://docs.withsplendor.com/api-reference/sources-&-ingest/delete-a-source.md): Deletes a source. Requires an admin role.
- [Get a source](https://docs.withsplendor.com/api-reference/sources-&-ingest/get-a-source.md): Returns a source's configuration, including its type and ingest settings.
- [Get an ingest run](https://docs.withsplendor.com/api-reference/sources-&-ingest/get-an-ingest-run.md): Returns the progress and readiness detail for a single ingest run.
- [Get hosted upload readiness](https://docs.withsplendor.com/api-reference/sources-&-ingest/get-hosted-upload-readiness.md): Reports the processing and readiness status of a hosted upload session after completion.
- [Get hosted upload readiness (admin)](https://docs.withsplendor.com/api-reference/sources-&-ingest/get-hosted-upload-readiness-admin.md): Reports the processing and readiness status of a hosted upload session by its identifier.
- [Get source readiness](https://docs.withsplendor.com/api-reference/sources-&-ingest/get-source-readiness.md): Reports a source's ingest readiness status.
- [Ingest logs](https://docs.withsplendor.com/api-reference/sources-&-ingest/ingest-logs.md): Ingests structured log records into a source. Accepts a batch and returns `202 Accepted`; the records are processed asynchronously.
- [Initiate a hosted upload](https://docs.withsplendor.com/api-reference/sources-&-ingest/initiate-a-hosted-upload.md): Starts a multipart upload to a hosted source and returns an upload session. Follow with requests to sign parts, then complete the upload to enqueue ingestion.
- [List ingest runs](https://docs.withsplendor.com/api-reference/sources-&-ingest/list-ingest-runs.md): Lists ingest runs across the tenant's sources and datasets with their status and progress. Use this to confirm a load finished before querying it.
- [List sources](https://docs.withsplendor.com/api-reference/sources-&-ingest/list-sources.md): Lists the data sources configured in the selected tenant.
- [Revoke an ingest token](https://docs.withsplendor.com/api-reference/sources-&-ingest/revoke-an-ingest-token.md): Revokes a source's ingest token. Requires an admin role.
- [Rotate an ingest token](https://docs.withsplendor.com/api-reference/sources-&-ingest/rotate-an-ingest-token.md): Generates a new ingest token for a source, used to authenticate direct ingestion. Rotating replaces the previous token. Requires an admin role.
- [Sign upload parts](https://docs.withsplendor.com/api-reference/sources-&-ingest/sign-upload-parts.md): Returns presigned URLs for uploading parts of a multipart upload session. Upload each part directly to the returned URLs.
- [Update a hosted source](https://docs.withsplendor.com/api-reference/sources-&-ingest/update-a-hosted-source.md): Updates a hosted source's configuration. Requires an admin role.
- [Update a source](https://docs.withsplendor.com/api-reference/sources-&-ingest/update-a-source.md): Updates a source's configuration. Requires an admin role.
- [Create a cluster view](https://docs.withsplendor.com/api-reference/views/create-a-cluster-view.md): Builds a view by semantic clustering: provide seed queries and a similarity threshold, and Splendor groups records by closeness to those seeds. Use this to organize a large, fuzzy result space into coherent groups.
- [Create a view](https://docs.withsplendor.com/api-reference/views/create-a-view.md): Creates a view from exactly one source: an existing `from_search_id` handle or a full `search_request`. A view is either materialized (membership and rank frozen at creation) or live (the query re-runs on read). Use materialized views for deterministic, repeatable analysis.
- [Delete a view](https://docs.withsplendor.com/api-reference/views/delete-a-view.md): Deletes a view. The underlying records and search handle are not affected.
- [Get a view](https://docs.withsplendor.com/api-reference/views/get-a-view.md): Returns a view's metadata, including its kind, record count, and creation time.
- [Get view records](https://docs.withsplendor.com/api-reference/views/get-view-records.md): Returns the records in a view. For materialized views the set is fixed; for live views it reflects the current result of the saved query.
- [List views](https://docs.withsplendor.com/api-reference/views/list-views.md): Lists the views in the selected tenant with their kind and record count.
- [Rename a view](https://docs.withsplendor.com/api-reference/views/rename-a-view.md): Updates a view's display name. The view's records and query definition are unchanged.
- [Authentication](https://docs.withsplendor.com/authentication.md): Authenticate with a bearer token and select your tenant on every request.
- [Datasets & schema](https://docs.withsplendor.com/concepts/datasets.md): Datasets hold your ingested records and expose a queryable schema and readiness state.
- [Handles & cursors](https://docs.withsplendor.com/concepts/handles-and-cursors.md): Page, export, and re-run queries from a handle instead of copying results around.
- [Core concepts](https://docs.withsplendor.com/concepts/overview.md): The model behind every Splendor endpoint: tenancy, datasets, search, handles, views, and provenance.
- [Provenance](https://docs.withsplendor.com/concepts/provenance.md): Every result traces back to the exact source object and line it came from.
- [The search model](https://docs.withsplendor.com/concepts/search-model.md): One request envelope and one response envelope across text, SQL, and semantic search.
- [Tenancy & isolation](https://docs.withsplendor.com/concepts/tenancy.md): How Splendor scopes every request, handle, and record to a single tenant.
- [Views](https://docs.withsplendor.com/concepts/views.md): Save a query or freeze a result set for repeatable, shareable analysis.
- [Connect a source](https://docs.withsplendor.com/guides/connect-a-source.md): Pull data from a third-party system with an Airbyte-backed connector.
- [Create a view](https://docs.withsplendor.com/guides/create-a-view.md): Save a query or freeze a result set you can re-read and analyze.
- [Export results](https://docs.withsplendor.com/guides/export-results.md): Export a search's full result set and download it when ready.
- [Ingest a dataset](https://docs.withsplendor.com/guides/ingest-a-dataset.md): Create a hosted source and upload a file so its records become searchable.
- [Run a semantic search](https://docs.withsplendor.com/guides/semantic-search.md): Retrieve records by meaning with vector search.
- [Stream logs](https://docs.withsplendor.com/guides/stream-logs.md): Send structured log records to a source for continuous ingestion.
- [Write a detection](https://docs.withsplendor.com/guides/write-a-detection.md): Define a rule that runs on a schedule and notifies a webhook when it matches.
- [Splendor API](https://docs.withsplendor.com/index.md): Search, retrieve, and analyze your operational data across full-text, SQL, and semantic modes.
- [Run your first search](https://docs.withsplendor.com/quickstart.md): Authenticate, find a dataset, and run a search against it in a few minutes.
- [Async jobs](https://docs.withsplendor.com/reference/async-jobs.md): The create-then-poll pattern shared by exports, reindexes, deletions, and schema rebuilds.
- [Errors](https://docs.withsplendor.com/reference/errors.md): The error envelope, HTTP status codes, and machine-readable error codes.
- [Rate limits & capacity](https://docs.withsplendor.com/reference/rate-limits.md): How Splendor sheds load under capacity pressure and how to back off.
- [Roles & permissions](https://docs.withsplendor.com/roles/permissions.md): What members and admins can do within a tenant.
- [Plans & RBAC](https://docs.withsplendor.com/roles/plans.md): How role enforcement (RBAC) is enabled by your plan.

## OpenAPI Specs

- [openapi](https://docs.withsplendor.com/api-reference/openapi.json)