Sessions
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"
}
}
}
GET
Authorizations
Bearer token authentication using JWT 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
Example:
"XqCmeTVgYXrbWrZFZEymkD"
Response
200
application/json
Session data retrieved successfully
The response is of type object
.