{ "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/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": [] } ] } }, "/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" } } } } } }, "/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": [] } ] } }, "/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. If 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\nNotes:\n\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": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionResponse" } } } }, "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" ] } } } } } }, "/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/daily": { "get": { "description": "Get daily metrics of the Langfuse project", "operationId": "metrics_daily", "tags": [ "Metrics" ], "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 } }, { "name": "traceName", "in": "query", "description": "Optional filter by the name of the trace", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "userId", "in": "query", "description": "Optional filter by the userId associated with the trace", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "tags", "in": "query", "description": "Optional filter for metrics where traces include all of these tags", "required": false, "schema": { "type": "array", "items": { "type": "string", "nullable": true } } }, { "name": "fromTimestamp", "in": "query", "description": "Optional filter to only include traces and observations 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 and observations 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/DailyMetrics" } } } }, "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": "parentObservationId", "in": "query", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "fromStartTime", "in": "query", "description": "Retrieve only observations with a start_time or 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/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": [] } ] } }, "/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/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/scores": { "post": { "description": "Create a score", "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" } } } } }, "get": { "description": "Get a list of scores", "operationId": "score_get", "tags": [ "Score" ], "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": "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/scores/{scoreId}": { "get": { "description": "Get a score", "operationId": "score_get-by-id", "tags": [ "Score" ], "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": [] } ] }, "delete": { "description": "Delete a score", "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 } } ], "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": [] } ] } }, "/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 } } ], "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": [] } ] } } }, "components": { "schemas": { "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 500 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" } }, "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/Score" }, "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" } }, "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": "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" } }, "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": "The calculated cost of the input in USD" }, "calculatedOutputCost": { "type": "number", "format": "double", "nullable": true, "description": "The calculated cost of the output in USD" }, "calculatedTotalCost": { "type": "number", "format": "double", "nullable": true, "description": "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": "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" ] }, "BaseScore": { "title": "BaseScore", "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 }, "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." } }, "required": [ "id", "traceId", "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