Retrieve All Sessions
This API allows users to fetch a paginated list of conversation histories within a specified time range.
Endpoint
Headers
formacloud-api-key
string
Yes
API key for authentication
Query Parameters
start
string (ISO 8601)
No
Start timestamp (UTC) in ISO 8601 format (e.g., 2024-02-20T00:00:00Z
). If not provided, no lower limit is applied.
end
string (ISO 8601)
No
End timestamp (UTC) in ISO 8601 format (e.g., 2024-02-21T00:00:00Z
). If not provided, no upper limit is applied.
page
int
No
Page number (default: 0
).
page_size
int
No
Number of records per page (default: 10
).
Example Request
Fetch Conversation History (Default Pagination)
Fetch History Within a Time Range
Response
Returns a JSON object containing conversation history and pagination details.
Response Fields
history
array
List of conversation history records
goal
string
The goal of the conversation
session_id
string
Unique session identifier
created_at
string (ISO 8601)
The timestamp when the session was created
pagination
object
Pagination metadata
current_page
int
The current page number
total_pages
int
The total number of pages
total_records
int
The total number of history records
Example Response
Last updated
Was this helpful?