server
Real-time data The only real-time path to get tracing data is to ingest via OpenTelemetry (POST /api/public/otel/v1/traces) and retrieve via Observations API…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Real-time data
The only real-time path to get tracing data is to ingest via OpenTelemetry (POST /api/public/otel/v1/traces) and retrieve via Observations API v2 (GET /api/public/v2/observations) and Metrics API v2 (GET /api/public/v2/metrics). Other public API write and read endpoints can delay data by about 10 minutes. Direct OpenTelemetry exporters must send the x-langfuse-ingestion-version: 4 header; current Python and JS SDKs already do. See the Public API docs and real-time ingestion.
Authentication
Authenticate with the API using Basic Auth, get API keys in the project settings:
- username: Langfuse Public Key
- password: Langfuse Secret Key
Exports
- OpenAPI spec: https://cloud.langfuse.com/generated/api/openapi.yml
- Self-hosted deployments: interactive API reference at
/api/docsand OpenAPI spec at/api/openapi.yaml
Endpoints 120
AnnotationQueues
- GETannotationQueues_listQueues
/api/public/annotation-queues?page=0&limit=0Get all annotation queues - POSTannotationQueues_createQueue
/api/public/annotation-queuesCreate an annotation queue - GETannotationQueues_getQueue
/api/public/annotation-queues/:queueIdGet an annotation queue by ID - GETannotationQueues_listQueueItems
/api/public/annotation-queues/:queueId/items?status=PENDING&page=0&limit=0Get items for a specific annotation queue - POSTannotationQueues_createQueueItem
/api/public/annotation-queues/:queueId/itemsAdd an item to an annotation queue - GETannotationQueues_getQueueItem
/api/public/annotation-queues/:queueId/items/:itemIdGet a specific item from an annotation queue - DELETEannotationQueues_deleteQueueItem
/api/public/annotation-queues/:queueId/items/:itemIdRemove an item from an annotation queue - PATCHannotationQueues_updateQueueItem
/api/public/annotation-queues/:queueId/items/:itemIdUpdate an annotation queue item - POSTannotationQueues_createQueueAssignment
/api/public/annotation-queues/:queueId/assignmentsCreate an assignment for a user to an annotation queue - DELETEannotationQueues_deleteQueueAssignment
/api/public/annotation-queues/:queueId/assignmentsDelete an assignment for a user to an annotation queue
BlobStorageIntegrations
- GETblobStorageIntegrations_getBlobStorageIntegrations
/api/public/integrations/blob-storageGet all blob storage integrations for the organization (requires organization-scoped API key) - PUTblobStorageIntegrations_upsertBlobStorageIntegration
/api/public/integrations/blob-storageCreate or update a blob storage integration for a specific project (requires organization-scoped API key). The configuration is validated by performing a test… - GETblobStorageIntegrations_getBlobStorageIntegrationStatus
/api/public/integrations/blob-storage/:idGet the sync status of a blob storage integration by integration ID (requires organization-scoped API key) - DELETEblobStorageIntegrations_deleteBlobStorageIntegration
/api/public/integrations/blob-storage/:idDelete a blob storage integration by ID (requires organization-scoped API key)
Comments
- GETcomments_get
/api/public/comments?page=0&limit=0&objectType=string&objectId=string&authorUserId=stringGet all comments - POSTcomments_create
/api/public/commentsCreate a comment. Comments may be attached to different object types (trace, observation, session, prompt). - GETcomments_get-by-id
/api/public/comments/:commentIdGet a comment by id
DatasetItems
- GETdatasetItems_list
/api/public/dataset-items?datasetName=string&sourceTraceId=string&sourceObservationId=string&version=2024-01-01T00:00:00Z&page=0&limit=0Get dataset items. Optionally specify a version to get the items as they existed at that point in time. Note: If version parameter is provided, datasetName… - POSTdatasetItems_create
/api/public/dataset-itemsCreate a dataset item - GETdatasetItems_get
/api/public/dataset-items/:idGet a dataset item - DELETEdatasetItems_delete
/api/public/dataset-items/:idDelete a dataset item and all its run items. This action is irreversible.
Datasets
- GETdatasets_list
/api/public/v2/datasets?page=0&limit=0Get all datasets - POSTdatasets_create
/api/public/v2/datasetsCreate a dataset - GETdatasets_get
/api/public/v2/datasets/:datasetNameGet a dataset
EvaluationRules
- GETevaluationRules_list
/api/public/v2/evaluation-rules?limit=0&cursor=stringList evaluation rules in newest-first creation order. This includes legacy trace and dataset rules so they can be inspected and migrated. Treat the cursor as… - POSTevaluationRules_create
/api/public/v2/evaluation-rulesCreate an evaluation rule using stable evaluator identifiers. An evaluation rule defines which incoming observations should be evaluated and how prompt… - GETevaluationRules_get
/api/public/v2/evaluation-rules/:evaluationRuleIdGet one evaluation rule, including a legacy trace or dataset rule, by its stable identifier. - DELETEevaluationRules_delete
/api/public/v2/evaluation-rules/:evaluationRuleIdDelete an evaluation rule. This removes the live-ingestion rule only. It does not delete associated evaluators or scores already produced by them. Legacy… - PATCHevaluationRules_update
/api/public/v2/evaluation-rules/:evaluationRuleIdUpdate an evaluation rule by its stable identifier. Provide only the fields to change. Providing evaluatorAssignments replaces the complete assignment list.…
Evaluators
- GETevaluators_list
/api/public/v2/evaluators?limit=0&cursor=stringList evaluators in newest-first creation order. Every evaluator includes its latest definition and version metadata flattened into the evaluator object, plus… - POSTevaluators_create
/api/public/v2/evaluatorsCreate an evaluator in the authenticated project. An evaluator defines how Langfuse should score data. LLM-as-a-judge evaluators define a prompt, expected… - GETevaluators_get
/api/public/v2/evaluators/:evaluatorIdGet one evaluator by its stable identifier. The response includes the evaluator's latest definition and version metadata flattened into the evaluator object,… - DELETEevaluators_delete
/api/public/v2/evaluators/:evaluatorIdDelete an evaluator and all of its stored versions. Associated evaluation-rule assignments are also removed. Scores already produced by the evaluator are… - PATCHevaluators_update
/api/public/v2/evaluators/:evaluatorIdUpdate an evaluator by its stable identifier. Provide only the top-level fields to change. Metadata-only changes do not create a version. Evaluator type… - GETevaluators_listVersions
/api/public/v2/evaluators/:evaluatorId/versions?limit=0&cursor=stringList an evaluator's version history in newest-first order. This endpoint is intended for history and audit use cases. Ordinary clients can use the flattened…
Experiments
- GETexperiments_list
/api/public/experiments?fields=string&limit=0&scoreLimit=0&cursor=string&fromStartTime=2024-01-01T00:00:00Z&toStartTime=2024-01-01T00:00:00Z&id=string&name=string&datasetId=string&filter=stringList experiments with cursor-based pagination. Results are ordered by latest experiment activity descending. - GETexperiments_listItems
/api/public/experiment-items?fields=string&limit=0&scoreLimit=0&cursor=string&fromStartTime=2024-01-01T00:00:00Z&toStartTime=2024-01-01T00:00:00Z&experimentId=string&experimentName=string&experimentItemId=string&datasetId=string&filter=stringList experiment items with cursor-based pagination. Use this endpoint to export experiment item inputs, outputs, expected outputs, metadata, and optionally…
Feedback
- POSTfeedback_submit
/api/public/feedbackSubmit explicit user-approved feedback about Langfuse skills, MCP tools, CLI, docs, or public API. Do not include secrets, credentials, customer data, trace…
Health
- GEThealth_health
/api/public/healthCheck health of API and database
LlmConnections
- GETllmConnections_list
/api/public/llm-connections?page=0&limit=0Get all LLM connections in a project - PUTllmConnections_upsert
/api/public/llm-connectionsCreate or update an LLM connection. The connection is upserted on provider. - DELETEllmConnections_delete
/api/public/llm-connections/:idDelete an LLM connection by id. Evaluators that depend on the deleted connection are automatically paused. - GETllmConnections_listOrganization
/api/public/organizations/llm-connections?page=0&limit=0Get all organization-level LLM connections. Requires an organization-scoped API key. - PUTllmConnections_upsertOrganization
/api/public/organizations/llm-connectionsCreate or update an organization-level LLM connection. The connection is upserted on provider and inherited by projects without a provider override. Requires… - DELETEllmConnections_deleteOrganization
/api/public/organizations/llm-connections/:idDelete an organization-level LLM connection by id. Evaluators in projects without an override for the provider are automatically paused. Requires an…
Media
- GETmedia_get
/api/public/media/:mediaIdGet a media record - PATCHmedia_patch
/api/public/media/:mediaIdPatch a media record - POSTmedia_getUploadUrl
/api/public/mediaGet a presigned upload URL for a media record
Metrics
- GETmetrics_metrics
/api/public/v2/metrics?query=stringGet metrics from the Langfuse project using a query object. V2 endpoint with optimized performance. Together with OpenTelemetry ingestion and Observations API…
Models
- GETmodels_list
/api/public/models?page=0&limit=0Get all models - POSTmodels_create
/api/public/modelsCreate a model - GETmodels_get
/api/public/models/:idGet a model - PUTmodels_upsert
/api/public/models/:idCreate or replace a project-owned model using its id. Built-in models cannot be modified. - DELETEmodels_delete
/api/public/models/:idDelete a model. Cannot delete models managed by Langfuse. You can create your own definition with the same modelName to override the definition though.
Observations
- GETobservations_getMany
/api/public/v2/observations?fields=string&expandMetadata=string&limit=0&cursor=string&parseIoAsJson=true&name=string&userId=string&sessionId=string&type=string&traceId=string&level=DEBUG&parentObservationId=string&isRootObservation=true&environment=string&fromStartTime=2024-01-01T00:00:00Z&toStartTime=2024-01-01T00:00:00Z&version=string&filter=stringGet a list of observations with cursor-based pagination and flexible field selection. Together with OpenTelemetry ingestion and Metrics API v2, this is the…
Opentelemetry
- POSTopentelemetry_exportTraces
/api/public/otel/v1/tracesOpenTelemetry Traces Ingestion Endpoint This endpoint implements the OTLP/HTTP specification for trace ingestion, providing native OpenTelemetry integration…
Organizations
- GETorganizations_getOrganizationMemberships
/api/public/organizations/membershipsGet all memberships for the organization associated with the API key (requires organization-scoped API key) - PUTorganizations_updateOrganizationMembership
/api/public/organizations/membershipsCreate or update a membership for the organization associated with the API key (requires organization-scoped API key) - DELETEorganizations_deleteOrganizationMembership
/api/public/organizations/membershipsDelete a membership from the organization associated with the API key (requires organization-scoped API key) - GETorganizations_getProjectMemberships
/api/public/projects/:projectId/membershipsGet all memberships for a specific project (requires organization-scoped API key) - PUTorganizations_updateProjectMembership
/api/public/projects/:projectId/membershipsCreate or update a membership for a specific project (requires organization-scoped API key). The user must already be a member of the organization. - DELETEorganizations_deleteProjectMembership
/api/public/projects/:projectId/membershipsDelete a membership from a specific project (requires organization-scoped API key). The user must be a member of the organization. - GETorganizations_getOrganizationProjects
/api/public/organizations/projectsGet all projects for the organization associated with the API key (requires organization-scoped API key) - GETorganizations_getOrganizationApiKeys
/api/public/organizations/apiKeysGet all API keys for the organization associated with the API key (requires organization-scoped API key)
Projects
- GETprojects_get
/api/public/projectsGet Project associated with API key (requires project-scoped API key). You can use GET /api/public/organizations/projects to get all projects with an… - POSTprojects_create
/api/public/projectsCreate a new project (requires organization-scoped API key) - PUTprojects_update
/api/public/projects/:projectIdUpdate a project by ID (requires organization-scoped API key). - DELETEprojects_delete
/api/public/projects/:projectIdDelete a project by ID (requires organization-scoped API key). Project deletion is processed asynchronously. Deleting the AI Gateway ingestion project turns… - GETprojects_getApiKeys
/api/public/projects/:projectId/apiKeysGet all API keys for a project (requires organization-scoped API key) - POSTprojects_createApiKey
/api/public/projects/:projectId/apiKeysCreate a new API key for a project (requires organization-scoped API key) - DELETEprojects_deleteApiKey
/api/public/projects/:projectId/apiKeys/:apiKeyIdDelete an API key for a project (requires organization-scoped API key)
PromptVersion
- PATCHpromptVersion_update
/api/public/v2/prompts/:name/versions/:versionUpdate labels for a specific prompt version
Prompts
- GETprompts_get
/api/public/v2/prompts/:promptName?version=0&label=string&resolve=trueGet a prompt - DELETEprompts_delete
/api/public/v2/prompts/:promptName?label=string&version=0Delete prompt versions. If neither version nor label is specified, all versions of the prompt are deleted. - GETprompts_list
/api/public/v2/prompts?name=string&label=string&tag=string&page=0&limit=0&fromUpdatedAt=2024-01-01T00:00:00Z&toUpdatedAt=2024-01-01T00:00:00Z&filter=stringGet a list of prompt names with versions and labels - POSTprompts_create
/api/public/v2/promptsCreate a new version for the prompt with the given name
Scim
- GETscim_getServiceProviderConfig
/api/public/scim/ServiceProviderConfigGet SCIM Service Provider Configuration (requires organization-scoped API key) - GETscim_getResourceTypes
/api/public/scim/ResourceTypesGet SCIM Resource Types (requires organization-scoped API key) - GETscim_getSchemas
/api/public/scim/SchemasGet SCIM Schemas (requires organization-scoped API key) - GETscim_listUsers
/api/public/scim/Users?filter=string&startIndex=0&count=0List users in the organization (requires organization-scoped API key) - POSTscim_createUser
/api/public/scim/UsersCreate a new user in the organization (requires organization-scoped API key) - GETscim_getUser
/api/public/scim/Users/:userIdGet a specific user by ID (requires organization-scoped API key) - DELETEscim_deleteUser
/api/public/scim/Users/:userIdRemove a user from the organization (requires organization-scoped API key). Note that this only removes the user from the organization but does not delete the…
ScoreConfigs
- GETscoreConfigs_get
/api/public/score-configs?page=0&limit=0Get all score configs - POSTscoreConfigs_create
/api/public/score-configsCreate a score configuration (config). Score configs are used to define the structure of scores - GETscoreConfigs_get-by-id
/api/public/score-configs/:configIdGet a score config - PATCHscoreConfigs_update
/api/public/score-configs/:configIdUpdate a score config
Scores
- POSTscores_create
/api/public/scoresCreate scores asynchronously from a list of scores. Returns 202 if all scores are accepted, or 207 with accepted/rejected counts and error messages. Do not… - DELETEscores_delete
/api/public/scores/:scoreIdDelete a score (supports both trace and session scores) - GETscores_getMany
/api/public/v3/scores?limit=0&cursor=string&fields=string&id=string&name=string&source=string&dataType=string&environment=string&configId=string&queueId=string&authorUserId=string&value=string&valueMin=0.0&valueMax=0.0&traceId=string&sessionId=string&observationId=string&experimentId=string&fromTimestamp=2024-01-01T00:00:00Z&toTimestamp=2024-01-01T00:00:00ZGet a list of scores with a polymorphic value field (v3). The value field type depends on dataType: NUMERIC → number BOOLEAN → boolean CATEGORICAL, TEXT,…
Skills
- GETskills_list
/api/public/skills?name=string&search=string&tag=string&page=0&limit=0&fromUpdatedAt=2024-01-01T00:00:00Z&toUpdatedAt=2024-01-01T00:00:00ZList skills with metadata and timestamps from their latest version, shared tags, and the version assigned to production when present. - POSTskills_createVersion
/api/public/skillsCreate skill version - GETskills_get
/api/public/skills/:skillName?version=0&label=string&includeContent=trueResolve a skill's metadata and file manifest by version or label. Defaults to the production label. Set includeContent to return file contents inline, or use… - PATCHskills_update
/api/public/skills/:skillNameReplace the shared tags across all versions of a skill. An empty tags list clears all tags. Returns the latest skill version with the updated tags. - GETskills_getFileContents
/api/public/skills/files/content?sha256Hashes=stringRead a batch of text contents by canonical base64-encoded SHA-256 hashes. - DELETEskills_deleteVersion
/api/public/skills/:skillName/versions/:skillVersionDelete one immutable skill version. Unreferenced blobs are retained for asynchronous cleanup. - PATCHskills_setLabels
/api/public/skills/:skillName/versions/:skillVersionReplace the labels on a skill version and atomically move them from other versions.
Trace
- DELETEtrace_delete
/api/public/traces/:traceIdDelete a specific trace - DELETEtrace_deleteMultiple
/api/public/tracesDelete multiple traces
UnstableDashboardWidgets
- GETunstable_dashboardWidgets_list
/api/public/unstable/dashboard-widgets?page=0&limit=0List dashboard widgets in the project, ordered by most recently updated first. Responses may include legacy traces widgets created before this API existed.… - POSTunstable_dashboardWidgets_create
/api/public/unstable/dashboard-widgetsCreate a dashboard widget (a standalone chart definition you place on any dashboard). This endpoint creates the widget only; place it on a dashboard via POST… - GETunstable_dashboardWidgets_get
/api/public/unstable/dashboard-widgets/:widgetIdGet a dashboard widget by id. The response may use view: traces for legacy widgets. - DELETEunstable_dashboardWidgets_delete
/api/public/unstable/dashboard-widgets/:widgetIdDelete a dashboard widget. The API returns 409 while the widget is still placed on a dashboard. Remove those placements first. - PATCHunstable_dashboardWidgets_update
/api/public/unstable/dashboard-widgets/:widgetIdUpdate a dashboard widget. All fields are optional; at least one field is required. Changing chartType without sending chartConfig resets the config to the…
UnstableDashboards
- GETunstable_dashboards_list
/api/public/unstable/dashboards?page=0&limit=0List dashboards in the project, ordered by most recently updated first. - POSTunstable_dashboards_create
/api/public/unstable/dashboardsCreate a dashboard. - GETunstable_dashboards_get
/api/public/unstable/dashboards/:dashboardIdGet a dashboard by id. - DELETEunstable_dashboards_delete
/api/public/unstable/dashboards/:dashboardIdDelete a dashboard. - PATCHunstable_dashboards_update
/api/public/unstable/dashboards/:dashboardIdUpdate a dashboard's name, description, definition, or filters. - POSTunstable_dashboards_addPlacement
/api/public/unstable/dashboards/:dashboardId/placementsAdd a placement to a dashboard grid (see DashboardPlacement for grid semantics). id and the position fields are optional: when omitted, the placement gets a… - DELETEunstable_dashboards_deletePlacement
/api/public/unstable/dashboards/:dashboardId/placements/:placementIdRemove a placement from a dashboard grid without deleting the referenced widget. - PATCHunstable_dashboards_updatePlacement
/api/public/unstable/dashboards/:dashboardId/placements/:placementIdMove or resize a placement. All fields are optional; at least one is required. Omitted fields keep their current value. The placement's content (widget/preset…
UnstableTopics
- GETunstable_topics_listFacets
/api/public/unstable/topic-facets?filter=string&page=0&limit=0Unstable: Topics is in closed beta. The shape may change without notice. List the project's Topics facets. Only active facets (run by a Topics rule, or all… - GETunstable_topics_getFacet
/api/public/unstable/topic-facets/:facetIdUnstable: Topics is in closed beta. The shape may change without notice. Get one Topics facet by id, including inactive facets. - GETunstable_topics_list
/api/public/unstable/topics?fromTimestamp=2024-01-01T00:00:00Z&toTimestamp=2024-01-01T00:00:00Z&filter=string&orderBy=traceCount.desc&page=0&limit=0Unstable: Topics is in closed beta. The shape may change without notice. List the topics of each active facet's live map, with the number of traces currently… - GETunstable_topics_get
/api/public/unstable/topics/:topicId?fromTimestamp=2024-01-01T00:00:00Z&toTimestamp=2024-01-01T00:00:00ZUnstable: Topics is in closed beta. The shape may change without notice. Get one topic of a facet's current map by its stable id. Retired topics are not found. - GETunstable_topics_listRules
/api/public/unstable/topic-rules?filter=string&page=0&limit=0Unstable: Topics is in closed beta. The shape may change without notice. List the project's Topics rules. A rule selects traces with an observation filter and… - GETunstable_topics_getRule
/api/public/unstable/topic-rules/:ruleIdUnstable: Topics is in closed beta. The shape may change without notice. Get one Topics rule by id. - GETunstable_topics_listSummaries
/api/public/unstable/topic-summaries?fromTimestamp=2024-01-01T00:00:00Z&toTimestamp=2024-01-01T00:00:00Z&filter=string&truncateSummaries=true&orderBy=timestamp.desc&limit=0&cursor=stringUnstable: Topics is in closed beta. The shape may change without notice. List the current Topics summary per trace and facet: what the trace is about from the… - GETunstable_topics_listAssignments
/api/public/unstable/topic-assignments?fromTimestamp=2024-01-01T00:00:00Z&toTimestamp=2024-01-01T00:00:00Z&filter=string&orderBy=timestamp.desc&limit=0&cursor=stringUnstable: Topics is in closed beta. The shape may change without notice. List the current topic per trace, facet and rule on each rule's live map: assigned…
API details
- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 120 operations on 74 pathsGET 58POST 22DELETE 22PATCH 11PUT 7
- Main resources
- AnnotationQueues 10Organizations 8UnstableDashboards 8UnstableTopics 8Projects 7Scim 7Skills 7Evaluators 6LlmConnections 6EvaluationRules 5
- Response formats
application/json- Description format
- OpenAPI 3.0.1
- Links
- OpenAPI document
- Listed from
- Langfuse's published OpenAPI description (langfuse/langfuse) (MIT)
How to test the server in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the server collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “annotationQueues_listQueues” (GET /api/public/annotation-queues?page=0&limit=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the server?
Real-time data The only real-time path to get tracing data is to ingest via OpenTelemetry (POST /api/public/otel/v1/traces) and retrieve via Observations API… It is listed under AI & machine learning and has 120 endpoints.
Who publishes the server?
It is listed from Langfuse's public API description (an OpenAPI document), not published by Langfuse on Swastik Codes. Anyone who controls langfuse.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the server?
With HTTP Basic authentication (username and password).
How many endpoints does the server have?
120 operations on 74 paths (58 GET, 22 POST, 22 DELETE, 11 PATCH, 7 PUT). The largest groups are AnnotationQueues, Organizations, UnstableDashboards, UnstableTopics.
Is forking the server free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.