API Playground

Test API endpoints interactively using the tools below. The full OpenAPI specification is available for download and can be imported into your preferred API client.

Download the Spec

The OpenAPI 3.1 specification describes every public endpoint, including request/response schemas, parameters, and authentication requirements.

OpenAPI Spec (JSON) Download the public API specification for use with Swagger UI, Postman, or any OpenAPI-compatible tool.

Use with Swagger Editor

Open the Swagger Editor and paste the contents of the spec file. The editor provides an interactive “Try It Out” feature for every endpoint.

1. Open editor.swagger.io.
2. Click File > Import URL.
3. Enter: https://docs.spatial.properties/openapi/public.json
4. Browse endpoints in the right panel and use Try it out to send requests.

Use with Postman

1. Open Postman and click Import.
2. Select Link and paste: https://docs.spatial.properties/openapi/public.json
3. Postman creates a collection with all endpoints pre-configured.
4. Set the Authorization header to Bearer YOUR_ACCESS_TOKEN in the collection variables.

Use with Insomnia

1. Open Insomnia and click Import.
2. Select the downloaded public.json file.
3. All endpoints appear in the sidebar with parameters pre-filled.

Authentication for Testing

Most endpoints require a Bearer token. Before testing:

1. Obtain an access token following the Authentication guide.
2. Set the Authorization header to Bearer YOUR_ACCESS_TOKEN in your API client.
3. Verify connectivity with GET /health (no auth required).

Streaming Endpoints

Three endpoints use Server-Sent Events (SSE) and cannot be tested with standard REST clients:

Endpoint	Description
POST /chat	Chat with the spatial analysis agent
POST /batch/upload	Upload and process batch assessments
POST /report/generate	Generate PDF reports

For these endpoints, use a dedicated SSE client or the curl examples from the endpoint documentation.