latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Admin

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}-error file will be generated in place of the actual prompt log.
get/v1/{organization}/admin/get_prompt_logs/

Path parameters

organizationstring required

Query parameters

prompt_log_prefixstring required

The prefix of the prompt log to retrieve.

The prefix of the prompt log to retrieve.

Headers

x-mongo-cluster-namestring nullable

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.

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.

Sec-WebSocket-Protocolstring[]

Response

Succeeded.