Request Format

The CAPTUR3D API accepts JSON-encoded request bodies for all endpoints that require data submission.

Make sure to set the Content-Type header to application/json when sending request data.

Each endpoint requires different inputs. See the relevant API Reference for more information.

Headers

When making API requests, ensure you include the following headers:

Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

Content-Type: application/json – This ensures the request body is sent in JSON format.
Authorization: Bearer YOUR_API_KEY – Required for authentication (see the Authentication section).

Authentication

x-api-version: yyyy-mm-dd - Determines the version of the API that you wish to use for this request. More info in API Versioning

API Versioning

Base API URL

All API endpoints should be prefixed with the following base URL:

https://captur3d.io/api/v2

e.g. To order a floor plan

curl -X POST "https://captur3d.io/api/v2/orders/floor_plans" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -H "x-api-version: 2025-01-01" \
     -d '{ "example": "data" }'

Endpoint-Specific Parameters

Each API endpoint has different required and optional parameters. Refer to the API Reference for specific details on request bodies, query parameters, and expected responses.