# Splat3D API

> Turn photos and videos into interactive 3D scenes.

- [Introduction](https://docs.splat-3d.com/introduction.md): Turn photos and videos into interactive 3D scenes with the Splat3D API.
- [Quickstart](https://docs.splat-3d.com/quickstart.md): Create your first 3D scene in 5 minutes.
- [Authentication](https://docs.splat-3d.com/authentication.md): Authenticate with the Splat3D API using Bearer token API keys.
- [Build with AI agents](https://docs.splat-3d.com/build-with-ai.md): Give a coding agent the docs as text, the Splat3D API skill, or a short prompt.
- [Pricing & Credits](https://docs.splat-3d.com/guides/pricing.md): Pay-as-you-go credits, the price of a scene at each quality tier, and the two credit packs.
- [Upload Limits](https://docs.splat-3d.com/guides/upload-limits.md): The upload size cap, what counts toward it, and how exceeding it is handled.
- [Supported Inputs](https://docs.splat-3d.com/guides/supported-inputs.md): The files a scene can be built from, how to package each, and the content_type to send.
- [How the Splat3D pipeline works](https://docs.splat-3d.com/guides/pipeline-architecture.md): From upload to interactive 3D scene — what each stage does and how long it takes.
- [Quality Presets](https://docs.splat-3d.com/guides/presets.md): Choose the right speed/quality tradeoff for your 3D reconstructions.
- [Training Parameters](https://docs.splat-3d.com/guides/training-parameters.md): Fine-tune the 3D reconstruction pipeline with per-field parameter control.
- [SfM Backends](https://docs.splat-3d.com/guides/sfm-backends.md): Choose the right structure-from-motion engine for your captures.
- [Output Formats](https://docs.splat-3d.com/guides/output-formats.md): Understand the SOG, PLY and SPZ formats and when to use each.
- [SDKs](https://docs.splat-3d.com/sdks/overview.md): Official client libraries for the Splat3D API
- [Swift SDK](https://docs.splat-3d.com/sdks/swift.md): Splat3D — native ARKit capture + Splat3D API for iOS
- [API Overview](https://docs.splat-3d.com/api-reference/overview.md): Base URL, authentication, response format, and error codes for the Splat3D API.
- [Changelog](https://docs.splat-3d.com/changelog.md): Changes to the Splat3D API, newest first.
- [List scenes](https://docs.splat-3d.com/api-reference/scenes/list-scenes.md): List all scenes for the authenticated user, newest first, with cursor-based pagination. Each item has the shape `GET /v1/scenes/{id}` returns.
- [Create a scene](https://docs.splat-3d.com/api-reference/scenes/create-a-scene.md): Create a new scene and get a presigned upload URL for the source file.
- [Get scene status](https://docs.splat-3d.com/api-reference/scenes/get-scene-status.md): Get detailed status and metadata for a scene. `status` is the stored status, as the list and PATCH return it. While the scene processes, `processing_stage` and `processing_pct` carry live progress.
- [Delete a scene](https://docs.splat-3d.com/api-reference/scenes/delete-a-scene.md): Delete a scene. Every call answers `404` for it at once; a daily cleanup removes its files 24 to 48 hours later. An unfinished scene is cancelled first, under the cancel refund rules; if the cancel fails, nothing is deleted.
- [Update scene metadata](https://docs.splat-3d.com/api-reference/scenes/update-scene-metadata.md): Update title, address, description, or visibility of a scene.
- [Start processing a scene](https://docs.splat-3d.com/api-reference/scenes/start-processing-a-scene.md): Reserve one paid launch for an uploaded scene. Retry with the same body and optional Idempotency-Key to replay the saved result without another charge, processing-quota increment, or dispatch. An uncertain upstream response remains accepted until status reconciliation resolves it.
- [Retrain a scene](https://docs.splat-3d.com/api-reference/scenes/retrain-a-scene.md): Process a scene's source again as a new scene (a version), at the tier `quality_tier` or `preset` names, standard when neither is sent. `id` and `scene_id` name the new scene; the source scene is left as it is, running or not. Each request makes another version. A retrain refused before any charge k…
- [Cancel scene processing](https://docs.splat-3d.com/api-reference/scenes/cancel-scene-processing.md): Cancel an in-progress scene processing job. A cancel before the job starts, or within 10 seconds after, refunds the credits it charged. The job starts around when /process returns. A later cancel keeps the processing charge and refunds only an AI Enhance charge reserved at upload (dashboard launches…
- [Download 3D model file](https://docs.splat-3d.com/api-reference/scenes/download-3d-model-file.md): Download the processed 3D Gaussian Splat model file.
- [Get scene thumbnail](https://docs.splat-3d.com/api-reference/scenes/get-scene-thumbnail.md): Get the PNG thumbnail for a scene. A public scene's needs no API key. A private scene's is served only to its owner's key: any other caller gets `404`, so whether a scene exists stays private. A deleted scene's is never served.
- [Get current usage and quotas](https://docs.splat-3d.com/api-reference/usage/get-current-usage-and-quotas.md): Returns the authenticated user's usage for the current billing period and their plan limits.
- [Scene completed](https://docs.splat-3d.com/api-reference/webhooks/scene-completed.md): A scene finished processing. Sent as a `POST` to the scene's `webhook_url`, with `Content-Type: application/json` and `User-Agent: Splat-Webhook/1.0`. Answer any 2xx to acknowledge it. Any other status, or a network error, is retried: 3 attempts in all, 1 s then 2 s apart, with the same body and sig…
- [Scene failed](https://docs.splat-3d.com/api-reference/webhooks/scene-failed.md): A scene failed. Its credits are refunded. Sent as a `POST` to the scene's `webhook_url`, with `Content-Type: application/json` and `User-Agent: Splat-Webhook/1.0`. Answer any 2xx to acknowledge it. Any other status, or a network error, is retried: 3 attempts in all, 1 s then 2 s apart, with the same…

## OpenAPI Specs

- [openapi](https://api.splat-3d.com/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.