Get Session Status
Retrieves the current status of a session, including normalized address data and processing status of various Hum AI agents.
Polling Guidelines
- Initial request: Immediately after session creation
- Subsequent requests: Every 2-3 seconds until agents complete
- Maximum polling duration: 30 seconds
- Implement exponential backoff if status doesn’t change
Status Codes
- 200: Session active and data available
- 202: Session active but still processing
- 410: Session expired or closed
Response Data
- Normalized address
- Geocoding results
- Agent processing status
- Available services (when ready)
Important Notes
- The session token is part of the URL path for all requests after creation
- The session token is required for all subsequent requests
- The session token is valid for 30 minutes of inactivity
- Rate limits apply to all requests
Example Response
{
"message": "Session data retrieved successfully",
"request_status": "ok",
"data": {
"service_address": "29090 TIFFANY DR E, SOUTHFIELD, MI 48034",
},
"meta": {
"agent_status": {
"geocoding": "matched",
"internet": "pending"
}
}
}
Authorizations
Bearer token authentication using API tokens.
Include the token in the Authorization header as: Authorization: Bearer <token>
Obtain tokens through your Hum API account dashboard or contact support@letshum.com for access.
Path Parameters
The session token identifying the specific session The session token provided by the Hum API. Used to connect the response to the session in the client system.
"XqCmeTVgYXrbWrZFZEymkD"
Response
Session data retrieved successfully
A message returned by the API. Includes a human-readable message about the status of the request.
"What happened in the most recent request."
A status code summarizing the outcome of this response.
- ok: Request was successful
- warning: Request was processed but with some issues
- error: Request failed
ok, warning, error "ok"
Metadata about the session. Can be used to track the status of the session, time since creation, and time since last update.
