@arizeai/phoenix-client/src/prompts/listPrompts.ts

A client for the Phoenix API

import invariant from "tiny-invariant";

import { createClient } from "../client";
import type { ClientFn } from "../types/core";
import type { Prompt } from "../types/prompts";

export type ListPromptsParams = ClientFn;

/**
 * List all prompts available to the client.
 *
 * @example
 * ```ts
 * import { listPrompts } from "@arizeai/phoenix-client/prompts";
 *
 * const prompts = await listPrompts({});
 * console.log(prompts);
 * ```
 *
 * @throws {Error} If the prompts cannot be listed or the response is invalid.
 */
export async function listPrompts({
  client: _client,
}: ListPromptsParams): Promise<Prompt[]> {
  const client = _client || createClient();
  const response = await client.GET("/v1/prompts");
  invariant(response.data?.data, "Failed to list prompts");
  return response.data.data;
}