V1/admin

Ping server

get

Ping the server to retrieve basic information about it. This endpoint is always up regardless of whether the server is in maintenance mode.

Authorizations

Bearer-AuthorizationBearer-Authorization-OrganizationAPI-Key-Authorization-KeyAPI-Key-Authorization-IDAPI-Key-Authorization-UserID

Path parameters

organizationstringRequired

Header parameters

x-mongo-cluster-nameany ofOptional

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.

stringOptional

or

nullOptional

Responses

200

Succeeded.

application/json

404

The specified organization does not exist.

422

Invalid request path parameter failed validation.

get

HTTPcURLJavaScriptPython

GET /v1/{organization}/admin/ping HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Accept: */*

{
  "in_maintenance_mode": true
}

Get prompt logs

get

Download all rendered prompt logs whose log keys match the supplied prefix. Up to a 1000 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}-error file will be generated in place of the actual prompt log.

Authorizations

Bearer-AuthorizationBearer-Authorization-OrganizationAPI-Key-Authorization-KeyAPI-Key-Authorization-IDAPI-Key-Authorization-UserID

Path parameters

organizationstringRequired

Query parameters

prompt_log_prefixstringRequired

The prefix of the prompt log to retrieve.

Header parameters

x-mongo-cluster-nameany ofOptional

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.

stringOptional

or

nullOptional

Responses

200

Succeeded.

application/json

Responseany

401

Invalid authorization credentials.

403

Missing required permissions.

404

No prompt logs found matching the supplied prefix

422

Invalid request path parameter or query parameter failed validation.

429

The user has exceeded the rate limit of 5 requests per minute for this endpoint.

503

The service is going through temporary maintenance.

get

HTTPcURLJavaScriptPython

GET /v1/{organization}/admin/get_prompt_logs/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Accept: */*

No content