Dec 2025 - New! Caching input tokens unlocks immediate, automatic ~30% credit savings on supported models
cURL
curl --request GET \ --url http://localhost:3000/api/admin/institution/{institutionId} \ --header 'x-access-token: <api-key>'
{ "success": true, "data": { "_id": "<string>", "name": "<string>", "picture": "<string>", "credits": 123, "creditsUsed": 123, "creditsAwarded": 123, "status": "active", "publicId": "<string>", "publicAuthorizedUrls": [ "<string>" ], "ainame": "<string>", "contactEmail": "<string>", "poolCredits": true, "created": "2023-11-07T05:31:56Z", "conversationModel": "<string>", "account": { "_id": "<string>", "name": "<string>" }, "maxCompletionTokens": 123, "creditsTotal": 123, "creditsUsagePct": 123, "id": "<string>", "displayAgentDetails": true } }
Retrieves detailed information about a specific institution including configuration, credits, and settings
JWT token passed in x-access-token header
The institution ID
Institution details retrieved successfully
Whether the request was successful
Show child attributes
Institution ID
Institution name
Institution picture URL
Available credits for the institution
Number of credits used
Credits awarded to the institution
Institution status
active
inactive
Public identifier for the institution
List of authorized URLs for the institution
AI name for the institution
Contact email for the institution
Whether credits are pooled
Institution creation timestamp
AI conversation model used
Account ID
Account name
Maximum completion tokens allowed
Total credits available
Percentage of credits used
Institution identifier
Whether to display agent details
Was this page helpful?