Public API

Litefuse 是开放的，意在通过自定义工作流和集成进行扩展。所有 Litefuse 数据和功能都可通过 API 访问。

/api/public

https://litefuse.cloud/api/public

https://litefuse.cloud/api/public

https://hipaa.cloud.litefuse.ai/api/public

参考资料：

API Reference: https://api.reference.litefuse.ai
OpenAPI 规范: https://litefuse.cloud/generated/api/openapi.yml
Postman collection: https://litefuse.cloud/generated/postman/collection.json

共有 3 组不同的 API：

本页 -> 项目级 API：在项目内 CRUD trace/评估/prompt/配置
组织级 API：分配项目、用户（SCIM）以及权限
实例管理 API：在自托管安装中管理组织

认证

使用 Basic Auth 对 API 进行认证。 API Key 可在 Litefuse 项目设置中获取。

用户名：Litefuse Public Key
密码：Litefuse Secret Key

示例：

curl -u public-key:secret-key https://litefuse.cloud/api/public/projects

通过 SDK 访问

Litefuse 的 Python SDK 与 JS/TS SDK 都为我们的公共 REST API 提供了强类型封装，方便使用。在两个 SDK 中，API 方法都可通过 Langfuse 客户端实例上的 api 属性访问。

你可以利用编辑器的 Intellisense 探索 API 方法及其参数。

在 Python SDK v4 与 JS/TS SDK v5 中，高性能资源已成为默认： api.observations、api.scores 和 api.metrics。Legacy v1 资源被移到了 api.legacy.*（Python：*_v1，JS/TS：*V1）。

获取 prompts 时，请使用 Langfuse 客户端上的 get_prompt（Python）/ getPrompt（JS/TS）方法，以受益于客户端缓存、自动重试和 fallback。

使用 Python SDK：

from langfuse import get_client
 
langfuse = get_client()
...
# fetch a trace
langfuse.api.trace.get(trace_id)
 
# async client via asyncio
await langfuse.async_api.trace(trace_id)
 
# explore more endpoints via Intellisense
langfuse.api.*
await langfuse.async_api.*

import { LangfuseClient } from '@langfuse/client';
 
const langfuse = new LangfuseClient();
...
// fetch a trace
await langfuse.api.trace.get(traceId);
 
// explore more endpoints via Intellisense
langfuse.api.*

通过在 pom.xml 中加入以下内容来安装 Litefuse：

<dependencies>
  <dependency>
    <groupId>com.langfuse</groupId>
    <artifactId>langfuse-java</artifactId>
    <version>0.0.1-SNAPSHOT</version>
  </dependency>
</dependencies>
 
<repositories>
  <repository>
    <id>github</id>
    <name>GitHub Package Registry</name>
    <url>https://maven.pkg.github.com/litefuse/litefuse-java</url>
  </repository>
</repositories>

通过以下方式实例化并使用 Java SDK：

import com.langfuse.client.LangfuseClient;
import com.langfuse.client.resources.prompts.types.PromptMetaListResponse;
import com.langfuse.client.core.LangfuseClientApiException;
 
LangfuseClient client = LangfuseClient.builder()
  .url("https://litefuse.cloud")
  // .url("http://localhost:3000") // 🏠 Local deployment
  .credentials("pk-lf-...", "sk-lf-...")
  .build();
 
try {
  PromptMetaListResponse prompts = client.prompts().list();
} catch (LangfuseClientApiException error) {
  System.out.println(error.getBody());
  System.out.println(error.getStatusCode());
}

通过 API 上报 Trace

未来 OpenTelemetry Endpoint 会替代 Ingestion API。因此，强烈建议切换到 OpenTelemetry Endpoint 进行 trace 上报。详情请参阅 OpenTelemetry 文档。

OpenTelemetry Traces 上报端点实现了 OTLP/HTTP 规范用于 trace 上报，为 Litefuse 可观测性提供原生 OpenTelemetry 集成。
（Legacy）Ingestion API 允许通过 API 进行 trace 上报。

通过 API 获取数据

Observations API —— 从 Litefuse 获取 observation 数据（spans、generations、events），用于自定义工作流、评估流水线和分析。v2 API 通过基于 cursor 的分页与按需字段获取提供高性能数据访问。
Metrics API —— 从你的 Litefuse 数据中获取聚合分析与指标。可在不同视图（observations、scores）上进行查询，支持自定义维度、指标、过滤器和时间粒度，可制作强大的自定义报表与仪表盘。

其他方式

你也可以通过以下方式导出数据：

UI —— 从 Litefuse UI 手动批量导出
对象存储 —— 计划任务自动导出到云存储

FAQ

Observations API 通过 SDK 查询

这个页面对你有帮助吗？

支持