{ "openapi": "3.0.1", "info": { "title": "langfuse", "version": "", "description": "## Authentication\n\nAuthenticate with the API using [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication), get API keys in the project settings:\n\n- username: Langfuse Public Key\n- password: Langfuse Secret Key\n\n## Exports\n\n- OpenAPI spec: https://cloud.langfuse.com/generated/api/openapi.yml\n- Postman collection: https://cloud.langfuse.com/generated/postman/collection.json" }, "paths": { "/api/public/annotation-queues": { "get": { "description": "Get all annotation queues", "operationId": "annotationQueues_listQueues", "tags": [ "AnnotationQueues" ], "parameters": [ { "name": "page", "in": "query", "description": "page number, starts at 1", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "limit of items per page", "required": false, "schema": { "type": "integer", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAnnotationQueues" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "post": { "description": "Create an annotation queue", "operationId": "annotationQueues_createQueue", "tags": [ "AnnotationQueues" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationQueue" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnnotationQueueRequest" } } } } } }, "/api/public/annotation-queues/{queueId}": { "get": { "description": "Get an annotation queue by ID", "operationId": "annotationQueues_getQueue", "tags": [ "AnnotationQueues" ], "parameters": [ { "name": "queueId", "in": "path", "description": "The unique identifier of the annotation queue", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationQueue" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/annotation-queues/{queueId}/items": { "get": { "description": "Get items for a specific annotation queue", "operationId": "annotationQueues_listQueueItems", "tags": [ "AnnotationQueues" ], "parameters": [ { "name": "queueId", "in": "path", "description": "The unique identifier of the annotation queue", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by status", "required": false, "schema": { "$ref": "#/components/schemas/AnnotationQueueStatus", "nullable": true } }, { "name": "page", "in": "query", "description": "page number, starts at 1", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "limit of items per page", "required": false, "schema": { "type": "integer", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAnnotationQueueItems" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "post": { "description": "Add an item to an annotation queue", "operationId": "annotationQueues_createQueueItem", "tags": [ "AnnotationQueues" ], "parameters": [ { "name": "queueId", "in": "path", "description": "The unique identifier of the annotation queue", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationQueueItem" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnnotationQueueItemRequest" } } } } } }, "/api/public/annotation-queues/{queueId}/items/{itemId}": { "get": { "description": "Get a specific item from an annotation queue", "operationId": "annotationQueues_getQueueItem", "tags": [ "AnnotationQueues" ], "parameters": [ { "name": "queueId", "in": "path", "description": "The unique identifier of the annotation queue", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "description": "The unique identifier of the annotation queue item", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationQueueItem" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "patch": { "description": "Update an annotation queue item", "operationId": "annotationQueues_updateQueueItem", "tags": [ "AnnotationQueues" ], "parameters": [ { "name": "queueId", "in": "path", "description": "The unique identifier of the annotation queue", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "description": "The unique identifier of the annotation queue item", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationQueueItem" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnnotationQueueItemRequest" } } } } }, "delete": { "description": "Remove an item from an annotation queue", "operationId": "annotationQueues_deleteQueueItem", "tags": [ "AnnotationQueues" ], "parameters": [ { "name": "queueId", "in": "path", "description": "The unique identifier of the annotation queue", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "description": "The unique identifier of the annotation queue item", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAnnotationQueueItemResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/annotation-queues/{queueId}/assignments": { "post": { "description": "Create an assignment for a user to an annotation queue", "operationId": "annotationQueues_createQueueAssignment", "tags": [ "AnnotationQueues" ], "parameters": [ { "name": "queueId", "in": "path", "description": "The unique identifier of the annotation queue", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnnotationQueueAssignmentResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationQueueAssignmentRequest" } } } } }, "delete": { "description": "Delete an assignment for a user to an annotation queue", "operationId": "annotationQueues_deleteQueueAssignment", "tags": [ "AnnotationQueues" ], "parameters": [ { "name": "queueId", "in": "path", "description": "The unique identifier of the annotation queue", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAnnotationQueueAssignmentResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationQueueAssignmentRequest" } } } } } }, "/api/public/comments": { "post": { "description": "Create a comment. Comments may be attached to different object types (trace, observation, session, prompt).", "operationId": "comments_create", "tags": [ "Comments" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommentResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommentRequest" } } } } }, "get": { "description": "Get all comments", "operationId": "comments_get", "tags": [ "Comments" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number, starts at 1.", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "objectType", "in": "query", "description": "Filter comments by object type (trace, observation, session, prompt).", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "objectId", "in": "query", "description": "Filter comments by object id. If objectType is not provided, an error will be thrown.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "authorUserId", "in": "query", "description": "Filter comments by author user id.", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCommentsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/comments/{commentId}": { "get": { "description": "Get a comment by id", "operationId": "comments_get-by-id", "tags": [ "Comments" ], "parameters": [ { "name": "commentId", "in": "path", "description": "The unique langfuse identifier of a comment", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comment" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/dataset-items": { "post": { "description": "Create a dataset item", "operationId": "datasetItems_create", "tags": [ "DatasetItems" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetItem" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDatasetItemRequest" } } } } }, "get": { "description": "Get dataset items", "operationId": "datasetItems_list", "tags": [ "DatasetItems" ], "parameters": [ { "name": "datasetName", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "sourceTraceId", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "sourceObservationId", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "page", "in": "query", "description": "page number, starts at 1", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "limit of items per page", "required": false, "schema": { "type": "integer", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDatasetItems" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/dataset-items/{id}": { "get": { "description": "Get a dataset item", "operationId": "datasetItems_get", "tags": [ "DatasetItems" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetItem" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "delete": { "description": "Delete a dataset item and all its run items. This action is irreversible.", "operationId": "datasetItems_delete", "tags": [ "DatasetItems" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDatasetItemResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/dataset-run-items": { "post": { "description": "Create a dataset run item", "operationId": "datasetRunItems_create", "tags": [ "DatasetRunItems" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetRunItem" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDatasetRunItemRequest" } } } } }, "get": { "description": "List dataset run items", "operationId": "datasetRunItems_list", "tags": [ "DatasetRunItems" ], "parameters": [ { "name": "datasetId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "runName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "page number, starts at 1", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "limit of items per page", "required": false, "schema": { "type": "integer", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDatasetRunItems" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/v2/datasets": { "get": { "description": "Get all datasets", "operationId": "datasets_list", "tags": [ "Datasets" ], "parameters": [ { "name": "page", "in": "query", "description": "page number, starts at 1", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "limit of items per page", "required": false, "schema": { "type": "integer", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDatasets" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "post": { "description": "Create a dataset", "operationId": "datasets_create", "tags": [ "Datasets" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dataset" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDatasetRequest" } } } } } }, "/api/public/v2/datasets/{datasetName}": { "get": { "description": "Get a dataset", "operationId": "datasets_get", "tags": [ "Datasets" ], "parameters": [ { "name": "datasetName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dataset" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/datasets/{datasetName}/runs/{runName}": { "get": { "description": "Get a dataset run and its items", "operationId": "datasets_getRun", "tags": [ "Datasets" ], "parameters": [ { "name": "datasetName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetRunWithItems" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "delete": { "description": "Delete a dataset run and all its run items. This action is irreversible.", "operationId": "datasets_deleteRun", "tags": [ "Datasets" ], "parameters": [ { "name": "datasetName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDatasetRunResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/datasets/{datasetName}/runs": { "get": { "description": "Get dataset runs", "operationId": "datasets_getRuns", "tags": [ "Datasets" ], "parameters": [ { "name": "datasetName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "page number, starts at 1", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "limit of items per page", "required": false, "schema": { "type": "integer", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDatasetRuns" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/health": { "get": { "description": "Check health of API and database", "operationId": "health_health", "tags": [ "Health" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } }, "503": { "description": "" } } } }, "/api/public/ingestion": { "post": { "description": "Batched ingestion for Langfuse Tracing.\nIf you want to use tracing via the API, such as to build your own Langfuse client implementation, this is the only API route you need to implement.\n\nWithin each batch, there can be multiple events.\nEach event has a type, an id, a timestamp, metadata and a body.\nInternally, we refer to this as the \"event envelope\" as it tells us something about the event but not the trace.\nWe use the event id within this envelope to deduplicate messages to avoid processing the same event twice, i.e. the event id should be unique per request.\nThe event.body.id is the ID of the actual trace and will be used for updates and will be visible within the Langfuse App.\nI.e. if you want to update a trace, you'd use the same body id, but separate event IDs.\n\nNotes:\n- Introduction to data model: https://langfuse.com/docs/tracing-data-model\n- Batch sizes are limited to 3.5 MB in total. You need to adjust the number of events per batch accordingly.\n- The API does not return a 4xx status code for input errors. Instead, it responds with a 207 status code, which includes a list of the encountered errors.", "operationId": "ingestion_batch", "tags": [ "Ingestion" ], "parameters": [], "responses": { "207": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionResponse" }, "examples": { "Example1": { "value": { "successes": [ { "id": "abcdef-1234-5678-90ab", "status": 201 } ], "errors": [] } }, "Example2": { "value": { "successes": [ { "id": "abcdef-1234-5678-90ab", "status": 201 } ], "errors": [] } }, "Example3": { "value": { "successes": [ { "id": "abcdef-1234-5678-90ab", "status": 201 } ], "errors": [] } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "batch": { "type": "array", "items": { "$ref": "#/components/schemas/IngestionEvent" }, "description": "Batch of tracing events to be ingested. Discriminated by attribute `type`." }, "metadata": { "nullable": true, "description": "Optional. Metadata field used by the Langfuse SDKs for debugging." } }, "required": [ "batch" ] }, "examples": { "Example1": { "value": { "batch": [ { "id": "abcdef-1234-5678-90ab", "timestamp": "2022-01-01T00:00:00.000Z", "type": "trace-create", "body": { "id": "abcdef-1234-5678-90ab", "timestamp": "2022-01-01T00:00:00.000Z", "environment": "production", "name": "My Trace", "userId": "1234-5678-90ab-cdef", "input": "My input", "output": "My output", "sessionId": "1234-5678-90ab-cdef", "release": "1.0.0", "version": "1.0.0", "metadata": "My metadata", "tags": [ "tag1", "tag2" ], "public": true } } ] } }, "Example2": { "value": { "batch": [ { "id": "abcdef-1234-5678-90ab", "timestamp": "2022-01-01T00:00:00.000Z", "type": "span-create", "body": { "id": "abcdef-1234-5678-90ab", "traceId": "1234-5678-90ab-cdef", "startTime": "2022-01-01T00:00:00.000Z", "environment": "test" } } ] } }, "Example3": { "value": { "batch": [ { "id": "abcdef-1234-5678-90ab", "timestamp": "2022-01-01T00:00:00.000Z", "type": "score-create", "body": { "id": "abcdef-1234-5678-90ab", "traceId": "1234-5678-90ab-cdef", "name": "My Score", "value": 0.9, "environment": "default" } } ] } } } } } } } }, "/api/public/llm-connections": { "get": { "description": "Get all LLM connections in a project", "operationId": "llmConnections_list", "tags": [ "LlmConnections" ], "parameters": [ { "name": "page", "in": "query", "description": "page number, starts at 1", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "limit of items per page", "required": false, "schema": { "type": "integer", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLlmConnections" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "put": { "description": "Create or update an LLM connection. The connection is upserted on provider.", "operationId": "llmConnections_upsert", "tags": [ "LlmConnections" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LlmConnection" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertLlmConnectionRequest" } } } } } }, "/api/public/media/{mediaId}": { "get": { "description": "Get a media record", "operationId": "media_get", "tags": [ "Media" ], "parameters": [ { "name": "mediaId", "in": "path", "description": "The unique langfuse identifier of a media record", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMediaResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "patch": { "description": "Patch a media record", "operationId": "media_patch", "tags": [ "Media" ], "parameters": [ { "name": "mediaId", "in": "path", "description": "The unique langfuse identifier of a media record", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchMediaBody" } } } } } }, "/api/public/media": { "post": { "description": "Get a presigned upload URL for a media record", "operationId": "media_getUploadUrl", "tags": [ "Media" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMediaUploadUrlResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMediaUploadUrlRequest" } } } } } }, "/api/public/metrics": { "get": { "description": "Get metrics from the Langfuse project using a query object", "operationId": "metrics_metrics", "tags": [ "Metrics" ], "parameters": [ { "name": "query", "in": "query", "description": "JSON string containing the query parameters with the following structure:\n```json\n{\n \"view\": string, // Required. One of \"traces\", \"observations\", \"scores-numeric\", \"scores-categorical\"\n \"dimensions\": [ // Optional. Default: []\n {\n \"field\": string // Field to group by, e.g. \"name\", \"userId\", \"sessionId\"\n }\n ],\n \"metrics\": [ // Required. At least one metric must be provided\n {\n \"measure\": string, // What to measure, e.g. \"count\", \"latency\", \"value\"\n \"aggregation\": string // How to aggregate, e.g. \"count\", \"sum\", \"avg\", \"p95\", \"histogram\"\n }\n ],\n \"filters\": [ // Optional. Default: []\n {\n \"column\": string, // Column to filter on\n \"operator\": string, // Operator, e.g. \"=\", \">\", \"<\", \"contains\"\n \"value\": any, // Value to compare against\n \"type\": string, // Data type, e.g. \"string\", \"number\", \"stringObject\"\n \"key\": string // Required only when filtering on metadata\n }\n ],\n \"timeDimension\": { // Optional. Default: null. If provided, results will be grouped by time\n \"granularity\": string // One of \"minute\", \"hour\", \"day\", \"week\", \"month\", \"auto\"\n },\n \"fromTimestamp\": string, // Required. ISO datetime string for start of time range\n \"toTimestamp\": string, // Required. ISO datetime string for end of time range\n \"orderBy\": [ // Optional. Default: null\n {\n \"field\": string, // Field to order by\n \"direction\": string // \"asc\" or \"desc\"\n }\n ],\n \"config\": { // Optional. Query-specific configuration\n \"bins\": number, // Optional. Number of bins for histogram (1-100), default: 10\n \"row_limit\": number // Optional. Row limit for results (1-1000)\n }\n}\n```", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/models": { "post": { "description": "Create a model", "operationId": "models_create", "tags": [ "Models" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Model" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateModelRequest" } } } } }, "get": { "description": "Get all models", "operationId": "models_list", "tags": [ "Models" ], "parameters": [ { "name": "page", "in": "query", "description": "page number, starts at 1", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "limit of items per page", "required": false, "schema": { "type": "integer", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedModels" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/models/{id}": { "get": { "description": "Get a model", "operationId": "models_get", "tags": [ "Models" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Model" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "delete": { "description": "Delete a model. Cannot delete models managed by Langfuse. You can create your own definition with the same modelName to override the definition though.", "operationId": "models_delete", "tags": [ "Models" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/observations/{observationId}": { "get": { "description": "Get a observation", "operationId": "observations_get", "tags": [ "Observations" ], "parameters": [ { "name": "observationId", "in": "path", "description": "The unique langfuse identifier of an observation, can be an event, span or generation", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObservationsView" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/observations": { "get": { "description": "Get a list of observations", "operationId": "observations_getMany", "tags": [ "Observations" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number, starts at 1.", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit.", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "traceId", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "level", "in": "query", "description": "Optional filter for observations with a specific level (e.g. \"DEBUG\", \"DEFAULT\", \"WARNING\", \"ERROR\").", "required": false, "schema": { "$ref": "#/components/schemas/ObservationLevel", "nullable": true } }, { "name": "parentObservationId", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "environment", "in": "query", "description": "Optional filter for observations where the environment is one of the provided values.", "required": false, "schema": { "type": "array", "items": { "type": "string", "nullable": true } } }, { "name": "fromStartTime", "in": "query", "description": "Retrieve only observations with a start_time on or after this datetime (ISO 8601).", "required": false, "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "toStartTime", "in": "query", "description": "Retrieve only observations with a start_time before this datetime (ISO 8601).", "required": false, "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "version", "in": "query", "description": "Optional filter to only include observations with a certain version.", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObservationsViews" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/organizations/memberships": { "get": { "description": "Get all memberships for the organization associated with the API key (requires organization-scoped API key)", "operationId": "organizations_getOrganizationMemberships", "tags": [ "Organizations" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "put": { "description": "Create or update a membership for the organization associated with the API key (requires organization-scoped API key)", "operationId": "organizations_updateOrganizationMembership", "tags": [ "Organizations" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipRequest" } } } } } }, "/api/public/projects/{projectId}/memberships": { "get": { "description": "Get all memberships for a specific project (requires organization-scoped API key)", "operationId": "organizations_getProjectMemberships", "tags": [ "Organizations" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "put": { "description": "Create or update a membership for a specific project (requires organization-scoped API key). The user must already be a member of the organization.", "operationId": "organizations_updateProjectMembership", "tags": [ "Organizations" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipRequest" } } } } } }, "/api/public/organizations/projects": { "get": { "description": "Get all projects for the organization associated with the API key (requires organization-scoped API key)", "operationId": "organizations_getOrganizationProjects", "tags": [ "Organizations" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationProjectsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/projects": { "get": { "description": "Get Project associated with API key", "operationId": "projects_get", "tags": [ "Projects" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "post": { "description": "Create a new project (requires organization-scoped API key)", "operationId": "projects_create", "tags": [ "Projects" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Optional metadata for the project" }, "retention": { "type": "integer", "description": "Number of days to retain data. Must be 0 or at least 3 days. Requires data-retention entitlement for non-zero values. Optional." } }, "required": [ "name", "retention" ] } } } } } }, "/api/public/projects/{projectId}": { "put": { "description": "Update a project by ID (requires organization-scoped API key).", "operationId": "projects_update", "tags": [ "Projects" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Optional metadata for the project" }, "retention": { "type": "integer", "description": "Number of days to retain data. Must be 0 or at least 3 days. Requires data-retention entitlement for non-zero values. Optional." } }, "required": [ "name", "retention" ] } } } } }, "delete": { "description": "Delete a project by ID (requires organization-scoped API key). Project deletion is processed asynchronously.", "operationId": "projects_delete", "tags": [ "Projects" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDeletionResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/projects/{projectId}/apiKeys": { "get": { "description": "Get all API keys for a project (requires organization-scoped API key)", "operationId": "projects_getApiKeys", "tags": [ "Projects" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyList" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "post": { "description": "Create a new API key for a project (requires organization-scoped API key)", "operationId": "projects_createApiKey", "tags": [ "Projects" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "string", "nullable": true, "description": "Optional note for the API key" } } } } } } } }, "/api/public/projects/{projectId}/apiKeys/{apiKeyId}": { "delete": { "description": "Delete an API key for a project (requires organization-scoped API key)", "operationId": "projects_deleteApiKey", "tags": [ "Projects" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "apiKeyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyDeletionResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/v2/prompts/{name}/versions/{version}": { "patch": { "description": "Update labels for a specific prompt version", "operationId": "promptVersion_update", "tags": [ "PromptVersion" ], "parameters": [ { "name": "name", "in": "path", "description": "The name of the prompt", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "Version of the prompt to update", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Prompt" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "newLabels": { "type": "array", "items": { "type": "string" }, "description": "New labels for the prompt version. Labels are unique across versions. The \"latest\" label is reserved and managed by Langfuse." } }, "required": [ "newLabels" ] } } } } } }, "/api/public/v2/prompts/{promptName}": { "get": { "description": "Get a prompt", "operationId": "prompts_get", "tags": [ "Prompts" ], "parameters": [ { "name": "promptName", "in": "path", "description": "The name of the prompt", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "Version of the prompt to be retrieved.", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "label", "in": "query", "description": "Label of the prompt to be retrieved. Defaults to \"production\" if no label or version is set.", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Prompt" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/v2/prompts": { "get": { "description": "Get a list of prompt names with versions and labels", "operationId": "prompts_list", "tags": [ "Prompts" ], "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "tag", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "page", "in": "query", "description": "page number, starts at 1", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "limit of items per page", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "fromUpdatedAt", "in": "query", "description": "Optional filter to only include prompt versions created/updated on or after a certain datetime (ISO 8601)", "required": false, "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "toUpdatedAt", "in": "query", "description": "Optional filter to only include prompt versions created/updated before a certain datetime (ISO 8601)", "required": false, "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptMetaListResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "post": { "description": "Create a new version for the prompt with the given `name`", "operationId": "prompts_create", "tags": [ "Prompts" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Prompt" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePromptRequest" } } } } } }, "/api/public/scim/ServiceProviderConfig": { "get": { "description": "Get SCIM Service Provider Configuration (requires organization-scoped API key)", "operationId": "scim_getServiceProviderConfig", "tags": [ "Scim" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceProviderConfig" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/scim/ResourceTypes": { "get": { "description": "Get SCIM Resource Types (requires organization-scoped API key)", "operationId": "scim_getResourceTypes", "tags": [ "Scim" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTypesResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/scim/Schemas": { "get": { "description": "Get SCIM Schemas (requires organization-scoped API key)", "operationId": "scim_getSchemas", "tags": [ "Scim" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemasResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/scim/Users": { "get": { "description": "List users in the organization (requires organization-scoped API key)", "operationId": "scim_listUsers", "tags": [ "Scim" ], "parameters": [ { "name": "filter", "in": "query", "description": "Filter expression (e.g. userName eq \"value\")", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "startIndex", "in": "query", "description": "1-based index of the first result to return (default 1)", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "count", "in": "query", "description": "Maximum number of results to return (default 100)", "required": false, "schema": { "type": "integer", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScimUsersListResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "post": { "description": "Create a new user in the organization (requires organization-scoped API key)", "operationId": "scim_createUser", "tags": [ "Scim" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScimUser" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userName": { "type": "string", "description": "User's email address (required)" }, "name": { "$ref": "#/components/schemas/ScimName", "description": "User's name information" }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/ScimEmail" }, "nullable": true, "description": "User's email addresses" }, "active": { "type": "boolean", "nullable": true, "description": "Whether the user is active" }, "password": { "type": "string", "nullable": true, "description": "Initial password for the user" } }, "required": [ "userName", "name" ] } } } } } }, "/api/public/scim/Users/{userId}": { "get": { "description": "Get a specific user by ID (requires organization-scoped API key)", "operationId": "scim_getUser", "tags": [ "Scim" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScimUser" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "delete": { "description": "Remove 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 user entity itself.", "operationId": "scim_deleteUser", "tags": [ "Scim" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/score-configs": { "post": { "description": "Create a score configuration (config). Score configs are used to define the structure of scores", "operationId": "scoreConfigs_create", "tags": [ "ScoreConfigs" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScoreConfig" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateScoreConfigRequest" } } } } }, "get": { "description": "Get all score configs", "operationId": "scoreConfigs_get", "tags": [ "ScoreConfigs" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number, starts at 1.", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit", "required": false, "schema": { "type": "integer", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScoreConfigs" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/score-configs/{configId}": { "get": { "description": "Get a score config", "operationId": "scoreConfigs_get-by-id", "tags": [ "ScoreConfigs" ], "parameters": [ { "name": "configId", "in": "path", "description": "The unique langfuse identifier of a score config", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScoreConfig" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/v2/scores": { "get": { "description": "Get a list of scores (supports both trace and session scores)", "operationId": "scoreV2_get", "tags": [ "ScoreV2" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number, starts at 1.", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit.", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "userId", "in": "query", "description": "Retrieve only scores with this userId associated to the trace.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "name", "in": "query", "description": "Retrieve only scores with this name.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "fromTimestamp", "in": "query", "description": "Optional filter to only include scores created on or after a certain datetime (ISO 8601)", "required": false, "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "toTimestamp", "in": "query", "description": "Optional filter to only include scores created before a certain datetime (ISO 8601)", "required": false, "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "environment", "in": "query", "description": "Optional filter for scores where the environment is one of the provided values.", "required": false, "schema": { "type": "array", "items": { "type": "string", "nullable": true } } }, { "name": "source", "in": "query", "description": "Retrieve only scores from a specific source.", "required": false, "schema": { "$ref": "#/components/schemas/ScoreSource", "nullable": true } }, { "name": "operator", "in": "query", "description": "Retrieve only scores with value.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "value", "in": "query", "description": "Retrieve only scores with value.", "required": false, "schema": { "type": "number", "format": "double", "nullable": true } }, { "name": "scoreIds", "in": "query", "description": "Comma-separated list of score IDs to limit the results to.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "configId", "in": "query", "description": "Retrieve only scores with a specific configId.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "queueId", "in": "query", "description": "Retrieve only scores with a specific annotation queueId.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "dataType", "in": "query", "description": "Retrieve only scores with a specific dataType.", "required": false, "schema": { "$ref": "#/components/schemas/ScoreDataType", "nullable": true } }, { "name": "traceTags", "in": "query", "description": "Only scores linked to traces that include all of these tags will be returned.", "required": false, "schema": { "type": "array", "items": { "type": "string", "nullable": true } } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetScoresResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/v2/scores/{scoreId}": { "get": { "description": "Get a score (supports both trace and session scores)", "operationId": "scoreV2_get-by-id", "tags": [ "ScoreV2" ], "parameters": [ { "name": "scoreId", "in": "path", "description": "The unique langfuse identifier of a score", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Score" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/scores": { "post": { "description": "Create a score (supports both trace and session scores)", "operationId": "score_create", "tags": [ "Score" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateScoreResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateScoreRequest" } } } } } }, "/api/public/scores/{scoreId}": { "delete": { "description": "Delete a score (supports both trace and session scores)", "operationId": "score_delete", "tags": [ "Score" ], "parameters": [ { "name": "scoreId", "in": "path", "description": "The unique langfuse identifier of a score", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/sessions": { "get": { "description": "Get sessions", "operationId": "sessions_list", "tags": [ "Sessions" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number, starts at 1", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit.", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "fromTimestamp", "in": "query", "description": "Optional filter to only include sessions created on or after a certain datetime (ISO 8601)", "required": false, "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "toTimestamp", "in": "query", "description": "Optional filter to only include sessions created before a certain datetime (ISO 8601)", "required": false, "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "environment", "in": "query", "description": "Optional filter for sessions where the environment is one of the provided values.", "required": false, "schema": { "type": "array", "items": { "type": "string", "nullable": true } } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSessions" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/sessions/{sessionId}": { "get": { "description": "Get a session. Please note that `traces` on this endpoint are not paginated, if you plan to fetch large sessions, consider `GET /api/public/traces?sessionId=`", "operationId": "sessions_get", "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "description": "The unique id of a session", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionWithTraces" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/traces/{traceId}": { "get": { "description": "Get a specific trace", "operationId": "trace_get", "tags": [ "Trace" ], "parameters": [ { "name": "traceId", "in": "path", "description": "The unique langfuse identifier of a trace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TraceWithFullDetails" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "delete": { "description": "Delete a specific trace", "operationId": "trace_delete", "tags": [ "Trace" ], "parameters": [ { "name": "traceId", "in": "path", "description": "The unique langfuse identifier of the trace to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTraceResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] } }, "/api/public/traces": { "get": { "description": "Get list of traces", "operationId": "trace_list", "tags": [ "Trace" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number, starts at 1", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "limit", "in": "query", "description": "Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit.", "required": false, "schema": { "type": "integer", "nullable": true } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "sessionId", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "fromTimestamp", "in": "query", "description": "Optional filter to only include traces with a trace.timestamp on or after a certain datetime (ISO 8601)", "required": false, "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "toTimestamp", "in": "query", "description": "Optional filter to only include traces with a trace.timestamp before a certain datetime (ISO 8601)", "required": false, "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "orderBy", "in": "query", "description": "Format of the string [field].[asc/desc]. Fields: id, timestamp, name, userId, release, version, public, bookmarked, sessionId. Example: timestamp.asc", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "tags", "in": "query", "description": "Only traces that include all of these tags will be returned.", "required": false, "schema": { "type": "array", "items": { "type": "string", "nullable": true } } }, { "name": "version", "in": "query", "description": "Optional filter to only include traces with a certain version.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "release", "in": "query", "description": "Optional filter to only include traces with a certain release.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "environment", "in": "query", "description": "Optional filter for traces where the environment is one of the provided values.", "required": false, "schema": { "type": "array", "items": { "type": "string", "nullable": true } } }, { "name": "fields", "in": "query", "description": "Comma-separated list of fields to include in the response. Available field groups are 'core' (always included), 'io' (input, output, metadata), 'scores', 'observations', 'metrics'. If not provided, all fields are included. Example: 'core,scores,metrics'", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Traces" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ] }, "delete": { "description": "Delete multiple traces", "operationId": "trace_deleteMultiple", "tags": [ "Trace" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTraceResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": {} } } }, "401": { "description": "", "content": { "application/json": { "schema": {} } } }, "403": { "description": "", "content": { "application/json": { "schema": {} } } }, "404": { "description": "", "content": { "application/json": { "schema": {} } } }, "405": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BasicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "traceIds": { "type": "array", "items": { "type": "string" }, "description": "List of trace IDs to delete" } }, "required": [ "traceIds" ] } } } } } } }, "components": { "schemas": { "AnnotationQueueStatus": { "title": "AnnotationQueueStatus", "type": "string", "enum": [ "PENDING", "COMPLETED" ] }, "AnnotationQueueObjectType": { "title": "AnnotationQueueObjectType", "type": "string", "enum": [ "TRACE", "OBSERVATION" ] }, "AnnotationQueue": { "title": "AnnotationQueue", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "scoreConfigIds": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "scoreConfigIds", "createdAt", "updatedAt" ] }, "AnnotationQueueItem": { "title": "AnnotationQueueItem", "type": "object", "properties": { "id": { "type": "string" }, "queueId": { "type": "string" }, "objectId": { "type": "string" }, "objectType": { "$ref": "#/components/schemas/AnnotationQueueObjectType" }, "status": { "$ref": "#/components/schemas/AnnotationQueueStatus" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "queueId", "objectId", "objectType", "status", "createdAt", "updatedAt" ] }, "PaginatedAnnotationQueues": { "title": "PaginatedAnnotationQueues", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AnnotationQueue" } }, "meta": { "$ref": "#/components/schemas/utilsMetaResponse" } }, "required": [ "data", "meta" ] }, "PaginatedAnnotationQueueItems": { "title": "PaginatedAnnotationQueueItems", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AnnotationQueueItem" } }, "meta": { "$ref": "#/components/schemas/utilsMetaResponse" } }, "required": [ "data", "meta" ] }, "CreateAnnotationQueueRequest": { "title": "CreateAnnotationQueueRequest", "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "scoreConfigIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "scoreConfigIds" ] }, "CreateAnnotationQueueItemRequest": { "title": "CreateAnnotationQueueItemRequest", "type": "object", "properties": { "objectId": { "type": "string" }, "objectType": { "$ref": "#/components/schemas/AnnotationQueueObjectType" }, "status": { "$ref": "#/components/schemas/AnnotationQueueStatus", "nullable": true, "description": "Defaults to PENDING for new queue items" } }, "required": [ "objectId", "objectType" ] }, "UpdateAnnotationQueueItemRequest": { "title": "UpdateAnnotationQueueItemRequest", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AnnotationQueueStatus", "nullable": true } } }, "DeleteAnnotationQueueItemResponse": { "title": "DeleteAnnotationQueueItemResponse", "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "success", "message" ] }, "AnnotationQueueAssignmentRequest": { "title": "AnnotationQueueAssignmentRequest", "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] }, "DeleteAnnotationQueueAssignmentResponse": { "title": "DeleteAnnotationQueueAssignmentResponse", "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "CreateAnnotationQueueAssignmentResponse": { "title": "CreateAnnotationQueueAssignmentResponse", "type": "object", "properties": { "userId": { "type": "string" }, "queueId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "userId", "queueId", "projectId" ] }, "CreateCommentRequest": { "title": "CreateCommentRequest", "type": "object", "properties": { "projectId": { "type": "string", "description": "The id of the project to attach the comment to." }, "objectType": { "type": "string", "description": "The type of the object to attach the comment to (trace, observation, session, prompt)." }, "objectId": { "type": "string", "description": "The id of the object to attach the comment to. If this does not reference a valid existing object, an error will be thrown." }, "content": { "type": "string", "description": "The content of the comment. May include markdown. Currently limited to 3000 characters." }, "authorUserId": { "type": "string", "nullable": true, "description": "The id of the user who created the comment." } }, "required": [ "projectId", "objectType", "objectId", "content" ] }, "CreateCommentResponse": { "title": "CreateCommentResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The id of the created object in Langfuse" } }, "required": [ "id" ] }, "GetCommentsResponse": { "title": "GetCommentsResponse", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } }, "meta": { "$ref": "#/components/schemas/utilsMetaResponse" } }, "required": [ "data", "meta" ] }, "Trace": { "title": "Trace", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a trace" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp when the trace was created" }, "name": { "type": "string", "nullable": true, "description": "The name of the trace" }, "input": { "nullable": true, "description": "The input data of the trace. Can be any JSON." }, "output": { "nullable": true, "description": "The output data of the trace. Can be any JSON." }, "sessionId": { "type": "string", "nullable": true, "description": "The session identifier associated with the trace" }, "release": { "type": "string", "nullable": true, "description": "The release version of the application when the trace was created" }, "version": { "type": "string", "nullable": true, "description": "The version of the trace" }, "userId": { "type": "string", "nullable": true, "description": "The user identifier associated with the trace" }, "metadata": { "nullable": true, "description": "The metadata associated with the trace. Can be any JSON." }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The tags associated with the trace. Can be an array of strings or null." }, "public": { "type": "boolean", "nullable": true, "description": "Public traces are accessible via url without login" }, "environment": { "type": "string", "nullable": true, "description": "The environment from which this trace originated. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'langfuse'." } }, "required": [ "id", "timestamp" ] }, "TraceWithDetails": { "title": "TraceWithDetails", "type": "object", "properties": { "htmlPath": { "type": "string", "description": "Path of trace in Langfuse UI" }, "latency": { "type": "number", "format": "double", "description": "Latency of trace in seconds" }, "totalCost": { "type": "number", "format": "double", "description": "Cost of trace in USD" }, "observations": { "type": "array", "items": { "type": "string" }, "description": "List of observation ids" }, "scores": { "type": "array", "items": { "type": "string" }, "description": "List of score ids" } }, "required": [ "htmlPath", "latency", "totalCost", "observations", "scores" ], "allOf": [ { "$ref": "#/components/schemas/Trace" } ] }, "TraceWithFullDetails": { "title": "TraceWithFullDetails", "type": "object", "properties": { "htmlPath": { "type": "string", "description": "Path of trace in Langfuse UI" }, "latency": { "type": "number", "format": "double", "description": "Latency of trace in seconds" }, "totalCost": { "type": "number", "format": "double", "description": "Cost of trace in USD" }, "observations": { "type": "array", "items": { "$ref": "#/components/schemas/ObservationsView" }, "description": "List of observations" }, "scores": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreV1" }, "description": "List of scores" } }, "required": [ "htmlPath", "latency", "totalCost", "observations", "scores" ], "allOf": [ { "$ref": "#/components/schemas/Trace" } ] }, "Session": { "title": "Session", "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "projectId": { "type": "string" }, "environment": { "type": "string", "nullable": true, "description": "The environment from which this session originated." } }, "required": [ "id", "createdAt", "projectId" ] }, "SessionWithTraces": { "title": "SessionWithTraces", "type": "object", "properties": { "traces": { "type": "array", "items": { "$ref": "#/components/schemas/Trace" } } }, "required": [ "traces" ], "allOf": [ { "$ref": "#/components/schemas/Session" } ] }, "Observation": { "title": "Observation", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the observation" }, "traceId": { "type": "string", "nullable": true, "description": "The trace ID associated with the observation" }, "type": { "type": "string", "description": "The type of the observation" }, "name": { "type": "string", "nullable": true, "description": "The name of the observation" }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the observation" }, "endTime": { "type": "string", "format": "date-time", "nullable": true, "description": "The end time of the observation." }, "completionStartTime": { "type": "string", "format": "date-time", "nullable": true, "description": "The completion start time of the observation" }, "model": { "type": "string", "nullable": true, "description": "The model used for the observation" }, "modelParameters": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MapValue" }, "nullable": true, "description": "The parameters of the model used for the observation" }, "input": { "nullable": true, "description": "The input data of the observation" }, "version": { "type": "string", "nullable": true, "description": "The version of the observation" }, "metadata": { "nullable": true, "description": "Additional metadata of the observation" }, "output": { "nullable": true, "description": "The output data of the observation" }, "usage": { "$ref": "#/components/schemas/Usage", "nullable": true, "description": "(Deprecated. Use usageDetails and costDetails instead.) The usage data of the observation" }, "level": { "$ref": "#/components/schemas/ObservationLevel", "description": "The level of the observation" }, "statusMessage": { "type": "string", "nullable": true, "description": "The status message of the observation" }, "parentObservationId": { "type": "string", "nullable": true, "description": "The parent observation ID" }, "promptId": { "type": "string", "nullable": true, "description": "The prompt ID associated with the observation" }, "usageDetails": { "type": "object", "additionalProperties": { "type": "integer" }, "nullable": true, "description": "The usage details of the observation. Key is the name of the usage metric, value is the number of units consumed. The total key is the sum of all (non-total) usage metrics or the total value ingested." }, "costDetails": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "nullable": true, "description": "The cost details of the observation. Key is the name of the cost metric, value is the cost in USD. The total key is the sum of all (non-total) cost metrics or the total value ingested." }, "environment": { "type": "string", "nullable": true, "description": "The environment from which this observation originated. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'langfuse'." } }, "required": [ "id", "type", "startTime", "level" ] }, "ObservationsView": { "title": "ObservationsView", "type": "object", "properties": { "promptName": { "type": "string", "nullable": true, "description": "The name of the prompt associated with the observation" }, "promptVersion": { "type": "integer", "nullable": true, "description": "The version of the prompt associated with the observation" }, "modelId": { "type": "string", "nullable": true, "description": "The unique identifier of the model" }, "inputPrice": { "type": "number", "format": "double", "nullable": true, "description": "The price of the input in USD" }, "outputPrice": { "type": "number", "format": "double", "nullable": true, "description": "The price of the output in USD." }, "totalPrice": { "type": "number", "format": "double", "nullable": true, "description": "The total price in USD." }, "calculatedInputCost": { "type": "number", "format": "double", "nullable": true, "description": "(Deprecated. Use usageDetails and costDetails instead.) The calculated cost of the input in USD" }, "calculatedOutputCost": { "type": "number", "format": "double", "nullable": true, "description": "(Deprecated. Use usageDetails and costDetails instead.) The calculated cost of the output in USD" }, "calculatedTotalCost": { "type": "number", "format": "double", "nullable": true, "description": "(Deprecated. Use usageDetails and costDetails instead.) The calculated total cost in USD" }, "latency": { "type": "number", "format": "double", "nullable": true, "description": "The latency in seconds." }, "timeToFirstToken": { "type": "number", "format": "double", "nullable": true, "description": "The time to the first token in seconds" } }, "allOf": [ { "$ref": "#/components/schemas/Observation" } ] }, "Usage": { "title": "Usage", "type": "object", "description": "(Deprecated. Use usageDetails and costDetails instead.) Standard interface for usage and cost", "properties": { "input": { "type": "integer", "nullable": true, "description": "Number of input units (e.g. tokens)" }, "output": { "type": "integer", "nullable": true, "description": "Number of output units (e.g. tokens)" }, "total": { "type": "integer", "nullable": true, "description": "Defaults to input+output if not set" }, "unit": { "$ref": "#/components/schemas/ModelUsageUnit", "nullable": true }, "inputCost": { "type": "number", "format": "double", "nullable": true, "description": "USD input cost" }, "outputCost": { "type": "number", "format": "double", "nullable": true, "description": "USD output cost" }, "totalCost": { "type": "number", "format": "double", "nullable": true, "description": "USD total cost, defaults to input+output" } } }, "ScoreConfig": { "title": "ScoreConfig", "type": "object", "description": "Configuration for a score", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "projectId": { "type": "string" }, "dataType": { "$ref": "#/components/schemas/ScoreDataType" }, "isArchived": { "type": "boolean", "description": "Whether the score config is archived. Defaults to false" }, "minValue": { "type": "number", "format": "double", "nullable": true, "description": "Sets minimum value for numerical scores. If not set, the minimum value defaults to -∞" }, "maxValue": { "type": "number", "format": "double", "nullable": true, "description": "Sets maximum value for numerical scores. If not set, the maximum value defaults to +∞" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigCategory" }, "nullable": true, "description": "Configures custom categories for categorical scores" }, "description": { "type": "string", "nullable": true } }, "required": [ "id", "name", "createdAt", "updatedAt", "projectId", "dataType", "isArchived" ] }, "ConfigCategory": { "title": "ConfigCategory", "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "label": { "type": "string" } }, "required": [ "value", "label" ] }, "BaseScoreV1": { "title": "BaseScoreV1", "type": "object", "properties": { "id": { "type": "string" }, "traceId": { "type": "string" }, "name": { "type": "string" }, "source": { "$ref": "#/components/schemas/ScoreSource" }, "observationId": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "authorUserId": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "metadata": { "nullable": true }, "configId": { "type": "string", "nullable": true, "description": "Reference a score config on a score. When set, config and score name must be equal and value must comply to optionally defined numerical range" }, "queueId": { "type": "string", "nullable": true, "description": "Reference an annotation queue on a score. Populated if the score was initially created in an annotation queue." }, "environment": { "type": "string", "nullable": true, "description": "The environment from which this score originated. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'langfuse'." } }, "required": [ "id", "traceId", "name", "source", "timestamp", "createdAt", "updatedAt" ] }, "NumericScoreV1": { "title": "NumericScoreV1", "type": "object", "properties": { "value": { "type": "number", "format": "double", "description": "The numeric value of the score" } }, "required": [ "value" ], "allOf": [ { "$ref": "#/components/schemas/BaseScoreV1" } ] }, "BooleanScoreV1": { "title": "BooleanScoreV1", "type": "object", "properties": { "value": { "type": "number", "format": "double", "description": "The numeric value of the score. Equals 1 for \"True\" and 0 for \"False\"" }, "stringValue": { "type": "string", "description": "The string representation of the score value. Is inferred from the numeric value and equals \"True\" or \"False\"" } }, "required": [ "value", "stringValue" ], "allOf": [ { "$ref": "#/components/schemas/BaseScoreV1" } ] }, "CategoricalScoreV1": { "title": "CategoricalScoreV1", "type": "object", "properties": { "value": { "type": "number", "format": "double", "nullable": true, "description": "Only defined if a config is linked. Represents the numeric category mapping of the stringValue" }, "stringValue": { "type": "string", "description": "The string representation of the score value. If no config is linked, can be any string. Otherwise, must map to a config category" } }, "required": [ "stringValue" ], "allOf": [ { "$ref": "#/components/schemas/BaseScoreV1" } ] }, "ScoreV1": { "title": "ScoreV1", "oneOf": [ { "type": "object", "allOf": [ { "type": "object", "properties": { "dataType": { "type": "string", "enum": [ "NUMERIC" ] } } }, { "$ref": "#/components/schemas/NumericScoreV1" } ], "required": [ "dataType" ] }, { "type": "object", "allOf": [ { "type": "object", "properties": { "dataType": { "type": "string", "enum": [ "CATEGORICAL" ] } } }, { "$ref": "#/components/schemas/CategoricalScoreV1" } ], "required": [ "dataType" ] }, { "type": "object", "allOf": [ { "type": "object", "properties": { "dataType": { "type": "string", "enum": [ "BOOLEAN" ] } } }, { "$ref": "#/components/schemas/BooleanScoreV1" } ], "required": [ "dataType" ] } ] }, "BaseScore": { "title": "BaseScore", "type": "object", "properties": { "id": { "type": "string" }, "traceId": { "type": "string", "nullable": true }, "sessionId": { "type": "string", "nullable": true }, "observationId": { "type": "string", "nullable": true }, "datasetRunId": { "type": "string", "nullable": true }, "name": { "type": "string" }, "source": { "$ref": "#/components/schemas/ScoreSource" }, "timestamp": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "authorUserId": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "metadata": { "nullable": true }, "configId": { "type": "string", "nullable": true, "description": "Reference a score config on a score. When set, config and score name must be equal and value must comply to optionally defined numerical range" }, "queueId": { "type": "string", "nullable": true, "description": "Reference an annotation queue on a score. Populated if the score was initially created in an annotation queue." }, "environment": { "type": "string", "nullable": true, "description": "The environment from which this score originated. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'langfuse'." } }, "required": [ "id", "name", "source", "timestamp", "createdAt", "updatedAt" ] }, "NumericScore": { "title": "NumericScore", "type": "object", "properties": { "value": { "type": "number", "format": "double", "description": "The numeric value of the score" } }, "required": [ "value" ], "allOf": [ { "$ref": "#/components/schemas/BaseScore" } ] }, "BooleanScore": { "title": "BooleanScore", "type": "object", "properties": { "value": { "type": "number", "format": "double", "description": "The numeric value of the score. Equals 1 for \"True\" and 0 for \"False\"" }, "stringValue": { "type": "string", "description": "The string representation of the score value. Is inferred from the numeric value and equals \"True\" or \"False\"" } }, "required": [ "value", "stringValue" ], "allOf": [ { "$ref": "#/components/schemas/BaseScore" } ] }, "CategoricalScore": { "title": "CategoricalScore", "type": "object", "properties": { "value": { "type": "number", "format": "double", "nullable": true, "description": "Only defined if a config is linked. Represents the numeric category mapping of the stringValue" }, "stringValue": { "type": "string", "description": "The string representation of the score value. If no config is linked, can be any string. Otherwise, must map to a config category" } }, "required": [ "stringValue" ], "allOf": [ { "$ref": "#/components/schemas/BaseScore" } ] }, "Score": { "title": "Score", "oneOf": [ { "type": "object", "allOf": [ { "type": "object", "properties": { "dataType": { "type": "string", "enum": [ "NUMERIC" ] } } }, { "$ref": "#/components/schemas/NumericScore" } ], "required": [ "dataType" ] }, { "type": "object", "allOf": [ { "type": "object", "properties": { "dataType": { "type": "string", "enum": [ "CATEGORICAL" ] } } }, { "$ref": "#/components/schemas/CategoricalScore" } ], "required": [ "dataType" ] }, { "type": "object", "allOf": [ { "type": "object", "properties": { "dataType": { "type": "string", "enum": [ "BOOLEAN" ] } } }, { "$ref": "#/components/schemas/BooleanScore" } ], "required": [ "dataType" ] } ] }, "CreateScoreValue": { "title": "CreateScoreValue", "oneOf": [ { "type": "number", "format": "double" }, { "type": "string" } ], "description": "The value of the score. Must be passed as string for categorical scores, and numeric for boolean and numeric scores" }, "Comment": { "title": "Comment", "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "objectType": { "$ref": "#/components/schemas/CommentObjectType" }, "objectId": { "type": "string" }, "content": { "type": "string" }, "authorUserId": { "type": "string", "nullable": true } }, "required": [ "id", "projectId", "createdAt", "updatedAt", "objectType", "objectId", "content" ] }, "Dataset": { "title": "Dataset", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "metadata": { "nullable": true }, "projectId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "projectId", "createdAt", "updatedAt" ] }, "DatasetItem": { "title": "DatasetItem", "type": "object", "properties": { "id": { "type": "string" }, "status": { "$ref": "#/components/schemas/DatasetStatus" }, "input": { "nullable": true }, "expectedOutput": { "nullable": true }, "metadata": { "nullable": true }, "sourceTraceId": { "type": "string", "nullable": true }, "sourceObservationId": { "type": "string", "nullable": true }, "datasetId": { "type": "string" }, "datasetName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "status", "datasetId", "datasetName", "createdAt", "updatedAt" ] }, "DatasetRunItem": { "title": "DatasetRunItem", "type": "object", "properties": { "id": { "type": "string" }, "datasetRunId": { "type": "string" }, "datasetRunName": { "type": "string" }, "datasetItemId": { "type": "string" }, "traceId": { "type": "string" }, "observationId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "datasetRunId", "datasetRunName", "datasetItemId", "traceId", "createdAt", "updatedAt" ] }, "DatasetRun": { "title": "DatasetRun", "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the dataset run" }, "name": { "type": "string", "description": "Name of the dataset run" }, "description": { "type": "string", "nullable": true, "description": "Description of the run" }, "metadata": { "nullable": true, "description": "Metadata of the dataset run" }, "datasetId": { "type": "string", "description": "Id of the associated dataset" }, "datasetName": { "type": "string", "description": "Name of the associated dataset" }, "createdAt": { "type": "string", "format": "date-time", "description": "The date and time when the dataset run was created" }, "updatedAt": { "type": "string", "format": "date-time", "description": "The date and time when the dataset run was last updated" } }, "required": [ "id", "name", "datasetId", "datasetName", "createdAt", "updatedAt" ] }, "DatasetRunWithItems": { "title": "DatasetRunWithItems", "type": "object", "properties": { "datasetRunItems": { "type": "array", "items": { "$ref": "#/components/schemas/DatasetRunItem" } } }, "required": [ "datasetRunItems" ], "allOf": [ { "$ref": "#/components/schemas/DatasetRun" } ] }, "Model": { "title": "Model", "type": "object", "description": "Model definition used for transforming usage into USD cost and/or tokenization.", "properties": { "id": { "type": "string" }, "modelName": { "type": "string", "description": "Name of the model definition. If multiple with the same name exist, they are applied in the following order: (1) custom over built-in, (2) newest according to startTime where model.startTime