curl --request POST \
--url https://pria.praxislxp.com/api/admin/institutions \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"minimum": true
}
'{
"success": true,
"data": [
{
"_id": "<string>",
"name": "<string>",
"picture": "<string>",
"credits": 123,
"creditsUsed": 123,
"creditsAwarded": 123,
"publicId": "<string>",
"publicAuthorizedUrls": [
"<string>"
],
"ainame": "<string>",
"contactEmail": "<string>",
"poolCredits": true,
"created": "2023-11-07T05:31:56Z",
"lastActivityAt": "2023-11-07T05:31:56Z",
"conversationModel": "<string>",
"account": {
"_id": "<string>",
"name": "<string>",
"managerEmail": "jsmith@example.com",
"credits": 123,
"domainUrls": [
"<string>"
],
"qualification": "<string>",
"created": "2023-11-07T05:31:56Z"
},
"agent": {
"enabled": true,
"preset": "<string>",
"manifestYaml": "<string>",
"manifestDigest": "<string>",
"preferences": {
"cpu": 2.125,
"memoryMb": 4352,
"storageGb": 52,
"gui": true,
"vncResolution": "1280x800"
},
"requestedBy": "<string>",
"requestedAt": "2023-11-07T05:31:56Z",
"provisionedAt": "2023-11-07T05:31:56Z",
"lastError": "<string>"
},
"maxCompletionTokens": 123,
"creditsTotal": 123,
"creditsUsagePct": 123,
"id": "<string>",
"displayAgentDetails": true,
"displayThinkingDetails": true,
"displayThinkingExecution": true,
"displayToolExecution": true
}
],
"total": 123,
"hasMore": true,
"page": 123,
"pageSize": 123,
"message": "<string>"
}Retrieve list of institutions
Get a list of all institutions with their details and statistics
curl --request POST \
--url https://pria.praxislxp.com/api/admin/institutions \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"minimum": true
}
'{
"success": true,
"data": [
{
"_id": "<string>",
"name": "<string>",
"picture": "<string>",
"credits": 123,
"creditsUsed": 123,
"creditsAwarded": 123,
"publicId": "<string>",
"publicAuthorizedUrls": [
"<string>"
],
"ainame": "<string>",
"contactEmail": "<string>",
"poolCredits": true,
"created": "2023-11-07T05:31:56Z",
"lastActivityAt": "2023-11-07T05:31:56Z",
"conversationModel": "<string>",
"account": {
"_id": "<string>",
"name": "<string>",
"managerEmail": "jsmith@example.com",
"credits": 123,
"domainUrls": [
"<string>"
],
"qualification": "<string>",
"created": "2023-11-07T05:31:56Z"
},
"agent": {
"enabled": true,
"preset": "<string>",
"manifestYaml": "<string>",
"manifestDigest": "<string>",
"preferences": {
"cpu": 2.125,
"memoryMb": 4352,
"storageGb": 52,
"gui": true,
"vncResolution": "1280x800"
},
"requestedBy": "<string>",
"requestedAt": "2023-11-07T05:31:56Z",
"provisionedAt": "2023-11-07T05:31:56Z",
"lastError": "<string>"
},
"maxCompletionTokens": 123,
"creditsTotal": 123,
"creditsUsagePct": 123,
"id": "<string>",
"displayAgentDetails": true,
"displayThinkingDetails": true,
"displayThinkingExecution": true,
"displayToolExecution": true
}
],
"total": 123,
"hasMore": true,
"page": 123,
"pageSize": 123,
"message": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.praxis-ai.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
JWT token passed in x-access-token header
Body
Whether to return minimal institution data (bypasses pagination)
Whether to return compact institution data
Account ID(s) to filter institutions (space-separated for multiple)
Search term for institutions (matches name, AI name, publicId)
Filter institutions by lifecycle status. 'active' returns only active instances, 'inactive' returns only inactive, 'all' returns both. Deleted institutions are always excluded.
active, inactive, all When true, restrict to instances that have actually been used (lastActivityAt is set, not null). ANDs with statusFilter.
When true, restrict to institutions that have a non-empty conversationModel set. Combines with statusFilter and notPoolCredits via AND.
When true, restrict to institutions where poolCredits is not true (i.e. false or unset). Combines with statusFilter and withCustomModel via AND.
Page number (1-based)
x >= 1Number of results per page
1 <= x <= 5000DEPRECATED: Use pageSize instead
Response
Successfully retrieved institutions list
Whether the request was successful
Array of institution objects
Show child attributes
Show child attributes
Total number of matching institutions
Whether more results are available beyond the current page
Current page number
Number of results per page
Response message
Was this page helpful?