Skip to main content
POST
https://api.calmyx.com
/
v2
/
session
/
new
{
  "geolocations": [
    { "lat": 37.7749, "lng": -122.4194 },
    { "lat": 37.7849, "lng": -122.4094 },
    { "lat": 37.7649, "lng": -122.4294 },
    { "lat": 37.7549, "lng": -122.4394 },
    { "lat": 37.7449, "lng": -122.4494 }
  ]
}

{
  "session_id": "sess_abc123def456ghi789",
  "total_geolocations": 5,
  "geolocations_imported": 5,
  "geolocations_failed": 0,
  "submitted_at": "2025-01-15T10:30:00.000000"
}

​
Overview

The Create Session API initiates an asynchronous session for processing large batches of geolocations. This is ideal when you need to analyze many locations and don’t want to wait for synchronous processing.
To obtain an API key, please contact our sales team.

​
Authorization

​
Authorization
string
required
Your API key for authentication

​
Request Body

​
geolocations
array
required
An array of geolocation objects, each containing lat and lng properties
{
  "geolocations": [
    { "lat": 37.7749, "lng": -122.4194 },
    { "lat": 37.7849, "lng": -122.4094 },
    { "lat": 37.7649, "lng": -122.4294 },
    { "lat": 37.7549, "lng": -122.4394 },
    { "lat": 37.7449, "lng": -122.4494 }
  ]
}

{
  "session_id": "sess_abc123def456ghi789",
  "total_geolocations": 5,
  "geolocations_imported": 5,
  "geolocations_failed": 0,
  "submitted_at": "2025-01-15T10:30:00.000000"
}

​
Response Fields

FieldTypeDescription
session_idstringUnique identifier for the session
total_geolocationsintegerTotal number of geolocations submitted
geolocations_importedintegerNumber of geolocations successfully queued
geolocations_failedintegerNumber of geolocations that failed to import
submitted_atstringTimestamp when the session was created

​
Notes

  • Use the returned session_id to check the processing status via the Session Status endpoint
  • Sessions are processed asynchronously in the background
  • Maximum of 100 geolocations per session
  • Each geolocation must have valid lat and lng properties
  • Session results are stored and can be retrieved after processing completes