Skip to main content
POST
https://api.calmyx.com
/
v2
/
session
/
new
Create Session
curl --request POST \
  --url https://api.calmyx.com/v2/session/new \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "locations": [
    {}
  ]
}
'
{
  "session_id": "sess_abc123def456ghi789",
  "total_locations": 5,
  "submitted_at": "2026-01-15T10:30:00.000000"
}

​
Overview

The Create Session API initiates an asynchronous session for processing large batches of locations. Perfect for enterprise workloads, bulk property analysis, or integrations that need to process many locations without blocking.
To obtain an API key, register for an account and subscribe to a plan.

​
Authorization

​
Authorization
string
required
Your API key for authentication

​
Request Body

​
locations
array
required
Array of location objects to process. Each object must contain lat (float) and lng (float) coordinates.

​
Request Structure

FieldTypeRequiredDescription
locationsarrayYesArray of location objects
locations[].latfloatYesLatitude coordinate of the location
locations[].lngfloatYesLongitude coordinate of the location
{
  "session_id": "sess_abc123def456ghi789",
  "total_locations": 5,
  "submitted_at": "2026-01-15T10:30:00.000000"
}

​
Response Fields

FieldTypeDescription
session_idstringUnique identifier for the session
total_locationsintegerTotal number of locations submitted
submitted_atstringISO 8601 timestamp when the session was created

​
Notes

  • Use the returned session_id to check processing status via the Session Status endpoint
  • Sessions are processed asynchronously — your application can continue without waiting
  • Maximum of 500 locations per session
  • Each location must have valid lat and lng properties in decimal degrees format
  • Quiet Score™ results are stored and can be retrieved once processing completes