Admin
Administrative endpoints for listing available LLM models and downloading prompt logs for debugging.
Get Available Models
Get a list of LLM models supported by the Amigo platform at this moment.
Permissions:
This endpoint requires the following permissions:
Admin:GetModels.
The username should be set to {org_id}_{user_id}, and the password should be the Amigo issued JWT token that identifies the user.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Invalid request path parameter failed validation.
The user has exceeded the rate limit of 20 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/admin/get_models/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"models": [
{
"name": "text",
"params_model_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}Get Prompt Logs
Download all rendered prompt logs whose log keys match the supplied prefix that are produced in the past 30 days. Only prefixes corresponding to less than or equal to 1000 prompt logs are allowed.
The prompt logs will be returned in a zip file format, with each prompt log corresponding to at most 2 files -- {log_key}-system for the rendered system prompt, and {log_key}-history for the
rendered history prompts, where each history prompt is separated by ---.
If an error is encountered during the download stream that is scoped to an individual prompt log, a {log_key}-error file will be generated which contains a description of the error.
If an error is encountered that causes the generation to stop completely, no error message will be returned. Instead, the stream will end, and the transmitted bytes wouldn't constitute
a valid zip file.
Permissions
This endpoint may be impacted by the following permissions:
- Each prompt log requires its own set of permissions. If the authenticated user does not have the required permissions, a
{log_key}-errorfile will be generated in place of the actual prompt log.
The username should be set to {org_id}_{user_id}, and the password should be the Amigo issued JWT token that identifies the user.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The prefix of the prompt log to retrieve.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
No prompt logs found matching the supplied prefix
Invalid request path parameter or query parameter failed validation.
The user has exceeded the rate limit of 20 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/admin/get_prompt_logs/?prompt_log_prefix=text HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
textRelated
Last updated
Was this helpful?