This file was auto-generated by openapi-typescript. Do not make direct changes to the file.

interface paths {
    /api/public/comments: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    authorUserId?: null | string;
                    limit?: null | number;
                    objectId?: null | string;
                    objectType?: null | string;
                    page?: null | number;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            data: {
                                authorUserId?: null | string;
                                content: string;
                                createdAt: string;
                                id: string;
                                objectId: string;
                                objectType:
                                    | "TRACE"
                                    | "OBSERVATION"
                                    | "SESSION"
                                    | "PROMPT";
                                projectId: string;
                                updatedAt: string;
                            }[];
                            meta: {
                                limit: number;
                                page: number;
                                totalItems: number;
                                totalPages: number;
                            };
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        authorUserId?: null | string;
                        content: string;
                        objectId: string;
                        objectType: string;
                        projectId: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            id: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /api/public/comments/{commentId}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    commentId: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            authorUserId?: null | string;
                            content: string;
                            createdAt: string;
                            id: string;
                            objectId: string;
                            objectType:
                                | "TRACE"
                                | "OBSERVATION"
                                | "SESSION"
                                | "PROMPT";
                            projectId: string;
                            updatedAt: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/dataset-items: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    datasetName?: null | string;
                    limit?: null | number;
                    page?: null | number;
                    sourceObservationId?: null | string;
                    sourceTraceId?: null | string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            data: {
                                createdAt: string;
                                datasetId: string;
                                datasetName: string;
                                expectedOutput?: unknown;
                                id: string;
                                input?: unknown;
                                metadata?: unknown;
                                sourceObservationId?: null | string;
                                sourceTraceId?: null | string;
                                status: "ACTIVE" | "ARCHIVED";
                                updatedAt: string;
                            }[];
                            meta: {
                                limit: number;
                                page: number;
                                totalItems: number;
                                totalPages: number;
                            };
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        datasetName: string;
                        expectedOutput?: unknown;
                        id?: null | string;
                        input?: unknown;
                        metadata?: unknown;
                        sourceObservationId?: null | string;
                        sourceTraceId?: null | string;
                        status?: "ACTIVE" | "ARCHIVED";
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            createdAt: string;
                            datasetId: string;
                            datasetName: string;
                            expectedOutput?: unknown;
                            id: string;
                            input?: unknown;
                            metadata?: unknown;
                            sourceObservationId?: null | string;
                            sourceTraceId?: null | string;
                            status: "ACTIVE" | "ARCHIVED";
                            updatedAt: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /api/public/dataset-items/{id}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    id: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            createdAt: string;
                            datasetId: string;
                            datasetName: string;
                            expectedOutput?: unknown;
                            id: string;
                            input?: unknown;
                            metadata?: unknown;
                            sourceObservationId?: null | string;
                            sourceTraceId?: null | string;
                            status: "ACTIVE" | "ARCHIVED";
                            updatedAt: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/dataset-run-items: {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        datasetItemId: string;
                        metadata?: unknown;
                        observationId?: null | string;
                        runDescription?: null | string;
                        runName: string;
                        traceId?: null | string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            createdAt: string;
                            datasetItemId: string;
                            datasetRunId: string;
                            datasetRunName: string;
                            id: string;
                            observationId?: null | string;
                            traceId: string;
                            updatedAt: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /api/public/datasets/{datasetName}/runs: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    datasetName: string;
                };
                query?: {
                    limit?: null | number;
                    page?: null | number;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            data: {
                                createdAt: string;
                                datasetId: string;
                                datasetName: string;
                                description?: null | string;
                                id: string;
                                metadata?: unknown;
                                name: string;
                                updatedAt: string;
                            }[];
                            meta: {
                                limit: number;
                                page: number;
                                totalItems: number;
                                totalPages: number;
                            };
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/datasets/{datasetName}/runs/{runName}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    datasetName: string;
                    runName: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            datasetRunItems: {
                                createdAt: string;
                                datasetItemId: string;
                                datasetRunId: string;
                                datasetRunName: string;
                                id: string;
                                observationId?: null | string;
                                traceId: string;
                                updatedAt: string;
                            }[];
                        } & {
                            createdAt: string;
                            datasetId: string;
                            datasetName: string;
                            description?: null | string;
                            id: string;
                            metadata?: unknown;
                            name: string;
                            updatedAt: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/health: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            status: string;
                            version: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                503: {
                    content?: undefined;
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/ingestion: {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        batch: (
                            | {
                                type: "trace-create";
                            } & {
                                body: {
                                    id?: (...) | (...) | (...);
                                    input?: unknown;
                                    metadata?: unknown;
                                    name?: (...) | (...) | (...);
                                    output?: unknown;
                                    public?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                    release?: (...) | (...) | (...);
                                    sessionId?: (...) | (...) | (...);
                                    tags?: (...) | (...) | (...);
                                    timestamp?: (...) | (...) | (...);
                                    userId?: (...) | (...) | (...);
                                    version?: (...) | (...) | (...);
                                };
                            } & {
                                id: string;
                                metadata?: unknown;
                                timestamp: string;
                            }
                            | {
                                type: "score-create";
                            } & {
                                body: {
                                    comment?: (...) | (...) | (...);
                                    configId?: (...) | (...) | (...);
                                    dataType?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                    id?: (...) | (...) | (...);
                                    name: string;
                                    observationId?: (...) | (...) | (...);
                                    traceId: string;
                                    value: (...) | (...);
                                };
                            } & {
                                id: string;
                                metadata?: unknown;
                                timestamp: string;
                            }
                            | {
                                type: "span-create";
                            } & {
                                body: {
                                    endTime?: ...;
                                } & {
                                    id?: ...;
                                } & {
                                    input?: ...;
                                    level?: ...;
                                    metadata?: ...;
                                    name?: ...;
                                    output?: ...;
                                    parentObservationId?: ...;
                                    startTime?: ...;
                                    statusMessage?: ...;
                                    traceId?: ...;
                                    version?: ...;
                                };
                            } & {
                                id: string;
                                metadata?: unknown;
                                timestamp: string;
                            }
                            | {
                                type: "span-update";
                            } & {
                                body: {
                                    endTime?: ...;
                                } & {
                                    id: ...;
                                } & {
                                    input?: ...;
                                    level?: ...;
                                    metadata?: ...;
                                    name?: ...;
                                    output?: ...;
                                    parentObservationId?: ...;
                                    startTime?: ...;
                                    statusMessage?: ...;
                                    traceId?: ...;
                                    version?: ...;
                                };
                            } & {
                                id: string;
                                metadata?: unknown;
                                timestamp: string;
                            }
                            | {
                                type: "generation-create";
                            } & {
                                body: {
                                    completionStartTime?: ...;
                                    costDetails?: ...;
                                    model?: ...;
                                    modelParameters?: ...;
                                    promptName?: ...;
                                    promptVersion?: ...;
                                    usage?: ...;
                                    usageDetails?: ...;
                                } & {
                                    endTime?: ...;
                                } & {
                                    id?: ...;
                                } & {
                                    input?: ...;
                                    level?: ...;
                                    metadata?: ...;
                                    name?: ...;
                                    output?: ...;
                                    parentObservationId?: ...;
                                    startTime?: ...;
                                    statusMessage?: ...;
                                    traceId?: ...;
                                    version?: ...;
                                };
                            } & {
                                id: string;
                                metadata?: unknown;
                                timestamp: string;
                            }
                            | {
                                type: "generation-update";
                            } & {
                                body: {
                                    completionStartTime?: ...;
                                    costDetails?: ...;
                                    model?: ...;
                                    modelParameters?: ...;
                                    promptName?: ...;
                                    promptVersion?: ...;
                                    usage?: ...;
                                    usageDetails?: ...;
                                } & {
                                    endTime?: ...;
                                } & {
                                    id: ...;
                                } & {
                                    input?: ...;
                                    level?: ...;
                                    metadata?: ...;
                                    name?: ...;
                                    output?: ...;
                                    parentObservationId?: ...;
                                    startTime?: ...;
                                    statusMessage?: ...;
                                    traceId?: ...;
                                    version?: ...;
                                };
                            } & {
                                id: string;
                                metadata?: unknown;
                                timestamp: string;
                            }
                            | {
                                type: "event-create";
                            } & {
                                body: {
                                    id?: ...;
                                } & {
                                    input?: ...;
                                    level?: ...;
                                    metadata?: ...;
                                    name?: ...;
                                    output?: ...;
                                    parentObservationId?: ...;
                                    startTime?: ...;
                                    statusMessage?: ...;
                                    traceId?: ...;
                                    version?: ...;
                                };
                            } & {
                                id: string;
                                metadata?: unknown;
                                timestamp: string;
                            }
                            | {
                                type: "sdk-log";
                            } & {
                                body: {
                                    log: unknown;
                                };
                            } & {
                                id: string;
                                metadata?: unknown;
                                timestamp: string;
                            }
                            | {
                                type: "observation-create";
                            } & {
                                body: {
                                    completionStartTime?: (...) | (...) | (...);
                                    endTime?: (...) | (...) | (...);
                                    id?: (...) | (...) | (...);
                                    input?: unknown;
                                    level?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                    metadata?: unknown;
                                    model?: (...) | (...) | (...);
                                    modelParameters?: (...) | (...) | (...);
                                    name?: (...) | (...) | (...);
                                    output?: unknown;
                                    parentObservationId?: (...) | (...) | (...);
                                    startTime?: (...) | (...) | (...);
                                    statusMessage?: (...) | (...) | (...);
                                    traceId?: (...) | (...) | (...);
                                    type: (...) | (...) | (...);
                                    usage?: (...) | (...);
                                    version?: (...) | (...) | (...);
                                };
                            } & {
                                id: string;
                                metadata?: unknown;
                                timestamp: string;
                            }
                            | {
                                type: "observation-update";
                            } & {
                                body: {
                                    completionStartTime?: (...) | (...) | (...);
                                    endTime?: (...) | (...) | (...);
                                    id?: (...) | (...) | (...);
                                    input?: unknown;
                                    level?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                    metadata?: unknown;
                                    model?: (...) | (...) | (...);
                                    modelParameters?: (...) | (...) | (...);
                                    name?: (...) | (...) | (...);
                                    output?: unknown;
                                    parentObservationId?: (...) | (...) | (...);
                                    startTime?: (...) | (...) | (...);
                                    statusMessage?: (...) | (...) | (...);
                                    traceId?: (...) | (...) | (...);
                                    type: (...) | (...) | (...);
                                    usage?: (...) | (...);
                                    version?: (...) | (...) | (...);
                                };
                            } & {
                                id: string;
                                metadata?: unknown;
                                timestamp: string;
                            })[];
                        metadata?: unknown;
                    };
                };
            };
            responses: {
                207: {
                    content: {
                        application/json: {
                            errors: {
                                error?: unknown;
                                id: string;
                                message?: null | string;
                                status: number;
                            }[];
                            successes: {
                                id: string;
                                status: number;
                            }[];
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /api/public/media: {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        contentLength: number;
                        contentType:
                            | "image/png"
                            | "image/jpeg"
                            | "image/jpg"
                            | "image/webp"
                            | "image/gif"
                            | "image/svg+xml"
                            | "image/tiff"
                            | "image/bmp"
                            | "audio/mpeg"
                            | "audio/mp3"
                            | "audio/wav"
                            | "audio/ogg"
                            | "audio/oga"
                            | "audio/aac"
                            | "audio/mp4"
                            | "audio/flac"
                            | "video/mp4"
                            | "video/webm"
                            | "text/plain"
                            | "text/html"
                            | "text/css"
                            | "text/csv"
                            | "application/pdf"
                            | "application/msword"
                            | "application/vnd.ms-excel"
                            | "application/zip"
                            | "application/json"
                            | "application/xml"
                            | "application/octet-stream";
                        field: string;
                        observationId?: null | string;
                        sha256Hash: string;
                        traceId: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            mediaId: string;
                            uploadUrl?: null | string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /api/public/media/{mediaId}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    mediaId: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            contentLength: number;
                            contentType: string;
                            mediaId: string;
                            uploadedAt: string;
                            url: string;
                            urlExpiry: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    mediaId: string;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        uploadedAt: string;
                        uploadHttpError?: null | string;
                        uploadHttpStatus: number;
                        uploadTimeMs?: null | number;
                    };
                };
            };
            responses: {
                204: {
                    content?: undefined;
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/metrics/daily: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    fromTimestamp?: null | string;
                    limit?: null | number;
                    page?: null | number;
                    tags?: (null | string)[];
                    toTimestamp?: null | string;
                    traceName?: null | string;
                    userId?: null | string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            data: {
                                countObservations: number;
                                countTraces: number;
                                date: string;
                                totalCost: number;
                                usage: {
                                    countObservations: number;
                                    countTraces: number;
                                    inputUsage: number;
                                    model?: (...) | (...) | (...);
                                    outputUsage: number;
                                    totalCost: number;
                                    totalUsage: number;
                                }[];
                            }[];
                            meta: {
                                limit: number;
                                page: number;
                                totalItems: number;
                                totalPages: number;
                            };
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/models: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    limit?: null | number;
                    page?: null | number;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            data: {
                                id: string;
                                inputPrice?: null | number;
                                isLangfuseManaged: boolean;
                                matchPattern: string;
                                modelName: string;
                                outputPrice?: null | number;
                                startDate?: null | string;
                                tokenizerConfig?: unknown;
                                tokenizerId?: null | string;
                                totalPrice?: null | number;
                                unit?:
                                    | "CHARACTERS"
                                    | "TOKENS"
                                    | "MILLISECONDS"
                                    | "SECONDS"
                                    | "IMAGES"
                                    | "REQUESTS";
                            }[];
                            meta: {
                                limit: number;
                                page: number;
                                totalItems: number;
                                totalPages: number;
                            };
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        inputPrice?: null | number;
                        matchPattern: string;
                        modelName: string;
                        outputPrice?: null | number;
                        startDate?: null | string;
                        tokenizerConfig?: unknown;
                        tokenizerId?: null | string;
                        totalPrice?: null | number;
                        unit?:
                            | "CHARACTERS"
                            | "TOKENS"
                            | "MILLISECONDS"
                            | "SECONDS"
                            | "IMAGES"
                            | "REQUESTS";
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            id: string;
                            inputPrice?: null | number;
                            isLangfuseManaged: boolean;
                            matchPattern: string;
                            modelName: string;
                            outputPrice?: null | number;
                            startDate?: null | string;
                            tokenizerConfig?: unknown;
                            tokenizerId?: null | string;
                            totalPrice?: null | number;
                            unit?:
                                | "CHARACTERS"
                                | "TOKENS"
                                | "MILLISECONDS"
                                | "SECONDS"
                                | "IMAGES"
                                | "REQUESTS";
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /api/public/models/{id}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    id: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    id: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            id: string;
                            inputPrice?: null | number;
                            isLangfuseManaged: boolean;
                            matchPattern: string;
                            modelName: string;
                            outputPrice?: null | number;
                            startDate?: null | string;
                            tokenizerConfig?: unknown;
                            tokenizerId?: null | string;
                            totalPrice?: null | number;
                            unit?:
                                | "CHARACTERS"
                                | "TOKENS"
                                | "MILLISECONDS"
                                | "SECONDS"
                                | "IMAGES"
                                | "REQUESTS";
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/observations: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    fromStartTime?: null | string;
                    limit?: null | number;
                    name?: null | string;
                    page?: null | number;
                    parentObservationId?: null | string;
                    toStartTime?: null | string;
                    traceId?: null | string;
                    type?: null | string;
                    userId?: null | string;
                    version?: null | string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            data: ({
                                calculatedInputCost?: null | number;
                                calculatedOutputCost?: null | number;
                                calculatedTotalCost?: null | number;
                                inputPrice?: null | number;
                                latency?: null | number;
                                modelId?: null | string;
                                outputPrice?: null | number;
                                promptName?: null | string;
                                promptVersion?: null | number;
                                timeToFirstToken?: null | number;
                                totalPrice?: null | number;
                            } & {
                                completionStartTime?: null | string;
                                costDetails?: null | {
                                    [key: ...]: ...;
                                };
                                endTime?: null | string;
                                id: string;
                                input?: unknown;
                                level:
                                    | "DEBUG"
                                    | "DEFAULT"
                                    | "WARNING"
                                    | "ERROR";
                                metadata?: unknown;
                                model?: null | string;
                                modelParameters?: null | {
                                    [key: ...]: ...;
                                };
                                name?: null | string;
                                output?: unknown;
                                parentObservationId?: null | string;
                                promptId?: null | string;
                                startTime: string;
                                statusMessage?: null | string;
                                traceId?: null | string;
                                type: string;
                                usage?: {
                                    input?: ...;
                                    inputCost?: ...;
                                    output?: ...;
                                    outputCost?: ...;
                                    total?: ...;
                                    totalCost?: ...;
                                    unit?: ...;
                                };
                                usageDetails?: null | {
                                    [key: ...]: ...;
                                };
                                version?: null | string;
                            })[];
                            meta: {
                                limit: number;
                                page: number;
                                totalItems: number;
                                totalPages: number;
                            };
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/observations/{observationId}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    observationId: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            calculatedInputCost?: null | number;
                            calculatedOutputCost?: null | number;
                            calculatedTotalCost?: null | number;
                            inputPrice?: null | number;
                            latency?: null | number;
                            modelId?: null | string;
                            outputPrice?: null | number;
                            promptName?: null | string;
                            promptVersion?: null | number;
                            timeToFirstToken?: null | number;
                            totalPrice?: null | number;
                        } & {
                            completionStartTime?: null | string;
                            costDetails?: null | {
                                [key: string]: number;
                            };
                            endTime?: null | string;
                            id: string;
                            input?: unknown;
                            level:
                                | "DEBUG"
                                | "DEFAULT"
                                | "WARNING"
                                | "ERROR";
                            metadata?: unknown;
                            model?: null | string;
                            modelParameters?: null | {
                                [key: string]: (...)[(...)]["MapValue"];
                            };
                            name?: null | string;
                            output?: unknown;
                            parentObservationId?: null | string;
                            promptId?: null | string;
                            startTime: string;
                            statusMessage?: null | string;
                            traceId?: null | string;
                            type: string;
                            usage?: {
                                input?: null | number;
                                inputCost?: null | number;
                                output?: null | number;
                                outputCost?: null | number;
                                total?: null | number;
                                totalCost?: null | number;
                                unit?:
                                    | "CHARACTERS"
                                    | "TOKENS"
                                    | "MILLISECONDS"
                                    | "SECONDS"
                                    | "IMAGES"
                                    | "REQUESTS";
                            };
                            usageDetails?: null | {
                                [key: string]: number;
                            };
                            version?: null | string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/projects: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            data: {
                                id: string;
                                name: string;
                            }[];
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/score-configs: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    limit?: null | number;
                    page?: null | number;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            data: {
                                categories?: null | {
                                    label: ...;
                                    value: ...;
                                }[];
                                createdAt: string;
                                dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                                description?: null | string;
                                id: string;
                                isArchived: boolean;
                                maxValue?: null | number;
                                minValue?: null | number;
                                name: string;
                                projectId: string;
                                updatedAt: string;
                            }[];
                            meta: {
                                limit: number;
                                page: number;
                                totalItems: number;
                                totalPages: number;
                            };
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        categories?: null | {
                            label: string;
                            value: number;
                        }[];
                        dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                        description?: null | string;
                        maxValue?: null | number;
                        minValue?: null | number;
                        name: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            categories?: null | {
                                label: string;
                                value: number;
                            }[];
                            createdAt: string;
                            dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                            description?: null | string;
                            id: string;
                            isArchived: boolean;
                            maxValue?: null | number;
                            minValue?: null | number;
                            name: string;
                            projectId: string;
                            updatedAt: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /api/public/score-configs/{configId}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    configId: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            categories?: null | {
                                label: string;
                                value: number;
                            }[];
                            createdAt: string;
                            dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                            description?: null | string;
                            id: string;
                            isArchived: boolean;
                            maxValue?: null | number;
                            minValue?: null | number;
                            name: string;
                            projectId: string;
                            updatedAt: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/scores: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    configId?: null | string;
                    dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                    fromTimestamp?: null | string;
                    limit?: null | number;
                    name?: null | string;
                    operator?: null | string;
                    page?: null | number;
                    queueId?: null | string;
                    scoreIds?: null | string;
                    source?: "ANNOTATION" | "API" | "EVAL";
                    toTimestamp?: null | string;
                    traceTags?: (null | string)[];
                    userId?: null | string;
                    value?: null | number;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            data: ({
                                dataType: "NUMERIC";
                            } & {
                                trace: {
                                    tags?: ...;
                                    userId?: ...;
                                };
                            } & {
                                value: number;
                            } & {
                                authorUserId?: (...) | (...) | (...);
                                comment?: (...) | (...) | (...);
                                configId?: (...) | (...) | (...);
                                createdAt: string;
                                id: string;
                                name: string;
                                observationId?: (...) | (...) | (...);
                                queueId?: (...) | (...) | (...);
                                source: (...) | (...) | (...);
                                timestamp: string;
                                traceId: string;
                                updatedAt: string;
                            } | {
                                dataType: "CATEGORICAL";
                            } & {
                                trace: {
                                    tags?: ...;
                                    userId?: ...;
                                };
                            } & {
                                stringValue: string;
                                value?: (...) | (...) | (...);
                            } & {
                                authorUserId?: (...) | (...) | (...);
                                comment?: (...) | (...) | (...);
                                configId?: (...) | (...) | (...);
                                createdAt: string;
                                id: string;
                                name: string;
                                observationId?: (...) | (...) | (...);
                                queueId?: (...) | (...) | (...);
                                source: (...) | (...) | (...);
                                timestamp: string;
                                traceId: string;
                                updatedAt: string;
                            } | {
                                dataType: "BOOLEAN";
                            } & {
                                trace: {
                                    tags?: ...;
                                    userId?: ...;
                                };
                            } & {
                                stringValue: string;
                                value: number;
                            } & {
                                authorUserId?: (...) | (...) | (...);
                                comment?: (...) | (...) | (...);
                                configId?: (...) | (...) | (...);
                                createdAt: string;
                                id: string;
                                name: string;
                                observationId?: (...) | (...) | (...);
                                queueId?: (...) | (...) | (...);
                                source: (...) | (...) | (...);
                                timestamp: string;
                                traceId: string;
                                updatedAt: string;
                            })[];
                            meta: {
                                limit: number;
                                page: number;
                                totalItems: number;
                                totalPages: number;
                            };
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        comment?: null | string;
                        configId?: null | string;
                        dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                        id?: null | string;
                        name: string;
                        observationId?: null | string;
                        traceId: string;
                        value: string | number;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            id: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /api/public/scores/{scoreId}: {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    scoreId: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                204: {
                    content?: undefined;
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    scoreId: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            dataType: "NUMERIC";
                        } & {
                            value: number;
                        } & {
                            authorUserId?: null | string;
                            comment?: null | string;
                            configId?: null | string;
                            createdAt: string;
                            id: string;
                            name: string;
                            observationId?: null | string;
                            queueId?: null | string;
                            source: "ANNOTATION" | "API" | "EVAL";
                            timestamp: string;
                            traceId: string;
                            updatedAt: string;
                        } | {
                            dataType: "CATEGORICAL";
                        } & {
                            stringValue: string;
                            value?: null | number;
                        } & {
                            authorUserId?: null | string;
                            comment?: null | string;
                            configId?: null | string;
                            createdAt: string;
                            id: string;
                            name: string;
                            observationId?: null | string;
                            queueId?: null | string;
                            source: "ANNOTATION" | "API" | "EVAL";
                            timestamp: string;
                            traceId: string;
                            updatedAt: string;
                        } | {
                            dataType: "BOOLEAN";
                        } & {
                            stringValue: string;
                            value: number;
                        } & {
                            authorUserId?: null | string;
                            comment?: null | string;
                            configId?: null | string;
                            createdAt: string;
                            id: string;
                            name: string;
                            observationId?: null | string;
                            queueId?: null | string;
                            source: "ANNOTATION" | "API" | "EVAL";
                            timestamp: string;
                            traceId: string;
                            updatedAt: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/sessions: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    fromTimestamp?: null | string;
                    limit?: null | number;
                    page?: null | number;
                    toTimestamp?: null | string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            data: {
                                createdAt: string;
                                id: string;
                                projectId: string;
                            }[];
                            meta: {
                                limit: number;
                                page: number;
                                totalItems: number;
                                totalPages: number;
                            };
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/sessions/{sessionId}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    sessionId: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            traces: {
                                id: string;
                                input?: unknown;
                                metadata?: unknown;
                                name?: null | string;
                                output?: unknown;
                                public?: null | boolean;
                                release?: null | string;
                                sessionId?: null | string;
                                tags?: null | (...)[];
                                timestamp: string;
                                userId?: null | string;
                                version?: null | string;
                            }[];
                        } & {
                            createdAt: string;
                            id: string;
                            projectId: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/traces: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    fromTimestamp?: null | string;
                    limit?: null | number;
                    name?: null | string;
                    orderBy?: null | string;
                    page?: null | number;
                    release?: null | string;
                    sessionId?: null | string;
                    tags?: (null | string)[];
                    toTimestamp?: null | string;
                    userId?: null | string;
                    version?: null | string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            data: ({
                                htmlPath: string;
                                latency: number;
                                observations: string[];
                                scores: string[];
                                totalCost: number;
                            } & {
                                id: string;
                                input?: unknown;
                                metadata?: unknown;
                                name?: null | string;
                                output?: unknown;
                                public?: null | boolean;
                                release?: null | string;
                                sessionId?: null | string;
                                tags?: null | (...)[];
                                timestamp: string;
                                userId?: null | string;
                                version?: null | string;
                            })[];
                            meta: {
                                limit: number;
                                page: number;
                                totalItems: number;
                                totalPages: number;
                            };
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/traces/{traceId}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    traceId: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            htmlPath: string;
                            latency: number;
                            observations: ({
                                calculatedInputCost?: (...) | (...) | (...);
                                calculatedOutputCost?: (...) | (...) | (...);
                                calculatedTotalCost?: (...) | (...) | (...);
                                inputPrice?: (...) | (...) | (...);
                                latency?: (...) | (...) | (...);
                                modelId?: (...) | (...) | (...);
                                outputPrice?: (...) | (...) | (...);
                                promptName?: (...) | (...) | (...);
                                promptVersion?: (...) | (...) | (...);
                                timeToFirstToken?: (...) | (...) | (...);
                                totalPrice?: (...) | (...) | (...);
                            } & {
                                completionStartTime?: (...) | (...) | (...);
                                costDetails?: (...) | (...) | (...);
                                endTime?: (...) | (...) | (...);
                                id: string;
                                input?: unknown;
                                level:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                metadata?: unknown;
                                model?: (...) | (...) | (...);
                                modelParameters?: (...) | (...) | (...);
                                name?: (...) | (...) | (...);
                                output?: unknown;
                                parentObservationId?: (...) | (...) | (...);
                                promptId?: (...) | (...) | (...);
                                startTime: string;
                                statusMessage?: (...) | (...) | (...);
                                traceId?: (...) | (...) | (...);
                                type: string;
                                usage?: (...) | (...);
                                usageDetails?: (...) | (...) | (...);
                                version?: (...) | (...) | (...);
                            })[];
                            scores: ({
                                dataType: ...;
                            } & {
                                value: ...;
                            } & {
                                authorUserId?: ...;
                                comment?: ...;
                                configId?: ...;
                                createdAt: ...;
                                id: ...;
                                name: ...;
                                observationId?: ...;
                                queueId?: ...;
                                source: ...;
                                timestamp: ...;
                                traceId: ...;
                                updatedAt: ...;
                            } | {
                                dataType: ...;
                            } & {
                                stringValue: ...;
                                value?: ...;
                            } & {
                                authorUserId?: ...;
                                comment?: ...;
                                configId?: ...;
                                createdAt: ...;
                                id: ...;
                                name: ...;
                                observationId?: ...;
                                queueId?: ...;
                                source: ...;
                                timestamp: ...;
                                traceId: ...;
                                updatedAt: ...;
                            } | {
                                dataType: ...;
                            } & {
                                stringValue: ...;
                                value: ...;
                            } & {
                                authorUserId?: ...;
                                comment?: ...;
                                configId?: ...;
                                createdAt: ...;
                                id: ...;
                                name: ...;
                                observationId?: ...;
                                queueId?: ...;
                                source: ...;
                                timestamp: ...;
                                traceId: ...;
                                updatedAt: ...;
                            })[];
                            totalCost: number;
                        } & {
                            id: string;
                            input?: unknown;
                            metadata?: unknown;
                            name?: null | string;
                            output?: unknown;
                            public?: null | boolean;
                            release?: null | string;
                            sessionId?: null | string;
                            tags?: null | string[];
                            timestamp: string;
                            userId?: null | string;
                            version?: null | string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/v2/datasets: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    limit?: null | number;
                    page?: null | number;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            data: {
                                createdAt: string;
                                description?: null | string;
                                id: string;
                                metadata?: unknown;
                                name: string;
                                projectId: string;
                                updatedAt: string;
                            }[];
                            meta: {
                                limit: number;
                                page: number;
                                totalItems: number;
                                totalPages: number;
                            };
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        description?: null | string;
                        metadata?: unknown;
                        name: string;
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            createdAt: string;
                            description?: null | string;
                            id: string;
                            metadata?: unknown;
                            name: string;
                            projectId: string;
                            updatedAt: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /api/public/v2/datasets/{datasetName}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    datasetName: string;
                };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            createdAt: string;
                            description?: null | string;
                            id: string;
                            metadata?: unknown;
                            name: string;
                            projectId: string;
                            updatedAt: string;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/v2/prompts: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    fromUpdatedAt?: null | string;
                    label?: null | string;
                    limit?: null | number;
                    name?: null | string;
                    page?: null | number;
                    tag?: null | string;
                    toUpdatedAt?: null | string;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            data: {
                                labels: string[];
                                lastConfig: unknown;
                                lastUpdatedAt: string;
                                name: string;
                                tags: string[];
                                versions: number[];
                            }[];
                            meta: {
                                limit: number;
                                page: number;
                                totalItems: number;
                                totalPages: number;
                            };
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        type: "chat";
                    } & {
                        commitMessage?: null | string;
                        config?: unknown;
                        labels?: null | string[];
                        name: string;
                        prompt: {
                            content: string;
                            role: string;
                        }[];
                        tags?: null | string[];
                    } | {
                        type: "text";
                    } & {
                        commitMessage?: null | string;
                        config?: unknown;
                        labels?: null | string[];
                        name: string;
                        prompt: string;
                        tags?: null | string[];
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "chat";
                        } & {
                            prompt: {
                                content: string;
                                role: string;
                            }[];
                        } & {
                            commitMessage?: null | string;
                            config: unknown;
                            labels: string[];
                            name: string;
                            tags: string[];
                            version: number;
                        } | {
                            type: "text";
                        } & {
                            prompt: string;
                        } & {
                            commitMessage?: null | string;
                            config: unknown;
                            labels: string[];
                            name: string;
                            tags: string[];
                            version: number;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    /api/public/v2/prompts/{name}/versions/{version}: {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    name: string;
                    version: number;
                };
                query?: undefined;
            };
            requestBody: {
                content: {
                    application/json: {
                        newLabels: string[];
                    };
                };
            };
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "chat";
                        } & {
                            prompt: {
                                content: string;
                                role: string;
                            }[];
                        } & {
                            commitMessage?: null | string;
                            config: unknown;
                            labels: string[];
                            name: string;
                            tags: string[];
                            version: number;
                        } | {
                            type: "text";
                        } & {
                            prompt: string;
                        } & {
                            commitMessage?: null | string;
                            config: unknown;
                            labels: string[];
                            name: string;
                            tags: string[];
                            version: number;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    /api/public/v2/prompts/{promptName}: {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: {
                    promptName: string;
                };
                query?: {
                    label?: null | string;
                    version?: null | number;
                };
            };
            requestBody?: undefined;
            responses: {
                200: {
                    content: {
                        application/json: {
                            type: "chat";
                        } & {
                            prompt: {
                                content: string;
                                role: string;
                            }[];
                        } & {
                            commitMessage?: null | string;
                            config: unknown;
                            labels: string[];
                            name: string;
                            tags: string[];
                            version: number;
                        } | {
                            type: "text";
                        } & {
                            prompt: string;
                        } & {
                            commitMessage?: null | string;
                            config: unknown;
                            labels: string[];
                            name: string;
                            tags: string[];
                            version: number;
                        };
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                400: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                401: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                403: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                404: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
                405: {
                    content: {
                        application/json: unknown;
                    };
                    headers: {
                        [name: string]: unknown;
                    };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
}

Properties

/api/public/comments: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                authorUserId?: null | string;
                limit?: null | number;
                objectId?: null | string;
                objectType?: null | string;
                page?: null | number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            authorUserId?: null | string;
                            content: string;
                            createdAt: string;
                            id: string;
                            objectId: string;
                            objectType:
                                | "TRACE"
                                | "OBSERVATION"
                                | "SESSION"
                                | "PROMPT";
                            projectId: string;
                            updatedAt: string;
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    authorUserId?: null | string;
                    content: string;
                    objectId: string;
                    objectType: string;
                    projectId: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        id: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                authorUserId?: null | string;
                limit?: null | number;
                objectId?: null | string;
                objectType?: null | string;
                page?: null | number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            authorUserId?: null | string;
                            content: string;
                            createdAt: string;
                            id: string;
                            objectId: string;
                            objectType:
                                | "TRACE"
                                | "OBSERVATION"
                                | "SESSION"
                                | "PROMPT";
                            projectId: string;
                            updatedAt: string;
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get all comments

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              authorUserId?: null | string;
              limit?: null | number;
              objectId?: null | string;
              objectType?: null | string;
              page?: null | number;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: {
            authorUserId?: null | string;
            limit?: null | number;
            objectId?: null | string;
            objectType?: null | string;
            page?: null | number;
        }
        • OptionalauthorUserId?: null | string

          Filter comments by author user id.

        • Optionallimit?: null | number

          Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit

        • OptionalobjectId?: null | string

          Filter comments by object id. If objectType is not provided, an error will be thrown.

        • OptionalobjectType?: null | string

          Filter comments by object type (trace, observation, session, prompt).

        • Optionalpage?: null | number

          Page number, starts at 1.

    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      data: {
                          authorUserId?: null | string;
                          content: string;
                          createdAt: string;
                          id: string;
                          objectId: string;
                          objectType:
                              | "TRACE"
                              | "OBSERVATION"
                              | "SESSION"
                              | "PROMPT";
                          projectId: string;
                          updatedAt: string;
                      }[];
                      meta: {
                          limit: number;
                          page: number;
                          totalItems: number;
                          totalPages: number;
                      };
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    data: {
                        authorUserId?: null | string;
                        content: string;
                        createdAt: string;
                        id: string;
                        objectId: string;
                        objectType:
                            | "TRACE"
                            | "OBSERVATION"
                            | "SESSION"
                            | "PROMPT";
                        projectId: string;
                        updatedAt: string;
                    }[];
                    meta: {
                        limit: number;
                        page: number;
                        totalItems: number;
                        totalPages: number;
                    };
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  data: {
                      authorUserId?: null | string;
                      content: string;
                      createdAt: string;
                      id: string;
                      objectId: string;
                      objectType:
                          | "TRACE"
                          | "OBSERVATION"
                          | "SESSION"
                          | "PROMPT";
                      projectId: string;
                      updatedAt: string;
                  }[];
                  meta: {
                      limit: number;
                      page: number;
                      totalItems: number;
                      totalPages: number;
                  };
              };
          }
          • application/json: {
                data: {
                    authorUserId?: null | string;
                    content: string;
                    createdAt: string;
                    id: string;
                    objectId: string;
                    objectType:
                        | "TRACE"
                        | "OBSERVATION"
                        | "SESSION"
                        | "PROMPT";
                    projectId: string;
                    updatedAt: string;
                }[];
                meta: {
                    limit: number;
                    page: number;
                    totalItems: number;
                    totalPages: number;
                };
            }
            • data: {
                  authorUserId?: null | string;
                  content: string;
                  createdAt: string;
                  id: string;
                  objectId: string;
                  objectType:
                      | "TRACE"
                      | "OBSERVATION"
                      | "SESSION"
                      | "PROMPT";
                  projectId: string;
                  updatedAt: string;
              }[]
            • meta: {
                  limit: number;
                  page: number;
                  totalItems: number;
                  totalPages: number;
              }
              • limit: number

                number of items per page

              • page: number

                current page number

              • totalItems: number

                number of total items given the current filters/selection (if any)

              • totalPages: number

                number of total pages given the current limit

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    authorUserId?: null | string;
                    content: string;
                    objectId: string;
                    objectType: string;
                    projectId: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        id: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Create a comment. Comments may be attached to different object types (trace, observation, session, prompt).

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: undefined
    • requestBody: {
          content: {
              application/json: {
                  authorUserId?: null | string;
                  content: string;
                  objectId: string;
                  objectType: string;
                  projectId: string;
              };
          };
      }
      • content: {
            application/json: {
                authorUserId?: null | string;
                content: string;
                objectId: string;
                objectType: string;
                projectId: string;
            };
        }
        • application/json: {
              authorUserId?: null | string;
              content: string;
              objectId: string;
              objectType: string;
              projectId: string;
          }
          • OptionalauthorUserId?: null | string

            The id of the user who created the comment.

          • content: string

            The content of the comment. May include markdown. Currently limited to 3000 characters.

          • objectId: string

            The id of the object to attach the comment to. If this does not reference a valid existing object, an error will be thrown.

          • objectType: string

            The type of the object to attach the comment to (trace, observation, session, prompt).

          • projectId: string

            The id of the project to attach the comment to.

    • responses: {
          200: {
              content: {
                  application/json: {
                      id: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    id: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  id: string;
              };
          }
          • application/json: {
                id: string;
            }
            • id: string

              The id of the created object in Langfuse

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/comments/{commentId}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        authorUserId?: null | string;
                        content: string;
                        createdAt: string;
                        id: string;
                        objectId: string;
                        objectType:
                            | "TRACE"
                            | "OBSERVATION"
                            | "SESSION"
                            | "PROMPT";
                        projectId: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        authorUserId?: null | string;
                        content: string;
                        createdAt: string;
                        id: string;
                        objectId: string;
                        objectType:
                            | "TRACE"
                            | "OBSERVATION"
                            | "SESSION"
                            | "PROMPT";
                        projectId: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a comment by id

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              commentId: string;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            commentId: string;
        }
        • commentId: string

          The unique langfuse identifier of a comment

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      authorUserId?: null | string;
                      content: string;
                      createdAt: string;
                      id: string;
                      objectId: string;
                      objectType:
                          | "TRACE"
                          | "OBSERVATION"
                          | "SESSION"
                          | "PROMPT";
                      projectId: string;
                      updatedAt: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    authorUserId?: null | string;
                    content: string;
                    createdAt: string;
                    id: string;
                    objectId: string;
                    objectType:
                        | "TRACE"
                        | "OBSERVATION"
                        | "SESSION"
                        | "PROMPT";
                    projectId: string;
                    updatedAt: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  authorUserId?: null | string;
                  content: string;
                  createdAt: string;
                  id: string;
                  objectId: string;
                  objectType:
                      | "TRACE"
                      | "OBSERVATION"
                      | "SESSION"
                      | "PROMPT";
                  projectId: string;
                  updatedAt: string;
              };
          }
          • application/json: {
                authorUserId?: null | string;
                content: string;
                createdAt: string;
                id: string;
                objectId: string;
                objectType:
                    | "TRACE"
                    | "OBSERVATION"
                    | "SESSION"
                    | "PROMPT";
                projectId: string;
                updatedAt: string;
            }
            • OptionalauthorUserId?: null | string
            • content: string
            • createdAt: string

              Format: date-time

            • id: string
            • objectId: string
            • objectType:
                  | "TRACE"
                  | "OBSERVATION"
                  | "SESSION"
                  | "PROMPT"
            • projectId: string
            • updatedAt: string

              Format: date-time

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/dataset-items: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                datasetName?: null | string;
                limit?: null | number;
                page?: null | number;
                sourceObservationId?: null | string;
                sourceTraceId?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            createdAt: string;
                            datasetId: string;
                            datasetName: string;
                            expectedOutput?: unknown;
                            id: string;
                            input?: unknown;
                            metadata?: unknown;
                            sourceObservationId?: null | string;
                            sourceTraceId?: null | string;
                            status: "ACTIVE" | "ARCHIVED";
                            updatedAt: string;
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    datasetName: string;
                    expectedOutput?: unknown;
                    id?: null | string;
                    input?: unknown;
                    metadata?: unknown;
                    sourceObservationId?: null | string;
                    sourceTraceId?: null | string;
                    status?: "ACTIVE" | "ARCHIVED";
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        createdAt: string;
                        datasetId: string;
                        datasetName: string;
                        expectedOutput?: unknown;
                        id: string;
                        input?: unknown;
                        metadata?: unknown;
                        sourceObservationId?: null | string;
                        sourceTraceId?: null | string;
                        status: "ACTIVE" | "ARCHIVED";
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                datasetName?: null | string;
                limit?: null | number;
                page?: null | number;
                sourceObservationId?: null | string;
                sourceTraceId?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            createdAt: string;
                            datasetId: string;
                            datasetName: string;
                            expectedOutput?: unknown;
                            id: string;
                            input?: unknown;
                            metadata?: unknown;
                            sourceObservationId?: null | string;
                            sourceTraceId?: null | string;
                            status: "ACTIVE" | "ARCHIVED";
                            updatedAt: string;
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get dataset items

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              datasetName?: null | string;
              limit?: null | number;
              page?: null | number;
              sourceObservationId?: null | string;
              sourceTraceId?: null | string;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: {
            datasetName?: null | string;
            limit?: null | number;
            page?: null | number;
            sourceObservationId?: null | string;
            sourceTraceId?: null | string;
        }
        • OptionaldatasetName?: null | string
        • Optionallimit?: null | number

          limit of items per page

        • Optionalpage?: null | number

          page number, starts at 1

        • OptionalsourceObservationId?: null | string
        • OptionalsourceTraceId?: null | string
    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      data: {
                          createdAt: string;
                          datasetId: string;
                          datasetName: string;
                          expectedOutput?: unknown;
                          id: string;
                          input?: unknown;
                          metadata?: unknown;
                          sourceObservationId?: null | string;
                          sourceTraceId?: null | string;
                          status: "ACTIVE" | "ARCHIVED";
                          updatedAt: string;
                      }[];
                      meta: {
                          limit: number;
                          page: number;
                          totalItems: number;
                          totalPages: number;
                      };
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    data: {
                        createdAt: string;
                        datasetId: string;
                        datasetName: string;
                        expectedOutput?: unknown;
                        id: string;
                        input?: unknown;
                        metadata?: unknown;
                        sourceObservationId?: null | string;
                        sourceTraceId?: null | string;
                        status: "ACTIVE" | "ARCHIVED";
                        updatedAt: string;
                    }[];
                    meta: {
                        limit: number;
                        page: number;
                        totalItems: number;
                        totalPages: number;
                    };
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  data: {
                      createdAt: string;
                      datasetId: string;
                      datasetName: string;
                      expectedOutput?: unknown;
                      id: string;
                      input?: unknown;
                      metadata?: unknown;
                      sourceObservationId?: null | string;
                      sourceTraceId?: null | string;
                      status: "ACTIVE" | "ARCHIVED";
                      updatedAt: string;
                  }[];
                  meta: {
                      limit: number;
                      page: number;
                      totalItems: number;
                      totalPages: number;
                  };
              };
          }
          • application/json: {
                data: {
                    createdAt: string;
                    datasetId: string;
                    datasetName: string;
                    expectedOutput?: unknown;
                    id: string;
                    input?: unknown;
                    metadata?: unknown;
                    sourceObservationId?: null | string;
                    sourceTraceId?: null | string;
                    status: "ACTIVE" | "ARCHIVED";
                    updatedAt: string;
                }[];
                meta: {
                    limit: number;
                    page: number;
                    totalItems: number;
                    totalPages: number;
                };
            }
            • data: {
                  createdAt: string;
                  datasetId: string;
                  datasetName: string;
                  expectedOutput?: unknown;
                  id: string;
                  input?: unknown;
                  metadata?: unknown;
                  sourceObservationId?: null | string;
                  sourceTraceId?: null | string;
                  status: "ACTIVE" | "ARCHIVED";
                  updatedAt: string;
              }[]
            • meta: {
                  limit: number;
                  page: number;
                  totalItems: number;
                  totalPages: number;
              }
              • limit: number

                number of items per page

              • page: number

                current page number

              • totalItems: number

                number of total items given the current filters/selection (if any)

              • totalPages: number

                number of total pages given the current limit

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    datasetName: string;
                    expectedOutput?: unknown;
                    id?: null | string;
                    input?: unknown;
                    metadata?: unknown;
                    sourceObservationId?: null | string;
                    sourceTraceId?: null | string;
                    status?: "ACTIVE" | "ARCHIVED";
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        createdAt: string;
                        datasetId: string;
                        datasetName: string;
                        expectedOutput?: unknown;
                        id: string;
                        input?: unknown;
                        metadata?: unknown;
                        sourceObservationId?: null | string;
                        sourceTraceId?: null | string;
                        status: "ACTIVE" | "ARCHIVED";
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Create a dataset item

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: undefined
    • requestBody: {
          content: {
              application/json: {
                  datasetName: string;
                  expectedOutput?: unknown;
                  id?: null | string;
                  input?: unknown;
                  metadata?: unknown;
                  sourceObservationId?: null | string;
                  sourceTraceId?: null | string;
                  status?: "ACTIVE" | "ARCHIVED";
              };
          };
      }
      • content: {
            application/json: {
                datasetName: string;
                expectedOutput?: unknown;
                id?: null | string;
                input?: unknown;
                metadata?: unknown;
                sourceObservationId?: null | string;
                sourceTraceId?: null | string;
                status?: "ACTIVE" | "ARCHIVED";
            };
        }
        • application/json: {
              datasetName: string;
              expectedOutput?: unknown;
              id?: null | string;
              input?: unknown;
              metadata?: unknown;
              sourceObservationId?: null | string;
              sourceTraceId?: null | string;
              status?: "ACTIVE" | "ARCHIVED";
          }
          • datasetName: string
          • OptionalexpectedOutput?: unknown
          • Optionalid?: null | string

            Dataset items are upserted on their id. Id needs to be unique (project-level) and cannot be reused across datasets.

          • Optionalinput?: unknown
          • Optionalmetadata?: unknown
          • OptionalsourceObservationId?: null | string
          • OptionalsourceTraceId?: null | string
          • Optionalstatus?: "ACTIVE" | "ARCHIVED"

            Defaults to ACTIVE for newly created items

    • responses: {
          200: {
              content: {
                  application/json: {
                      createdAt: string;
                      datasetId: string;
                      datasetName: string;
                      expectedOutput?: unknown;
                      id: string;
                      input?: unknown;
                      metadata?: unknown;
                      sourceObservationId?: null | string;
                      sourceTraceId?: null | string;
                      status: "ACTIVE" | "ARCHIVED";
                      updatedAt: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    createdAt: string;
                    datasetId: string;
                    datasetName: string;
                    expectedOutput?: unknown;
                    id: string;
                    input?: unknown;
                    metadata?: unknown;
                    sourceObservationId?: null | string;
                    sourceTraceId?: null | string;
                    status: "ACTIVE" | "ARCHIVED";
                    updatedAt: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  createdAt: string;
                  datasetId: string;
                  datasetName: string;
                  expectedOutput?: unknown;
                  id: string;
                  input?: unknown;
                  metadata?: unknown;
                  sourceObservationId?: null | string;
                  sourceTraceId?: null | string;
                  status: "ACTIVE" | "ARCHIVED";
                  updatedAt: string;
              };
          }
          • application/json: {
                createdAt: string;
                datasetId: string;
                datasetName: string;
                expectedOutput?: unknown;
                id: string;
                input?: unknown;
                metadata?: unknown;
                sourceObservationId?: null | string;
                sourceTraceId?: null | string;
                status: "ACTIVE" | "ARCHIVED";
                updatedAt: string;
            }
            • createdAt: string

              Format: date-time

            • datasetId: string
            • datasetName: string
            • OptionalexpectedOutput?: unknown
            • id: string
            • Optionalinput?: unknown
            • Optionalmetadata?: unknown
            • OptionalsourceObservationId?: null | string
            • OptionalsourceTraceId?: null | string
            • status: "ACTIVE" | "ARCHIVED"
            • updatedAt: string

              Format: date-time

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/dataset-items/{id}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                id: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        createdAt: string;
                        datasetId: string;
                        datasetName: string;
                        expectedOutput?: unknown;
                        id: string;
                        input?: unknown;
                        metadata?: unknown;
                        sourceObservationId?: null | string;
                        sourceTraceId?: null | string;
                        status: "ACTIVE" | "ARCHIVED";
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                id: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        createdAt: string;
                        datasetId: string;
                        datasetName: string;
                        expectedOutput?: unknown;
                        id: string;
                        input?: unknown;
                        metadata?: unknown;
                        sourceObservationId?: null | string;
                        sourceTraceId?: null | string;
                        status: "ACTIVE" | "ARCHIVED";
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a dataset item

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              id: string;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            id: string;
        }
        • id: string
      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      createdAt: string;
                      datasetId: string;
                      datasetName: string;
                      expectedOutput?: unknown;
                      id: string;
                      input?: unknown;
                      metadata?: unknown;
                      sourceObservationId?: null | string;
                      sourceTraceId?: null | string;
                      status: "ACTIVE" | "ARCHIVED";
                      updatedAt: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    createdAt: string;
                    datasetId: string;
                    datasetName: string;
                    expectedOutput?: unknown;
                    id: string;
                    input?: unknown;
                    metadata?: unknown;
                    sourceObservationId?: null | string;
                    sourceTraceId?: null | string;
                    status: "ACTIVE" | "ARCHIVED";
                    updatedAt: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  createdAt: string;
                  datasetId: string;
                  datasetName: string;
                  expectedOutput?: unknown;
                  id: string;
                  input?: unknown;
                  metadata?: unknown;
                  sourceObservationId?: null | string;
                  sourceTraceId?: null | string;
                  status: "ACTIVE" | "ARCHIVED";
                  updatedAt: string;
              };
          }
          • application/json: {
                createdAt: string;
                datasetId: string;
                datasetName: string;
                expectedOutput?: unknown;
                id: string;
                input?: unknown;
                metadata?: unknown;
                sourceObservationId?: null | string;
                sourceTraceId?: null | string;
                status: "ACTIVE" | "ARCHIVED";
                updatedAt: string;
            }
            • createdAt: string

              Format: date-time

            • datasetId: string
            • datasetName: string
            • OptionalexpectedOutput?: unknown
            • id: string
            • Optionalinput?: unknown
            • Optionalmetadata?: unknown
            • OptionalsourceObservationId?: null | string
            • OptionalsourceTraceId?: null | string
            • status: "ACTIVE" | "ARCHIVED"
            • updatedAt: string

              Format: date-time

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/dataset-run-items: {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    datasetItemId: string;
                    metadata?: unknown;
                    observationId?: null | string;
                    runDescription?: null | string;
                    runName: string;
                    traceId?: null | string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        createdAt: string;
                        datasetItemId: string;
                        datasetRunId: string;
                        datasetRunName: string;
                        id: string;
                        observationId?: null | string;
                        traceId: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    datasetItemId: string;
                    metadata?: unknown;
                    observationId?: null | string;
                    runDescription?: null | string;
                    runName: string;
                    traceId?: null | string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        createdAt: string;
                        datasetItemId: string;
                        datasetRunId: string;
                        datasetRunName: string;
                        id: string;
                        observationId?: null | string;
                        traceId: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Create a dataset run item

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: undefined
    • requestBody: {
          content: {
              application/json: {
                  datasetItemId: string;
                  metadata?: unknown;
                  observationId?: null | string;
                  runDescription?: null | string;
                  runName: string;
                  traceId?: null | string;
              };
          };
      }
      • content: {
            application/json: {
                datasetItemId: string;
                metadata?: unknown;
                observationId?: null | string;
                runDescription?: null | string;
                runName: string;
                traceId?: null | string;
            };
        }
        • application/json: {
              datasetItemId: string;
              metadata?: unknown;
              observationId?: null | string;
              runDescription?: null | string;
              runName: string;
              traceId?: null | string;
          }
          • datasetItemId: string
          • Optionalmetadata?: unknown

            Metadata of the dataset run, updates run if run already exists

          • OptionalobservationId?: null | string
          • OptionalrunDescription?: null | string

            Description of the run. If run exists, description will be updated.

          • runName: string
          • OptionaltraceId?: null | string

            traceId should always be provided. For compatibility with older SDK versions it can also be inferred from the provided observationId.

    • responses: {
          200: {
              content: {
                  application/json: {
                      createdAt: string;
                      datasetItemId: string;
                      datasetRunId: string;
                      datasetRunName: string;
                      id: string;
                      observationId?: null | string;
                      traceId: string;
                      updatedAt: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    createdAt: string;
                    datasetItemId: string;
                    datasetRunId: string;
                    datasetRunName: string;
                    id: string;
                    observationId?: null | string;
                    traceId: string;
                    updatedAt: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  createdAt: string;
                  datasetItemId: string;
                  datasetRunId: string;
                  datasetRunName: string;
                  id: string;
                  observationId?: null | string;
                  traceId: string;
                  updatedAt: string;
              };
          }
          • application/json: {
                createdAt: string;
                datasetItemId: string;
                datasetRunId: string;
                datasetRunName: string;
                id: string;
                observationId?: null | string;
                traceId: string;
                updatedAt: string;
            }
            • createdAt: string

              Format: date-time

            • datasetItemId: string
            • datasetRunId: string
            • datasetRunName: string
            • id: string
            • OptionalobservationId?: null | string
            • traceId: string
            • updatedAt: string

              Format: date-time

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/datasets/{datasetName}/runs: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                datasetName: string;
            };
            query?: {
                limit?: null | number;
                page?: null | number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            createdAt: string;
                            datasetId: string;
                            datasetName: string;
                            description?: null | string;
                            id: string;
                            metadata?: unknown;
                            name: string;
                            updatedAt: string;
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                datasetName: string;
            };
            query?: {
                limit?: null | number;
                page?: null | number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            createdAt: string;
                            datasetId: string;
                            datasetName: string;
                            description?: null | string;
                            id: string;
                            metadata?: unknown;
                            name: string;
                            updatedAt: string;
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get dataset runs

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              datasetName: string;
          };
          query?: {
              limit?: null | number;
              page?: null | number;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            datasetName: string;
        }
        • datasetName: string
      • Optionalquery?: {
            limit?: null | number;
            page?: null | number;
        }
        • Optionallimit?: null | number

          limit of items per page

        • Optionalpage?: null | number

          page number, starts at 1

    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      data: {
                          createdAt: string;
                          datasetId: string;
                          datasetName: string;
                          description?: null | string;
                          id: string;
                          metadata?: unknown;
                          name: string;
                          updatedAt: string;
                      }[];
                      meta: {
                          limit: number;
                          page: number;
                          totalItems: number;
                          totalPages: number;
                      };
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    data: {
                        createdAt: string;
                        datasetId: string;
                        datasetName: string;
                        description?: null | string;
                        id: string;
                        metadata?: unknown;
                        name: string;
                        updatedAt: string;
                    }[];
                    meta: {
                        limit: number;
                        page: number;
                        totalItems: number;
                        totalPages: number;
                    };
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  data: {
                      createdAt: string;
                      datasetId: string;
                      datasetName: string;
                      description?: null | string;
                      id: string;
                      metadata?: unknown;
                      name: string;
                      updatedAt: string;
                  }[];
                  meta: {
                      limit: number;
                      page: number;
                      totalItems: number;
                      totalPages: number;
                  };
              };
          }
          • application/json: {
                data: {
                    createdAt: string;
                    datasetId: string;
                    datasetName: string;
                    description?: null | string;
                    id: string;
                    metadata?: unknown;
                    name: string;
                    updatedAt: string;
                }[];
                meta: {
                    limit: number;
                    page: number;
                    totalItems: number;
                    totalPages: number;
                };
            }
            • data: {
                  createdAt: string;
                  datasetId: string;
                  datasetName: string;
                  description?: null | string;
                  id: string;
                  metadata?: unknown;
                  name: string;
                  updatedAt: string;
              }[]
            • meta: {
                  limit: number;
                  page: number;
                  totalItems: number;
                  totalPages: number;
              }
              • limit: number

                number of items per page

              • page: number

                current page number

              • totalItems: number

                number of total items given the current filters/selection (if any)

              • totalPages: number

                number of total pages given the current limit

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/datasets/{datasetName}/runs/{runName}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                datasetName: string;
                runName: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        datasetRunItems: {
                            createdAt: string;
                            datasetItemId: string;
                            datasetRunId: string;
                            datasetRunName: string;
                            id: string;
                            observationId?: null | string;
                            traceId: string;
                            updatedAt: string;
                        }[];
                    } & {
                        createdAt: string;
                        datasetId: string;
                        datasetName: string;
                        description?: null | string;
                        id: string;
                        metadata?: unknown;
                        name: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                datasetName: string;
                runName: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        datasetRunItems: {
                            createdAt: string;
                            datasetItemId: string;
                            datasetRunId: string;
                            datasetRunName: string;
                            id: string;
                            observationId?: null | string;
                            traceId: string;
                            updatedAt: string;
                        }[];
                    } & {
                        createdAt: string;
                        datasetId: string;
                        datasetName: string;
                        description?: null | string;
                        id: string;
                        metadata?: unknown;
                        name: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a dataset run and its items

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              datasetName: string;
              runName: string;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            datasetName: string;
            runName: string;
        }
        • datasetName: string
        • runName: string
      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      datasetRunItems: {
                          createdAt: string;
                          datasetItemId: string;
                          datasetRunId: string;
                          datasetRunName: string;
                          id: string;
                          observationId?: null | string;
                          traceId: string;
                          updatedAt: string;
                      }[];
                  } & {
                      createdAt: string;
                      datasetId: string;
                      datasetName: string;
                      description?: null | string;
                      id: string;
                      metadata?: unknown;
                      name: string;
                      updatedAt: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    datasetRunItems: {
                        createdAt: string;
                        datasetItemId: string;
                        datasetRunId: string;
                        datasetRunName: string;
                        id: string;
                        observationId?: null | string;
                        traceId: string;
                        updatedAt: string;
                    }[];
                } & {
                    createdAt: string;
                    datasetId: string;
                    datasetName: string;
                    description?: null | string;
                    id: string;
                    metadata?: unknown;
                    name: string;
                    updatedAt: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  datasetRunItems: {
                      createdAt: string;
                      datasetItemId: string;
                      datasetRunId: string;
                      datasetRunName: string;
                      id: string;
                      observationId?: null | string;
                      traceId: string;
                      updatedAt: string;
                  }[];
              } & {
                  createdAt: string;
                  datasetId: string;
                  datasetName: string;
                  description?: null | string;
                  id: string;
                  metadata?: unknown;
                  name: string;
                  updatedAt: string;
              };
          }
          • application/json: {
                datasetRunItems: {
                    createdAt: string;
                    datasetItemId: string;
                    datasetRunId: string;
                    datasetRunName: string;
                    id: string;
                    observationId?: null | string;
                    traceId: string;
                    updatedAt: string;
                }[];
            } & {
                createdAt: string;
                datasetId: string;
                datasetName: string;
                description?: null | string;
                id: string;
                metadata?: unknown;
                name: string;
                updatedAt: string;
            }
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/health: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        status: string;
                        version: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            503: {
                content?: undefined;
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        status: string;
                        version: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            503: {
                content?: undefined;
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Check health of API and database

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      status: string;
                      version: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          503: {
              content?: undefined;
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    status: string;
                    version: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  status: string;
                  version: string;
              };
          }
          • application/json: {
                status: string;
                version: string;
            }
            • status: string
              OK
              
            • version: string

              Langfuse server version

              1.25.0
              
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 503: {
            content?: undefined;
            headers: {
                [name: string]: unknown;
            };
        }
        • Optionalcontent?: undefined
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/ingestion: {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    batch: (
                        | {
                            type: "trace-create";
                        } & {
                            body: {
                                id?: (...) | (...) | (...);
                                input?: unknown;
                                metadata?: unknown;
                                name?: (...) | (...) | (...);
                                output?: unknown;
                                public?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                release?: (...) | (...) | (...);
                                sessionId?: (...) | (...) | (...);
                                tags?: (...) | (...) | (...);
                                timestamp?: (...) | (...) | (...);
                                userId?: (...) | (...) | (...);
                                version?: (...) | (...) | (...);
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "score-create";
                        } & {
                            body: {
                                comment?: (...) | (...) | (...);
                                configId?: (...) | (...) | (...);
                                dataType?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                id?: (...) | (...) | (...);
                                name: string;
                                observationId?: (...) | (...) | (...);
                                traceId: string;
                                value: (...) | (...);
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "span-create";
                        } & {
                            body: {
                                endTime?: ...;
                            } & {
                                id?: ...;
                            } & {
                                input?: ...;
                                level?: ...;
                                metadata?: ...;
                                name?: ...;
                                output?: ...;
                                parentObservationId?: ...;
                                startTime?: ...;
                                statusMessage?: ...;
                                traceId?: ...;
                                version?: ...;
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "span-update";
                        } & {
                            body: {
                                endTime?: ...;
                            } & {
                                id: ...;
                            } & {
                                input?: ...;
                                level?: ...;
                                metadata?: ...;
                                name?: ...;
                                output?: ...;
                                parentObservationId?: ...;
                                startTime?: ...;
                                statusMessage?: ...;
                                traceId?: ...;
                                version?: ...;
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "generation-create";
                        } & {
                            body: {
                                completionStartTime?: ...;
                                costDetails?: ...;
                                model?: ...;
                                modelParameters?: ...;
                                promptName?: ...;
                                promptVersion?: ...;
                                usage?: ...;
                                usageDetails?: ...;
                            } & {
                                endTime?: ...;
                            } & {
                                id?: ...;
                            } & {
                                input?: ...;
                                level?: ...;
                                metadata?: ...;
                                name?: ...;
                                output?: ...;
                                parentObservationId?: ...;
                                startTime?: ...;
                                statusMessage?: ...;
                                traceId?: ...;
                                version?: ...;
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "generation-update";
                        } & {
                            body: {
                                completionStartTime?: ...;
                                costDetails?: ...;
                                model?: ...;
                                modelParameters?: ...;
                                promptName?: ...;
                                promptVersion?: ...;
                                usage?: ...;
                                usageDetails?: ...;
                            } & {
                                endTime?: ...;
                            } & {
                                id: ...;
                            } & {
                                input?: ...;
                                level?: ...;
                                metadata?: ...;
                                name?: ...;
                                output?: ...;
                                parentObservationId?: ...;
                                startTime?: ...;
                                statusMessage?: ...;
                                traceId?: ...;
                                version?: ...;
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "event-create";
                        } & {
                            body: {
                                id?: ...;
                            } & {
                                input?: ...;
                                level?: ...;
                                metadata?: ...;
                                name?: ...;
                                output?: ...;
                                parentObservationId?: ...;
                                startTime?: ...;
                                statusMessage?: ...;
                                traceId?: ...;
                                version?: ...;
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "sdk-log";
                        } & {
                            body: {
                                log: unknown;
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "observation-create";
                        } & {
                            body: {
                                completionStartTime?: (...) | (...) | (...);
                                endTime?: (...) | (...) | (...);
                                id?: (...) | (...) | (...);
                                input?: unknown;
                                level?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                metadata?: unknown;
                                model?: (...) | (...) | (...);
                                modelParameters?: (...) | (...) | (...);
                                name?: (...) | (...) | (...);
                                output?: unknown;
                                parentObservationId?: (...) | (...) | (...);
                                startTime?: (...) | (...) | (...);
                                statusMessage?: (...) | (...) | (...);
                                traceId?: (...) | (...) | (...);
                                type: (...) | (...) | (...);
                                usage?: (...) | (...);
                                version?: (...) | (...) | (...);
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "observation-update";
                        } & {
                            body: {
                                completionStartTime?: (...) | (...) | (...);
                                endTime?: (...) | (...) | (...);
                                id?: (...) | (...) | (...);
                                input?: unknown;
                                level?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                metadata?: unknown;
                                model?: (...) | (...) | (...);
                                modelParameters?: (...) | (...) | (...);
                                name?: (...) | (...) | (...);
                                output?: unknown;
                                parentObservationId?: (...) | (...) | (...);
                                startTime?: (...) | (...) | (...);
                                statusMessage?: (...) | (...) | (...);
                                traceId?: (...) | (...) | (...);
                                type: (...) | (...) | (...);
                                usage?: (...) | (...);
                                version?: (...) | (...) | (...);
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        })[];
                    metadata?: unknown;
                };
            };
        };
        responses: {
            207: {
                content: {
                    application/json: {
                        errors: {
                            error?: unknown;
                            id: string;
                            message?: null | string;
                            status: number;
                        }[];
                        successes: {
                            id: string;
                            status: number;
                        }[];
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    batch: (
                        | {
                            type: "trace-create";
                        } & {
                            body: {
                                id?: (...) | (...) | (...);
                                input?: unknown;
                                metadata?: unknown;
                                name?: (...) | (...) | (...);
                                output?: unknown;
                                public?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                release?: (...) | (...) | (...);
                                sessionId?: (...) | (...) | (...);
                                tags?: (...) | (...) | (...);
                                timestamp?: (...) | (...) | (...);
                                userId?: (...) | (...) | (...);
                                version?: (...) | (...) | (...);
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "score-create";
                        } & {
                            body: {
                                comment?: (...) | (...) | (...);
                                configId?: (...) | (...) | (...);
                                dataType?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                id?: (...) | (...) | (...);
                                name: string;
                                observationId?: (...) | (...) | (...);
                                traceId: string;
                                value: (...) | (...);
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "span-create";
                        } & {
                            body: {
                                endTime?: ...;
                            } & {
                                id?: ...;
                            } & {
                                input?: ...;
                                level?: ...;
                                metadata?: ...;
                                name?: ...;
                                output?: ...;
                                parentObservationId?: ...;
                                startTime?: ...;
                                statusMessage?: ...;
                                traceId?: ...;
                                version?: ...;
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "span-update";
                        } & {
                            body: {
                                endTime?: ...;
                            } & {
                                id: ...;
                            } & {
                                input?: ...;
                                level?: ...;
                                metadata?: ...;
                                name?: ...;
                                output?: ...;
                                parentObservationId?: ...;
                                startTime?: ...;
                                statusMessage?: ...;
                                traceId?: ...;
                                version?: ...;
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "generation-create";
                        } & {
                            body: {
                                completionStartTime?: ...;
                                costDetails?: ...;
                                model?: ...;
                                modelParameters?: ...;
                                promptName?: ...;
                                promptVersion?: ...;
                                usage?: ...;
                                usageDetails?: ...;
                            } & {
                                endTime?: ...;
                            } & {
                                id?: ...;
                            } & {
                                input?: ...;
                                level?: ...;
                                metadata?: ...;
                                name?: ...;
                                output?: ...;
                                parentObservationId?: ...;
                                startTime?: ...;
                                statusMessage?: ...;
                                traceId?: ...;
                                version?: ...;
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "generation-update";
                        } & {
                            body: {
                                completionStartTime?: ...;
                                costDetails?: ...;
                                model?: ...;
                                modelParameters?: ...;
                                promptName?: ...;
                                promptVersion?: ...;
                                usage?: ...;
                                usageDetails?: ...;
                            } & {
                                endTime?: ...;
                            } & {
                                id: ...;
                            } & {
                                input?: ...;
                                level?: ...;
                                metadata?: ...;
                                name?: ...;
                                output?: ...;
                                parentObservationId?: ...;
                                startTime?: ...;
                                statusMessage?: ...;
                                traceId?: ...;
                                version?: ...;
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "event-create";
                        } & {
                            body: {
                                id?: ...;
                            } & {
                                input?: ...;
                                level?: ...;
                                metadata?: ...;
                                name?: ...;
                                output?: ...;
                                parentObservationId?: ...;
                                startTime?: ...;
                                statusMessage?: ...;
                                traceId?: ...;
                                version?: ...;
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "sdk-log";
                        } & {
                            body: {
                                log: unknown;
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "observation-create";
                        } & {
                            body: {
                                completionStartTime?: (...) | (...) | (...);
                                endTime?: (...) | (...) | (...);
                                id?: (...) | (...) | (...);
                                input?: unknown;
                                level?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                metadata?: unknown;
                                model?: (...) | (...) | (...);
                                modelParameters?: (...) | (...) | (...);
                                name?: (...) | (...) | (...);
                                output?: unknown;
                                parentObservationId?: (...) | (...) | (...);
                                startTime?: (...) | (...) | (...);
                                statusMessage?: (...) | (...) | (...);
                                traceId?: (...) | (...) | (...);
                                type: (...) | (...) | (...);
                                usage?: (...) | (...);
                                version?: (...) | (...) | (...);
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        }
                        | {
                            type: "observation-update";
                        } & {
                            body: {
                                completionStartTime?: (...) | (...) | (...);
                                endTime?: (...) | (...) | (...);
                                id?: (...) | (...) | (...);
                                input?: unknown;
                                level?:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                metadata?: unknown;
                                model?: (...) | (...) | (...);
                                modelParameters?: (...) | (...) | (...);
                                name?: (...) | (...) | (...);
                                output?: unknown;
                                parentObservationId?: (...) | (...) | (...);
                                startTime?: (...) | (...) | (...);
                                statusMessage?: (...) | (...) | (...);
                                traceId?: (...) | (...) | (...);
                                type: (...) | (...) | (...);
                                usage?: (...) | (...);
                                version?: (...) | (...) | (...);
                            };
                        } & {
                            id: string;
                            metadata?: unknown;
                            timestamp: string;
                        })[];
                    metadata?: unknown;
                };
            };
        };
        responses: {
            207: {
                content: {
                    application/json: {
                        errors: {
                            error?: unknown;
                            id: string;
                            message?: null | string;
                            status: number;
                        }[];
                        successes: {
                            id: string;
                            status: number;
                        }[];
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    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.

    Notes:
    
    - Introduction to data model: https://langfuse.com/docs/tracing-data-model
    - Batch sizes are limited to 3.5 MB in total. You need to adjust the number of events per batch accordingly.
    - 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.
    
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: undefined
    • requestBody: {
          content: {
              application/json: {
                  batch: (
                      | {
                          type: "trace-create";
                      } & {
                          body: {
                              id?: (...) | (...) | (...);
                              input?: unknown;
                              metadata?: unknown;
                              name?: (...) | (...) | (...);
                              output?: unknown;
                              public?:
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...);
                              release?: (...) | (...) | (...);
                              sessionId?: (...) | (...) | (...);
                              tags?: (...) | (...) | (...);
                              timestamp?: (...) | (...) | (...);
                              userId?: (...) | (...) | (...);
                              version?: (...) | (...) | (...);
                          };
                      } & {
                          id: string;
                          metadata?: unknown;
                          timestamp: string;
                      }
                      | {
                          type: "score-create";
                      } & {
                          body: {
                              comment?: (...) | (...) | (...);
                              configId?: (...) | (...) | (...);
                              dataType?:
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...);
                              id?: (...) | (...) | (...);
                              name: string;
                              observationId?: (...) | (...) | (...);
                              traceId: string;
                              value: (...) | (...);
                          };
                      } & {
                          id: string;
                          metadata?: unknown;
                          timestamp: string;
                      }
                      | {
                          type: "span-create";
                      } & {
                          body: {
                              endTime?: ...;
                          } & {
                              id?: ...;
                          } & {
                              input?: ...;
                              level?: ...;
                              metadata?: ...;
                              name?: ...;
                              output?: ...;
                              parentObservationId?: ...;
                              startTime?: ...;
                              statusMessage?: ...;
                              traceId?: ...;
                              version?: ...;
                          };
                      } & {
                          id: string;
                          metadata?: unknown;
                          timestamp: string;
                      }
                      | {
                          type: "span-update";
                      } & {
                          body: {
                              endTime?: ...;
                          } & {
                              id: ...;
                          } & {
                              input?: ...;
                              level?: ...;
                              metadata?: ...;
                              name?: ...;
                              output?: ...;
                              parentObservationId?: ...;
                              startTime?: ...;
                              statusMessage?: ...;
                              traceId?: ...;
                              version?: ...;
                          };
                      } & {
                          id: string;
                          metadata?: unknown;
                          timestamp: string;
                      }
                      | {
                          type: "generation-create";
                      } & {
                          body: {
                              completionStartTime?: ...;
                              costDetails?: ...;
                              model?: ...;
                              modelParameters?: ...;
                              promptName?: ...;
                              promptVersion?: ...;
                              usage?: ...;
                              usageDetails?: ...;
                          } & {
                              endTime?: ...;
                          } & {
                              id?: ...;
                          } & {
                              input?: ...;
                              level?: ...;
                              metadata?: ...;
                              name?: ...;
                              output?: ...;
                              parentObservationId?: ...;
                              startTime?: ...;
                              statusMessage?: ...;
                              traceId?: ...;
                              version?: ...;
                          };
                      } & {
                          id: string;
                          metadata?: unknown;
                          timestamp: string;
                      }
                      | {
                          type: "generation-update";
                      } & {
                          body: {
                              completionStartTime?: ...;
                              costDetails?: ...;
                              model?: ...;
                              modelParameters?: ...;
                              promptName?: ...;
                              promptVersion?: ...;
                              usage?: ...;
                              usageDetails?: ...;
                          } & {
                              endTime?: ...;
                          } & {
                              id: ...;
                          } & {
                              input?: ...;
                              level?: ...;
                              metadata?: ...;
                              name?: ...;
                              output?: ...;
                              parentObservationId?: ...;
                              startTime?: ...;
                              statusMessage?: ...;
                              traceId?: ...;
                              version?: ...;
                          };
                      } & {
                          id: string;
                          metadata?: unknown;
                          timestamp: string;
                      }
                      | {
                          type: "event-create";
                      } & {
                          body: {
                              id?: ...;
                          } & {
                              input?: ...;
                              level?: ...;
                              metadata?: ...;
                              name?: ...;
                              output?: ...;
                              parentObservationId?: ...;
                              startTime?: ...;
                              statusMessage?: ...;
                              traceId?: ...;
                              version?: ...;
                          };
                      } & {
                          id: string;
                          metadata?: unknown;
                          timestamp: string;
                      }
                      | {
                          type: "sdk-log";
                      } & {
                          body: {
                              log: unknown;
                          };
                      } & {
                          id: string;
                          metadata?: unknown;
                          timestamp: string;
                      }
                      | {
                          type: "observation-create";
                      } & {
                          body: {
                              completionStartTime?: (...) | (...) | (...);
                              endTime?: (...) | (...) | (...);
                              id?: (...) | (...) | (...);
                              input?: unknown;
                              level?:
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...);
                              metadata?: unknown;
                              model?: (...) | (...) | (...);
                              modelParameters?: (...) | (...) | (...);
                              name?: (...) | (...) | (...);
                              output?: unknown;
                              parentObservationId?: (...) | (...) | (...);
                              startTime?: (...) | (...) | (...);
                              statusMessage?: (...) | (...) | (...);
                              traceId?: (...) | (...) | (...);
                              type: (...) | (...) | (...);
                              usage?: (...) | (...);
                              version?: (...) | (...) | (...);
                          };
                      } & {
                          id: string;
                          metadata?: unknown;
                          timestamp: string;
                      }
                      | {
                          type: "observation-update";
                      } & {
                          body: {
                              completionStartTime?: (...) | (...) | (...);
                              endTime?: (...) | (...) | (...);
                              id?: (...) | (...) | (...);
                              input?: unknown;
                              level?:
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...);
                              metadata?: unknown;
                              model?: (...) | (...) | (...);
                              modelParameters?: (...) | (...) | (...);
                              name?: (...) | (...) | (...);
                              output?: unknown;
                              parentObservationId?: (...) | (...) | (...);
                              startTime?: (...) | (...) | (...);
                              statusMessage?: (...) | (...) | (...);
                              traceId?: (...) | (...) | (...);
                              type: (...) | (...) | (...);
                              usage?: (...) | (...);
                              version?: (...) | (...) | (...);
                          };
                      } & {
                          id: string;
                          metadata?: unknown;
                          timestamp: string;
                      })[];
                  metadata?: unknown;
              };
          };
      }
      • content: {
            application/json: {
                batch: (
                    | {
                        type: "trace-create";
                    } & {
                        body: {
                            id?: (...) | (...) | (...);
                            input?: unknown;
                            metadata?: unknown;
                            name?: (...) | (...) | (...);
                            output?: unknown;
                            public?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            release?: (...) | (...) | (...);
                            sessionId?: (...) | (...) | (...);
                            tags?: (...) | (...) | (...);
                            timestamp?: (...) | (...) | (...);
                            userId?: (...) | (...) | (...);
                            version?: (...) | (...) | (...);
                        };
                    } & {
                        id: string;
                        metadata?: unknown;
                        timestamp: string;
                    }
                    | {
                        type: "score-create";
                    } & {
                        body: {
                            comment?: (...) | (...) | (...);
                            configId?: (...) | (...) | (...);
                            dataType?:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            id?: (...) | (...) | (...);
                            name: string;
                            observationId?: (...) | (...) | (...);
                            traceId: string;
                            value: (...) | (...);
                        };
                    } & {
                        id: string;
                        metadata?: unknown;
                        timestamp: string;
                    }
                    | {
                        type: "span-create";
                    } & {
                        body: {
                            endTime?: ...;
                        } & {
                            id?: ...;
                        } & {
                            input?: ...;
                            level?: ...;
                            metadata?: ...;
                            name?: ...;
                            output?: ...;
                            parentObservationId?: ...;
                            startTime?: ...;
                            statusMessage?: ...;
                            traceId?: ...;
                            version?: ...;
                        };
                    } & {
                        id: string;
                        metadata?: unknown;
                        timestamp: string;
                    }
                    | {
                        type: "span-update";
                    } & {
                        body: {
                            endTime?: ...;
                        } & {
                            id: ...;
                        } & {
                            input?: ...;
                            level?: ...;
                            metadata?: ...;
                            name?: ...;
                            output?: ...;
                            parentObservationId?: ...;
                            startTime?: ...;
                            statusMessage?: ...;
                            traceId?: ...;
                            version?: ...;
                        };
                    } & {
                        id: string;
                        metadata?: unknown;
                        timestamp: string;
                    }
                    | {
                        type: "generation-create";
                    } & {
                        body: {
                            completionStartTime?: ...;
                            costDetails?: ...;
                            model?: ...;
                            modelParameters?: ...;
                            promptName?: ...;
                            promptVersion?: ...;
                            usage?: ...;
                            usageDetails?: ...;
                        } & {
                            endTime?: ...;
                        } & {
                            id?: ...;
                        } & {
                            input?: ...;
                            level?: ...;
                            metadata?: ...;
                            name?: ...;
                            output?: ...;
                            parentObservationId?: ...;
                            startTime?: ...;
                            statusMessage?: ...;
                            traceId?: ...;
                            version?: ...;
                        };
                    } & {
                        id: string;
                        metadata?: unknown;
                        timestamp: string;
                    }
                    | {
                        type: "generation-update";
                    } & {
                        body: {
                            completionStartTime?: ...;
                            costDetails?: ...;
                            model?: ...;
                            modelParameters?: ...;
                            promptName?: ...;
                            promptVersion?: ...;
                            usage?: ...;
                            usageDetails?: ...;
                        } & {
                            endTime?: ...;
                        } & {
                            id: ...;
                        } & {
                            input?: ...;
                            level?: ...;
                            metadata?: ...;
                            name?: ...;
                            output?: ...;
                            parentObservationId?: ...;
                            startTime?: ...;
                            statusMessage?: ...;
                            traceId?: ...;
                            version?: ...;
                        };
                    } & {
                        id: string;
                        metadata?: unknown;
                        timestamp: string;
                    }
                    | {
                        type: "event-create";
                    } & {
                        body: {
                            id?: ...;
                        } & {
                            input?: ...;
                            level?: ...;
                            metadata?: ...;
                            name?: ...;
                            output?: ...;
                            parentObservationId?: ...;
                            startTime?: ...;
                            statusMessage?: ...;
                            traceId?: ...;
                            version?: ...;
                        };
                    } & {
                        id: string;
                        metadata?: unknown;
                        timestamp: string;
                    }
                    | {
                        type: "sdk-log";
                    } & {
                        body: {
                            log: unknown;
                        };
                    } & {
                        id: string;
                        metadata?: unknown;
                        timestamp: string;
                    }
                    | {
                        type: "observation-create";
                    } & {
                        body: {
                            completionStartTime?: (...) | (...) | (...);
                            endTime?: (...) | (...) | (...);
                            id?: (...) | (...) | (...);
                            input?: unknown;
                            level?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            metadata?: unknown;
                            model?: (...) | (...) | (...);
                            modelParameters?: (...) | (...) | (...);
                            name?: (...) | (...) | (...);
                            output?: unknown;
                            parentObservationId?: (...) | (...) | (...);
                            startTime?: (...) | (...) | (...);
                            statusMessage?: (...) | (...) | (...);
                            traceId?: (...) | (...) | (...);
                            type: (...) | (...) | (...);
                            usage?: (...) | (...);
                            version?: (...) | (...) | (...);
                        };
                    } & {
                        id: string;
                        metadata?: unknown;
                        timestamp: string;
                    }
                    | {
                        type: "observation-update";
                    } & {
                        body: {
                            completionStartTime?: (...) | (...) | (...);
                            endTime?: (...) | (...) | (...);
                            id?: (...) | (...) | (...);
                            input?: unknown;
                            level?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            metadata?: unknown;
                            model?: (...) | (...) | (...);
                            modelParameters?: (...) | (...) | (...);
                            name?: (...) | (...) | (...);
                            output?: unknown;
                            parentObservationId?: (...) | (...) | (...);
                            startTime?: (...) | (...) | (...);
                            statusMessage?: (...) | (...) | (...);
                            traceId?: (...) | (...) | (...);
                            type: (...) | (...) | (...);
                            usage?: (...) | (...);
                            version?: (...) | (...) | (...);
                        };
                    } & {
                        id: string;
                        metadata?: unknown;
                        timestamp: string;
                    })[];
                metadata?: unknown;
            };
        }
        • application/json: {
              batch: (
                  | {
                      type: "trace-create";
                  } & {
                      body: {
                          id?: (...) | (...) | (...);
                          input?: unknown;
                          metadata?: unknown;
                          name?: (...) | (...) | (...);
                          output?: unknown;
                          public?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          release?: (...) | (...) | (...);
                          sessionId?: (...) | (...) | (...);
                          tags?: (...) | (...) | (...);
                          timestamp?: (...) | (...) | (...);
                          userId?: (...) | (...) | (...);
                          version?: (...) | (...) | (...);
                      };
                  } & {
                      id: string;
                      metadata?: unknown;
                      timestamp: string;
                  }
                  | {
                      type: "score-create";
                  } & {
                      body: {
                          comment?: (...) | (...) | (...);
                          configId?: (...) | (...) | (...);
                          dataType?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          id?: (...) | (...) | (...);
                          name: string;
                          observationId?: (...) | (...) | (...);
                          traceId: string;
                          value: (...) | (...);
                      };
                  } & {
                      id: string;
                      metadata?: unknown;
                      timestamp: string;
                  }
                  | {
                      type: "span-create";
                  } & {
                      body: {
                          endTime?: ...;
                      } & {
                          id?: ...;
                      } & {
                          input?: ...;
                          level?: ...;
                          metadata?: ...;
                          name?: ...;
                          output?: ...;
                          parentObservationId?: ...;
                          startTime?: ...;
                          statusMessage?: ...;
                          traceId?: ...;
                          version?: ...;
                      };
                  } & {
                      id: string;
                      metadata?: unknown;
                      timestamp: string;
                  }
                  | {
                      type: "span-update";
                  } & {
                      body: {
                          endTime?: ...;
                      } & {
                          id: ...;
                      } & {
                          input?: ...;
                          level?: ...;
                          metadata?: ...;
                          name?: ...;
                          output?: ...;
                          parentObservationId?: ...;
                          startTime?: ...;
                          statusMessage?: ...;
                          traceId?: ...;
                          version?: ...;
                      };
                  } & {
                      id: string;
                      metadata?: unknown;
                      timestamp: string;
                  }
                  | {
                      type: "generation-create";
                  } & {
                      body: {
                          completionStartTime?: ...;
                          costDetails?: ...;
                          model?: ...;
                          modelParameters?: ...;
                          promptName?: ...;
                          promptVersion?: ...;
                          usage?: ...;
                          usageDetails?: ...;
                      } & {
                          endTime?: ...;
                      } & {
                          id?: ...;
                      } & {
                          input?: ...;
                          level?: ...;
                          metadata?: ...;
                          name?: ...;
                          output?: ...;
                          parentObservationId?: ...;
                          startTime?: ...;
                          statusMessage?: ...;
                          traceId?: ...;
                          version?: ...;
                      };
                  } & {
                      id: string;
                      metadata?: unknown;
                      timestamp: string;
                  }
                  | {
                      type: "generation-update";
                  } & {
                      body: {
                          completionStartTime?: ...;
                          costDetails?: ...;
                          model?: ...;
                          modelParameters?: ...;
                          promptName?: ...;
                          promptVersion?: ...;
                          usage?: ...;
                          usageDetails?: ...;
                      } & {
                          endTime?: ...;
                      } & {
                          id: ...;
                      } & {
                          input?: ...;
                          level?: ...;
                          metadata?: ...;
                          name?: ...;
                          output?: ...;
                          parentObservationId?: ...;
                          startTime?: ...;
                          statusMessage?: ...;
                          traceId?: ...;
                          version?: ...;
                      };
                  } & {
                      id: string;
                      metadata?: unknown;
                      timestamp: string;
                  }
                  | {
                      type: "event-create";
                  } & {
                      body: {
                          id?: ...;
                      } & {
                          input?: ...;
                          level?: ...;
                          metadata?: ...;
                          name?: ...;
                          output?: ...;
                          parentObservationId?: ...;
                          startTime?: ...;
                          statusMessage?: ...;
                          traceId?: ...;
                          version?: ...;
                      };
                  } & {
                      id: string;
                      metadata?: unknown;
                      timestamp: string;
                  }
                  | {
                      type: "sdk-log";
                  } & {
                      body: {
                          log: unknown;
                      };
                  } & {
                      id: string;
                      metadata?: unknown;
                      timestamp: string;
                  }
                  | {
                      type: "observation-create";
                  } & {
                      body: {
                          completionStartTime?: (...) | (...) | (...);
                          endTime?: (...) | (...) | (...);
                          id?: (...) | (...) | (...);
                          input?: unknown;
                          level?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          metadata?: unknown;
                          model?: (...) | (...) | (...);
                          modelParameters?: (...) | (...) | (...);
                          name?: (...) | (...) | (...);
                          output?: unknown;
                          parentObservationId?: (...) | (...) | (...);
                          startTime?: (...) | (...) | (...);
                          statusMessage?: (...) | (...) | (...);
                          traceId?: (...) | (...) | (...);
                          type: (...) | (...) | (...);
                          usage?: (...) | (...);
                          version?: (...) | (...) | (...);
                      };
                  } & {
                      id: string;
                      metadata?: unknown;
                      timestamp: string;
                  }
                  | {
                      type: "observation-update";
                  } & {
                      body: {
                          completionStartTime?: (...) | (...) | (...);
                          endTime?: (...) | (...) | (...);
                          id?: (...) | (...) | (...);
                          input?: unknown;
                          level?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          metadata?: unknown;
                          model?: (...) | (...) | (...);
                          modelParameters?: (...) | (...) | (...);
                          name?: (...) | (...) | (...);
                          output?: unknown;
                          parentObservationId?: (...) | (...) | (...);
                          startTime?: (...) | (...) | (...);
                          statusMessage?: (...) | (...) | (...);
                          traceId?: (...) | (...) | (...);
                          type: (...) | (...) | (...);
                          usage?: (...) | (...);
                          version?: (...) | (...) | (...);
                      };
                  } & {
                      id: string;
                      metadata?: unknown;
                      timestamp: string;
                  })[];
              metadata?: unknown;
          }
          • batch: (
                | {
                    type: "trace-create";
                } & {
                    body: {
                        id?: (...) | (...) | (...);
                        input?: unknown;
                        metadata?: unknown;
                        name?: (...) | (...) | (...);
                        output?: unknown;
                        public?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        release?: (...) | (...) | (...);
                        sessionId?: (...) | (...) | (...);
                        tags?: (...) | (...) | (...);
                        timestamp?: (...) | (...) | (...);
                        userId?: (...) | (...) | (...);
                        version?: (...) | (...) | (...);
                    };
                } & {
                    id: string;
                    metadata?: unknown;
                    timestamp: string;
                }
                | {
                    type: "score-create";
                } & {
                    body: {
                        comment?: (...) | (...) | (...);
                        configId?: (...) | (...) | (...);
                        dataType?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        id?: (...) | (...) | (...);
                        name: string;
                        observationId?: (...) | (...) | (...);
                        traceId: string;
                        value: (...) | (...);
                    };
                } & {
                    id: string;
                    metadata?: unknown;
                    timestamp: string;
                }
                | {
                    type: "span-create";
                } & {
                    body: {
                        endTime?: ...;
                    } & {
                        id?: ...;
                    } & {
                        input?: ...;
                        level?: ...;
                        metadata?: ...;
                        name?: ...;
                        output?: ...;
                        parentObservationId?: ...;
                        startTime?: ...;
                        statusMessage?: ...;
                        traceId?: ...;
                        version?: ...;
                    };
                } & {
                    id: string;
                    metadata?: unknown;
                    timestamp: string;
                }
                | {
                    type: "span-update";
                } & {
                    body: {
                        endTime?: ...;
                    } & {
                        id: ...;
                    } & {
                        input?: ...;
                        level?: ...;
                        metadata?: ...;
                        name?: ...;
                        output?: ...;
                        parentObservationId?: ...;
                        startTime?: ...;
                        statusMessage?: ...;
                        traceId?: ...;
                        version?: ...;
                    };
                } & {
                    id: string;
                    metadata?: unknown;
                    timestamp: string;
                }
                | {
                    type: "generation-create";
                } & {
                    body: {
                        completionStartTime?: ...;
                        costDetails?: ...;
                        model?: ...;
                        modelParameters?: ...;
                        promptName?: ...;
                        promptVersion?: ...;
                        usage?: ...;
                        usageDetails?: ...;
                    } & {
                        endTime?: ...;
                    } & {
                        id?: ...;
                    } & {
                        input?: ...;
                        level?: ...;
                        metadata?: ...;
                        name?: ...;
                        output?: ...;
                        parentObservationId?: ...;
                        startTime?: ...;
                        statusMessage?: ...;
                        traceId?: ...;
                        version?: ...;
                    };
                } & {
                    id: string;
                    metadata?: unknown;
                    timestamp: string;
                }
                | {
                    type: "generation-update";
                } & {
                    body: {
                        completionStartTime?: ...;
                        costDetails?: ...;
                        model?: ...;
                        modelParameters?: ...;
                        promptName?: ...;
                        promptVersion?: ...;
                        usage?: ...;
                        usageDetails?: ...;
                    } & {
                        endTime?: ...;
                    } & {
                        id: ...;
                    } & {
                        input?: ...;
                        level?: ...;
                        metadata?: ...;
                        name?: ...;
                        output?: ...;
                        parentObservationId?: ...;
                        startTime?: ...;
                        statusMessage?: ...;
                        traceId?: ...;
                        version?: ...;
                    };
                } & {
                    id: string;
                    metadata?: unknown;
                    timestamp: string;
                }
                | {
                    type: "event-create";
                } & {
                    body: {
                        id?: ...;
                    } & {
                        input?: ...;
                        level?: ...;
                        metadata?: ...;
                        name?: ...;
                        output?: ...;
                        parentObservationId?: ...;
                        startTime?: ...;
                        statusMessage?: ...;
                        traceId?: ...;
                        version?: ...;
                    };
                } & {
                    id: string;
                    metadata?: unknown;
                    timestamp: string;
                }
                | {
                    type: "sdk-log";
                } & {
                    body: {
                        log: unknown;
                    };
                } & {
                    id: string;
                    metadata?: unknown;
                    timestamp: string;
                }
                | {
                    type: "observation-create";
                } & {
                    body: {
                        completionStartTime?: (...) | (...) | (...);
                        endTime?: (...) | (...) | (...);
                        id?: (...) | (...) | (...);
                        input?: unknown;
                        level?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        metadata?: unknown;
                        model?: (...) | (...) | (...);
                        modelParameters?: (...) | (...) | (...);
                        name?: (...) | (...) | (...);
                        output?: unknown;
                        parentObservationId?: (...) | (...) | (...);
                        startTime?: (...) | (...) | (...);
                        statusMessage?: (...) | (...) | (...);
                        traceId?: (...) | (...) | (...);
                        type: (...) | (...) | (...);
                        usage?: (...) | (...);
                        version?: (...) | (...) | (...);
                    };
                } & {
                    id: string;
                    metadata?: unknown;
                    timestamp: string;
                }
                | {
                    type: "observation-update";
                } & {
                    body: {
                        completionStartTime?: (...) | (...) | (...);
                        endTime?: (...) | (...) | (...);
                        id?: (...) | (...) | (...);
                        input?: unknown;
                        level?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        metadata?: unknown;
                        model?: (...) | (...) | (...);
                        modelParameters?: (...) | (...) | (...);
                        name?: (...) | (...) | (...);
                        output?: unknown;
                        parentObservationId?: (...) | (...) | (...);
                        startTime?: (...) | (...) | (...);
                        statusMessage?: (...) | (...) | (...);
                        traceId?: (...) | (...) | (...);
                        type: (...) | (...) | (...);
                        usage?: (...) | (...);
                        version?: (...) | (...) | (...);
                    };
                } & {
                    id: string;
                    metadata?: unknown;
                    timestamp: string;
                })[]

            Batch of tracing events to be ingested. Discriminated by attribute type.

          • Optionalmetadata?: unknown

            Optional. Metadata field used by the Langfuse SDKs for debugging.

    • responses: {
          207: {
              content: {
                  application/json: {
                      errors: {
                          error?: unknown;
                          id: string;
                          message?: null | string;
                          status: number;
                      }[];
                      successes: {
                          id: string;
                          status: number;
                      }[];
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 207: {
            content: {
                application/json: {
                    errors: {
                        error?: unknown;
                        id: string;
                        message?: null | string;
                        status: number;
                    }[];
                    successes: {
                        id: string;
                        status: number;
                    }[];
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  errors: {
                      error?: unknown;
                      id: string;
                      message?: null | string;
                      status: number;
                  }[];
                  successes: {
                      id: string;
                      status: number;
                  }[];
              };
          }
          • application/json: {
                errors: {
                    error?: unknown;
                    id: string;
                    message?: null | string;
                    status: number;
                }[];
                successes: {
                    id: string;
                    status: number;
                }[];
            }
            • errors: {
                  error?: unknown;
                  id: string;
                  message?: null | string;
                  status: number;
              }[]
            • successes: {
                  id: string;
                  status: number;
              }[]
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/media: {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    contentLength: number;
                    contentType:
                        | "image/png"
                        | "image/jpeg"
                        | "image/jpg"
                        | "image/webp"
                        | "image/gif"
                        | "image/svg+xml"
                        | "image/tiff"
                        | "image/bmp"
                        | "audio/mpeg"
                        | "audio/mp3"
                        | "audio/wav"
                        | "audio/ogg"
                        | "audio/oga"
                        | "audio/aac"
                        | "audio/mp4"
                        | "audio/flac"
                        | "video/mp4"
                        | "video/webm"
                        | "text/plain"
                        | "text/html"
                        | "text/css"
                        | "text/csv"
                        | "application/pdf"
                        | "application/msword"
                        | "application/vnd.ms-excel"
                        | "application/zip"
                        | "application/json"
                        | "application/xml"
                        | "application/octet-stream";
                    field: string;
                    observationId?: null | string;
                    sha256Hash: string;
                    traceId: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        mediaId: string;
                        uploadUrl?: null | string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    contentLength: number;
                    contentType:
                        | "image/png"
                        | "image/jpeg"
                        | "image/jpg"
                        | "image/webp"
                        | "image/gif"
                        | "image/svg+xml"
                        | "image/tiff"
                        | "image/bmp"
                        | "audio/mpeg"
                        | "audio/mp3"
                        | "audio/wav"
                        | "audio/ogg"
                        | "audio/oga"
                        | "audio/aac"
                        | "audio/mp4"
                        | "audio/flac"
                        | "video/mp4"
                        | "video/webm"
                        | "text/plain"
                        | "text/html"
                        | "text/css"
                        | "text/csv"
                        | "application/pdf"
                        | "application/msword"
                        | "application/vnd.ms-excel"
                        | "application/zip"
                        | "application/json"
                        | "application/xml"
                        | "application/octet-stream";
                    field: string;
                    observationId?: null | string;
                    sha256Hash: string;
                    traceId: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        mediaId: string;
                        uploadUrl?: null | string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a presigned upload URL for a media record

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: undefined
    • requestBody: {
          content: {
              application/json: {
                  contentLength: number;
                  contentType:
                      | "image/png"
                      | "image/jpeg"
                      | "image/jpg"
                      | "image/webp"
                      | "image/gif"
                      | "image/svg+xml"
                      | "image/tiff"
                      | "image/bmp"
                      | "audio/mpeg"
                      | "audio/mp3"
                      | "audio/wav"
                      | "audio/ogg"
                      | "audio/oga"
                      | "audio/aac"
                      | "audio/mp4"
                      | "audio/flac"
                      | "video/mp4"
                      | "video/webm"
                      | "text/plain"
                      | "text/html"
                      | "text/css"
                      | "text/csv"
                      | "application/pdf"
                      | "application/msword"
                      | "application/vnd.ms-excel"
                      | "application/zip"
                      | "application/json"
                      | "application/xml"
                      | "application/octet-stream";
                  field: string;
                  observationId?: null | string;
                  sha256Hash: string;
                  traceId: string;
              };
          };
      }
      • content: {
            application/json: {
                contentLength: number;
                contentType:
                    | "image/png"
                    | "image/jpeg"
                    | "image/jpg"
                    | "image/webp"
                    | "image/gif"
                    | "image/svg+xml"
                    | "image/tiff"
                    | "image/bmp"
                    | "audio/mpeg"
                    | "audio/mp3"
                    | "audio/wav"
                    | "audio/ogg"
                    | "audio/oga"
                    | "audio/aac"
                    | "audio/mp4"
                    | "audio/flac"
                    | "video/mp4"
                    | "video/webm"
                    | "text/plain"
                    | "text/html"
                    | "text/css"
                    | "text/csv"
                    | "application/pdf"
                    | "application/msword"
                    | "application/vnd.ms-excel"
                    | "application/zip"
                    | "application/json"
                    | "application/xml"
                    | "application/octet-stream";
                field: string;
                observationId?: null | string;
                sha256Hash: string;
                traceId: string;
            };
        }
        • application/json: {
              contentLength: number;
              contentType:
                  | "image/png"
                  | "image/jpeg"
                  | "image/jpg"
                  | "image/webp"
                  | "image/gif"
                  | "image/svg+xml"
                  | "image/tiff"
                  | "image/bmp"
                  | "audio/mpeg"
                  | "audio/mp3"
                  | "audio/wav"
                  | "audio/ogg"
                  | "audio/oga"
                  | "audio/aac"
                  | "audio/mp4"
                  | "audio/flac"
                  | "video/mp4"
                  | "video/webm"
                  | "text/plain"
                  | "text/html"
                  | "text/css"
                  | "text/csv"
                  | "application/pdf"
                  | "application/msword"
                  | "application/vnd.ms-excel"
                  | "application/zip"
                  | "application/json"
                  | "application/xml"
                  | "application/octet-stream";
              field: string;
              observationId?: null | string;
              sha256Hash: string;
              traceId: string;
          }
          • contentLength: number

            The size of the media record in bytes

          • contentType:
                | "image/png"
                | "image/jpeg"
                | "image/jpg"
                | "image/webp"
                | "image/gif"
                | "image/svg+xml"
                | "image/tiff"
                | "image/bmp"
                | "audio/mpeg"
                | "audio/mp3"
                | "audio/wav"
                | "audio/ogg"
                | "audio/oga"
                | "audio/aac"
                | "audio/mp4"
                | "audio/flac"
                | "video/mp4"
                | "video/webm"
                | "text/plain"
                | "text/html"
                | "text/css"
                | "text/csv"
                | "application/pdf"
                | "application/msword"
                | "application/vnd.ms-excel"
                | "application/zip"
                | "application/json"
                | "application/xml"
                | "application/octet-stream"
          • field: string

            The trace / observation field the media record is associated with. This can be one of input, output, metadata

          • OptionalobservationId?: null | string

            The observation ID associated with the media record. If the media record is associated directly with a trace, this will be null.

          • sha256Hash: string

            The SHA-256 hash of the media record

          • traceId: string

            The trace ID associated with the media record

    • responses: {
          200: {
              content: {
                  application/json: {
                      mediaId: string;
                      uploadUrl?: null | string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    mediaId: string;
                    uploadUrl?: null | string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  mediaId: string;
                  uploadUrl?: null | string;
              };
          }
          • application/json: {
                mediaId: string;
                uploadUrl?: null | string;
            }
            • mediaId: string

              The unique langfuse identifier of a media record

            • OptionaluploadUrl?: null | string

              The presigned upload URL. If the asset is already uploaded, this will be null

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/media/{mediaId}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                mediaId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        contentLength: number;
                        contentType: string;
                        mediaId: string;
                        uploadedAt: string;
                        url: string;
                        urlExpiry: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                mediaId: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    uploadedAt: string;
                    uploadHttpError?: null | string;
                    uploadHttpStatus: number;
                    uploadTimeMs?: null | number;
                };
            };
        };
        responses: {
            204: {
                content?: undefined;
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                mediaId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        contentLength: number;
                        contentType: string;
                        mediaId: string;
                        uploadedAt: string;
                        url: string;
                        urlExpiry: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a media record

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              mediaId: string;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            mediaId: string;
        }
        • mediaId: string

          The unique langfuse identifier of a media record

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      contentLength: number;
                      contentType: string;
                      mediaId: string;
                      uploadedAt: string;
                      url: string;
                      urlExpiry: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    contentLength: number;
                    contentType: string;
                    mediaId: string;
                    uploadedAt: string;
                    url: string;
                    urlExpiry: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  contentLength: number;
                  contentType: string;
                  mediaId: string;
                  uploadedAt: string;
                  url: string;
                  urlExpiry: string;
              };
          }
          • application/json: {
                contentLength: number;
                contentType: string;
                mediaId: string;
                uploadedAt: string;
                url: string;
                urlExpiry: string;
            }
            • contentLength: number

              The size of the media record in bytes

            • contentType: string

              The MIME type of the media record

            • mediaId: string

              The unique langfuse identifier of a media record

            • uploadedAt: string

              Format: date-time

              The date and time when the media record was uploaded

            • url: string

              The download URL of the media record

            • urlExpiry: string

              The expiry date and time of the media record download URL

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • patch: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                mediaId: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    uploadedAt: string;
                    uploadHttpError?: null | string;
                    uploadHttpStatus: number;
                    uploadTimeMs?: null | number;
                };
            };
        };
        responses: {
            204: {
                content?: undefined;
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Patch a media record

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              mediaId: string;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            mediaId: string;
        }
        • mediaId: string

          The unique langfuse identifier of a media record

      • Optionalquery?: undefined
    • requestBody: {
          content: {
              application/json: {
                  uploadedAt: string;
                  uploadHttpError?: null | string;
                  uploadHttpStatus: number;
                  uploadTimeMs?: null | number;
              };
          };
      }
      • content: {
            application/json: {
                uploadedAt: string;
                uploadHttpError?: null | string;
                uploadHttpStatus: number;
                uploadTimeMs?: null | number;
            };
        }
        • application/json: {
              uploadedAt: string;
              uploadHttpError?: null | string;
              uploadHttpStatus: number;
              uploadTimeMs?: null | number;
          }
          • uploadedAt: string

            Format: date-time

            The date and time when the media record was uploaded

          • OptionaluploadHttpError?: null | string

            The HTTP error message of the upload

          • uploadHttpStatus: number

            The HTTP status code of the upload

          • OptionaluploadTimeMs?: null | number

            The time in milliseconds it took to upload the media record

    • responses: {
          204: {
              content?: undefined;
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 204: {
            content?: undefined;
            headers: {
                [name: string]: unknown;
            };
        }
        • Optionalcontent?: undefined
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/metrics/daily: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                fromTimestamp?: null | string;
                limit?: null | number;
                page?: null | number;
                tags?: (null | string)[];
                toTimestamp?: null | string;
                traceName?: null | string;
                userId?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            countObservations: number;
                            countTraces: number;
                            date: string;
                            totalCost: number;
                            usage: {
                                countObservations: number;
                                countTraces: number;
                                inputUsage: number;
                                model?: (...) | (...) | (...);
                                outputUsage: number;
                                totalCost: number;
                                totalUsage: number;
                            }[];
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                fromTimestamp?: null | string;
                limit?: null | number;
                page?: null | number;
                tags?: (null | string)[];
                toTimestamp?: null | string;
                traceName?: null | string;
                userId?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            countObservations: number;
                            countTraces: number;
                            date: string;
                            totalCost: number;
                            usage: {
                                countObservations: number;
                                countTraces: number;
                                inputUsage: number;
                                model?: (...) | (...) | (...);
                                outputUsage: number;
                                totalCost: number;
                                totalUsage: number;
                            }[];
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get daily metrics of the Langfuse project

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              fromTimestamp?: null | string;
              limit?: null | number;
              page?: null | number;
              tags?: (null | string)[];
              toTimestamp?: null | string;
              traceName?: null | string;
              userId?: null | string;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: {
            fromTimestamp?: null | string;
            limit?: null | number;
            page?: null | number;
            tags?: (null | string)[];
            toTimestamp?: null | string;
            traceName?: null | string;
            userId?: null | string;
        }
        • OptionalfromTimestamp?: null | string

          Optional filter to only include traces and observations on or after a certain datetime (ISO 8601)

        • Optionallimit?: null | number

          limit of items per page

        • Optionalpage?: null | number

          page number, starts at 1

        • Optionaltags?: (null | string)[]

          Optional filter for metrics where traces include all of these tags

        • OptionaltoTimestamp?: null | string

          Optional filter to only include traces and observations before a certain datetime (ISO 8601)

        • OptionaltraceName?: null | string

          Optional filter by the name of the trace

        • OptionaluserId?: null | string

          Optional filter by the userId associated with the trace

    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      data: {
                          countObservations: number;
                          countTraces: number;
                          date: string;
                          totalCost: number;
                          usage: {
                              countObservations: number;
                              countTraces: number;
                              inputUsage: number;
                              model?: (...) | (...) | (...);
                              outputUsage: number;
                              totalCost: number;
                              totalUsage: number;
                          }[];
                      }[];
                      meta: {
                          limit: number;
                          page: number;
                          totalItems: number;
                          totalPages: number;
                      };
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    data: {
                        countObservations: number;
                        countTraces: number;
                        date: string;
                        totalCost: number;
                        usage: {
                            countObservations: number;
                            countTraces: number;
                            inputUsage: number;
                            model?: (...) | (...) | (...);
                            outputUsage: number;
                            totalCost: number;
                            totalUsage: number;
                        }[];
                    }[];
                    meta: {
                        limit: number;
                        page: number;
                        totalItems: number;
                        totalPages: number;
                    };
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  data: {
                      countObservations: number;
                      countTraces: number;
                      date: string;
                      totalCost: number;
                      usage: {
                          countObservations: number;
                          countTraces: number;
                          inputUsage: number;
                          model?: (...) | (...) | (...);
                          outputUsage: number;
                          totalCost: number;
                          totalUsage: number;
                      }[];
                  }[];
                  meta: {
                      limit: number;
                      page: number;
                      totalItems: number;
                      totalPages: number;
                  };
              };
          }
          • application/json: {
                data: {
                    countObservations: number;
                    countTraces: number;
                    date: string;
                    totalCost: number;
                    usage: {
                        countObservations: number;
                        countTraces: number;
                        inputUsage: number;
                        model?: (...) | (...) | (...);
                        outputUsage: number;
                        totalCost: number;
                        totalUsage: number;
                    }[];
                }[];
                meta: {
                    limit: number;
                    page: number;
                    totalItems: number;
                    totalPages: number;
                };
            }
            • data: {
                  countObservations: number;
                  countTraces: number;
                  date: string;
                  totalCost: number;
                  usage: {
                      countObservations: number;
                      countTraces: number;
                      inputUsage: number;
                      model?: (...) | (...) | (...);
                      outputUsage: number;
                      totalCost: number;
                      totalUsage: number;
                  }[];
              }[]

              A list of daily metrics, only days with ingested data are included.

            • meta: {
                  limit: number;
                  page: number;
                  totalItems: number;
                  totalPages: number;
              }
              • limit: number

                number of items per page

              • page: number

                current page number

              • totalItems: number

                number of total items given the current filters/selection (if any)

              • totalPages: number

                number of total pages given the current limit

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/models: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                limit?: null | number;
                page?: null | number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            id: string;
                            inputPrice?: null | number;
                            isLangfuseManaged: boolean;
                            matchPattern: string;
                            modelName: string;
                            outputPrice?: null | number;
                            startDate?: null | string;
                            tokenizerConfig?: unknown;
                            tokenizerId?: null | string;
                            totalPrice?: null | number;
                            unit?:
                                | "CHARACTERS"
                                | "TOKENS"
                                | "MILLISECONDS"
                                | "SECONDS"
                                | "IMAGES"
                                | "REQUESTS";
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    inputPrice?: null | number;
                    matchPattern: string;
                    modelName: string;
                    outputPrice?: null | number;
                    startDate?: null | string;
                    tokenizerConfig?: unknown;
                    tokenizerId?: null | string;
                    totalPrice?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        id: string;
                        inputPrice?: null | number;
                        isLangfuseManaged: boolean;
                        matchPattern: string;
                        modelName: string;
                        outputPrice?: null | number;
                        startDate?: null | string;
                        tokenizerConfig?: unknown;
                        tokenizerId?: null | string;
                        totalPrice?: null | number;
                        unit?:
                            | "CHARACTERS"
                            | "TOKENS"
                            | "MILLISECONDS"
                            | "SECONDS"
                            | "IMAGES"
                            | "REQUESTS";
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                limit?: null | number;
                page?: null | number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            id: string;
                            inputPrice?: null | number;
                            isLangfuseManaged: boolean;
                            matchPattern: string;
                            modelName: string;
                            outputPrice?: null | number;
                            startDate?: null | string;
                            tokenizerConfig?: unknown;
                            tokenizerId?: null | string;
                            totalPrice?: null | number;
                            unit?:
                                | "CHARACTERS"
                                | "TOKENS"
                                | "MILLISECONDS"
                                | "SECONDS"
                                | "IMAGES"
                                | "REQUESTS";
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get all models

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              limit?: null | number;
              page?: null | number;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: {
            limit?: null | number;
            page?: null | number;
        }
        • Optionallimit?: null | number

          limit of items per page

        • Optionalpage?: null | number

          page number, starts at 1

    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      data: {
                          id: string;
                          inputPrice?: null | number;
                          isLangfuseManaged: boolean;
                          matchPattern: string;
                          modelName: string;
                          outputPrice?: null | number;
                          startDate?: null | string;
                          tokenizerConfig?: unknown;
                          tokenizerId?: null | string;
                          totalPrice?: null | number;
                          unit?:
                              | "CHARACTERS"
                              | "TOKENS"
                              | "MILLISECONDS"
                              | "SECONDS"
                              | "IMAGES"
                              | "REQUESTS";
                      }[];
                      meta: {
                          limit: number;
                          page: number;
                          totalItems: number;
                          totalPages: number;
                      };
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    data: {
                        id: string;
                        inputPrice?: null | number;
                        isLangfuseManaged: boolean;
                        matchPattern: string;
                        modelName: string;
                        outputPrice?: null | number;
                        startDate?: null | string;
                        tokenizerConfig?: unknown;
                        tokenizerId?: null | string;
                        totalPrice?: null | number;
                        unit?:
                            | "CHARACTERS"
                            | "TOKENS"
                            | "MILLISECONDS"
                            | "SECONDS"
                            | "IMAGES"
                            | "REQUESTS";
                    }[];
                    meta: {
                        limit: number;
                        page: number;
                        totalItems: number;
                        totalPages: number;
                    };
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  data: {
                      id: string;
                      inputPrice?: null | number;
                      isLangfuseManaged: boolean;
                      matchPattern: string;
                      modelName: string;
                      outputPrice?: null | number;
                      startDate?: null | string;
                      tokenizerConfig?: unknown;
                      tokenizerId?: null | string;
                      totalPrice?: null | number;
                      unit?:
                          | "CHARACTERS"
                          | "TOKENS"
                          | "MILLISECONDS"
                          | "SECONDS"
                          | "IMAGES"
                          | "REQUESTS";
                  }[];
                  meta: {
                      limit: number;
                      page: number;
                      totalItems: number;
                      totalPages: number;
                  };
              };
          }
          • application/json: {
                data: {
                    id: string;
                    inputPrice?: null | number;
                    isLangfuseManaged: boolean;
                    matchPattern: string;
                    modelName: string;
                    outputPrice?: null | number;
                    startDate?: null | string;
                    tokenizerConfig?: unknown;
                    tokenizerId?: null | string;
                    totalPrice?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                }[];
                meta: {
                    limit: number;
                    page: number;
                    totalItems: number;
                    totalPages: number;
                };
            }
            • data: {
                  id: string;
                  inputPrice?: null | number;
                  isLangfuseManaged: boolean;
                  matchPattern: string;
                  modelName: string;
                  outputPrice?: null | number;
                  startDate?: null | string;
                  tokenizerConfig?: unknown;
                  tokenizerId?: null | string;
                  totalPrice?: null | number;
                  unit?:
                      | "CHARACTERS"
                      | "TOKENS"
                      | "MILLISECONDS"
                      | "SECONDS"
                      | "IMAGES"
                      | "REQUESTS";
              }[]
            • meta: {
                  limit: number;
                  page: number;
                  totalItems: number;
                  totalPages: number;
              }
              • limit: number

                number of items per page

              • page: number

                current page number

              • totalItems: number

                number of total items given the current filters/selection (if any)

              • totalPages: number

                number of total pages given the current limit

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    inputPrice?: null | number;
                    matchPattern: string;
                    modelName: string;
                    outputPrice?: null | number;
                    startDate?: null | string;
                    tokenizerConfig?: unknown;
                    tokenizerId?: null | string;
                    totalPrice?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        id: string;
                        inputPrice?: null | number;
                        isLangfuseManaged: boolean;
                        matchPattern: string;
                        modelName: string;
                        outputPrice?: null | number;
                        startDate?: null | string;
                        tokenizerConfig?: unknown;
                        tokenizerId?: null | string;
                        totalPrice?: null | number;
                        unit?:
                            | "CHARACTERS"
                            | "TOKENS"
                            | "MILLISECONDS"
                            | "SECONDS"
                            | "IMAGES"
                            | "REQUESTS";
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Create a model

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: undefined
    • requestBody: {
          content: {
              application/json: {
                  inputPrice?: null | number;
                  matchPattern: string;
                  modelName: string;
                  outputPrice?: null | number;
                  startDate?: null | string;
                  tokenizerConfig?: unknown;
                  tokenizerId?: null | string;
                  totalPrice?: null | number;
                  unit?:
                      | "CHARACTERS"
                      | "TOKENS"
                      | "MILLISECONDS"
                      | "SECONDS"
                      | "IMAGES"
                      | "REQUESTS";
              };
          };
      }
      • content: {
            application/json: {
                inputPrice?: null | number;
                matchPattern: string;
                modelName: string;
                outputPrice?: null | number;
                startDate?: null | string;
                tokenizerConfig?: unknown;
                tokenizerId?: null | string;
                totalPrice?: null | number;
                unit?:
                    | "CHARACTERS"
                    | "TOKENS"
                    | "MILLISECONDS"
                    | "SECONDS"
                    | "IMAGES"
                    | "REQUESTS";
            };
        }
        • application/json: {
              inputPrice?: null | number;
              matchPattern: string;
              modelName: string;
              outputPrice?: null | number;
              startDate?: null | string;
              tokenizerConfig?: unknown;
              tokenizerId?: null | string;
              totalPrice?: null | number;
              unit?:
                  | "CHARACTERS"
                  | "TOKENS"
                  | "MILLISECONDS"
                  | "SECONDS"
                  | "IMAGES"
                  | "REQUESTS";
          }
          • OptionalinputPrice?: null | number

            Format: double

            Price (USD) per input unit

          • matchPattern: string

            Regex pattern which matches this model definition to generation.model. Useful in case of fine-tuned models. If you want to exact match, use (?i)^modelname$

          • modelName: string

            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<observation.startTime

          • OptionaloutputPrice?: null | number

            Format: double

            Price (USD) per output unit

          • OptionalstartDate?: null | string

            Format: date-time

            Apply only to generations which are newer than this ISO date.

          • OptionaltokenizerConfig?: unknown

            Optional. Configuration for the selected tokenizer. Needs to be JSON. See docs for more details.

          • OptionaltokenizerId?: null | string

            Optional. Tokenizer to be applied to observations which match to this model. See docs for more details.

          • OptionaltotalPrice?: null | number

            Format: double

            Price (USD) per total units. Cannot be set if input or output price is set.

          • Optionalunit?:
                | "CHARACTERS"
                | "TOKENS"
                | "MILLISECONDS"
                | "SECONDS"
                | "IMAGES"
                | "REQUESTS"

            Unit used by this model.

    • responses: {
          200: {
              content: {
                  application/json: {
                      id: string;
                      inputPrice?: null | number;
                      isLangfuseManaged: boolean;
                      matchPattern: string;
                      modelName: string;
                      outputPrice?: null | number;
                      startDate?: null | string;
                      tokenizerConfig?: unknown;
                      tokenizerId?: null | string;
                      totalPrice?: null | number;
                      unit?:
                          | "CHARACTERS"
                          | "TOKENS"
                          | "MILLISECONDS"
                          | "SECONDS"
                          | "IMAGES"
                          | "REQUESTS";
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    id: string;
                    inputPrice?: null | number;
                    isLangfuseManaged: boolean;
                    matchPattern: string;
                    modelName: string;
                    outputPrice?: null | number;
                    startDate?: null | string;
                    tokenizerConfig?: unknown;
                    tokenizerId?: null | string;
                    totalPrice?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  id: string;
                  inputPrice?: null | number;
                  isLangfuseManaged: boolean;
                  matchPattern: string;
                  modelName: string;
                  outputPrice?: null | number;
                  startDate?: null | string;
                  tokenizerConfig?: unknown;
                  tokenizerId?: null | string;
                  totalPrice?: null | number;
                  unit?:
                      | "CHARACTERS"
                      | "TOKENS"
                      | "MILLISECONDS"
                      | "SECONDS"
                      | "IMAGES"
                      | "REQUESTS";
              };
          }
          • application/json: {
                id: string;
                inputPrice?: null | number;
                isLangfuseManaged: boolean;
                matchPattern: string;
                modelName: string;
                outputPrice?: null | number;
                startDate?: null | string;
                tokenizerConfig?: unknown;
                tokenizerId?: null | string;
                totalPrice?: null | number;
                unit?:
                    | "CHARACTERS"
                    | "TOKENS"
                    | "MILLISECONDS"
                    | "SECONDS"
                    | "IMAGES"
                    | "REQUESTS";
            }
            • id: string
            • OptionalinputPrice?: null | number

              Format: double

              Price (USD) per input unit

            • isLangfuseManaged: boolean
            • matchPattern: string

              Regex pattern which matches this model definition to generation.model. Useful in case of fine-tuned models. If you want to exact match, use (?i)^modelname$

            • modelName: string

              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<observation.startTime

            • OptionaloutputPrice?: null | number

              Format: double

              Price (USD) per output unit

            • OptionalstartDate?: null | string

              Format: date-time

              Apply only to generations which are newer than this ISO date.

            • OptionaltokenizerConfig?: unknown

              Optional. Configuration for the selected tokenizer. Needs to be JSON. See docs for more details.

            • OptionaltokenizerId?: null | string

              Optional. Tokenizer to be applied to observations which match to this model. See docs for more details.

            • OptionaltotalPrice?: null | number

              Format: double

              Price (USD) per total unit. Cannot be set if input or output price is set.

            • Optionalunit?:
                  | "CHARACTERS"
                  | "TOKENS"
                  | "MILLISECONDS"
                  | "SECONDS"
                  | "IMAGES"
                  | "REQUESTS"

              Unit used by this model.

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/models/{id}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                id: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                id: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        id: string;
                        inputPrice?: null | number;
                        isLangfuseManaged: boolean;
                        matchPattern: string;
                        modelName: string;
                        outputPrice?: null | number;
                        startDate?: null | string;
                        tokenizerConfig?: unknown;
                        tokenizerId?: null | string;
                        totalPrice?: null | number;
                        unit?:
                            | "CHARACTERS"
                            | "TOKENS"
                            | "MILLISECONDS"
                            | "SECONDS"
                            | "IMAGES"
                            | "REQUESTS";
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                id: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Delete a model. Cannot delete models managed by Langfuse. You can create your own definition with the same modelName to override the definition though.

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              id: string;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            id: string;
        }
        • id: string
      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          204: {
              content?: undefined;
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 204: {
            content?: undefined;
            headers: {
                [name: string]: unknown;
            };
        }
        • Optionalcontent?: undefined
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                id: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        id: string;
                        inputPrice?: null | number;
                        isLangfuseManaged: boolean;
                        matchPattern: string;
                        modelName: string;
                        outputPrice?: null | number;
                        startDate?: null | string;
                        tokenizerConfig?: unknown;
                        tokenizerId?: null | string;
                        totalPrice?: null | number;
                        unit?:
                            | "CHARACTERS"
                            | "TOKENS"
                            | "MILLISECONDS"
                            | "SECONDS"
                            | "IMAGES"
                            | "REQUESTS";
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a model

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              id: string;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            id: string;
        }
        • id: string
      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      id: string;
                      inputPrice?: null | number;
                      isLangfuseManaged: boolean;
                      matchPattern: string;
                      modelName: string;
                      outputPrice?: null | number;
                      startDate?: null | string;
                      tokenizerConfig?: unknown;
                      tokenizerId?: null | string;
                      totalPrice?: null | number;
                      unit?:
                          | "CHARACTERS"
                          | "TOKENS"
                          | "MILLISECONDS"
                          | "SECONDS"
                          | "IMAGES"
                          | "REQUESTS";
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    id: string;
                    inputPrice?: null | number;
                    isLangfuseManaged: boolean;
                    matchPattern: string;
                    modelName: string;
                    outputPrice?: null | number;
                    startDate?: null | string;
                    tokenizerConfig?: unknown;
                    tokenizerId?: null | string;
                    totalPrice?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  id: string;
                  inputPrice?: null | number;
                  isLangfuseManaged: boolean;
                  matchPattern: string;
                  modelName: string;
                  outputPrice?: null | number;
                  startDate?: null | string;
                  tokenizerConfig?: unknown;
                  tokenizerId?: null | string;
                  totalPrice?: null | number;
                  unit?:
                      | "CHARACTERS"
                      | "TOKENS"
                      | "MILLISECONDS"
                      | "SECONDS"
                      | "IMAGES"
                      | "REQUESTS";
              };
          }
          • application/json: {
                id: string;
                inputPrice?: null | number;
                isLangfuseManaged: boolean;
                matchPattern: string;
                modelName: string;
                outputPrice?: null | number;
                startDate?: null | string;
                tokenizerConfig?: unknown;
                tokenizerId?: null | string;
                totalPrice?: null | number;
                unit?:
                    | "CHARACTERS"
                    | "TOKENS"
                    | "MILLISECONDS"
                    | "SECONDS"
                    | "IMAGES"
                    | "REQUESTS";
            }
            • id: string
            • OptionalinputPrice?: null | number

              Format: double

              Price (USD) per input unit

            • isLangfuseManaged: boolean
            • matchPattern: string

              Regex pattern which matches this model definition to generation.model. Useful in case of fine-tuned models. If you want to exact match, use (?i)^modelname$

            • modelName: string

              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<observation.startTime

            • OptionaloutputPrice?: null | number

              Format: double

              Price (USD) per output unit

            • OptionalstartDate?: null | string

              Format: date-time

              Apply only to generations which are newer than this ISO date.

            • OptionaltokenizerConfig?: unknown

              Optional. Configuration for the selected tokenizer. Needs to be JSON. See docs for more details.

            • OptionaltokenizerId?: null | string

              Optional. Tokenizer to be applied to observations which match to this model. See docs for more details.

            • OptionaltotalPrice?: null | number

              Format: double

              Price (USD) per total unit. Cannot be set if input or output price is set.

            • Optionalunit?:
                  | "CHARACTERS"
                  | "TOKENS"
                  | "MILLISECONDS"
                  | "SECONDS"
                  | "IMAGES"
                  | "REQUESTS"

              Unit used by this model.

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/observations: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                fromStartTime?: null | string;
                limit?: null | number;
                name?: null | string;
                page?: null | number;
                parentObservationId?: null | string;
                toStartTime?: null | string;
                traceId?: null | string;
                type?: null | string;
                userId?: null | string;
                version?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: ({
                            calculatedInputCost?: null | number;
                            calculatedOutputCost?: null | number;
                            calculatedTotalCost?: null | number;
                            inputPrice?: null | number;
                            latency?: null | number;
                            modelId?: null | string;
                            outputPrice?: null | number;
                            promptName?: null | string;
                            promptVersion?: null | number;
                            timeToFirstToken?: null | number;
                            totalPrice?: null | number;
                        } & {
                            completionStartTime?: null | string;
                            costDetails?: null | {
                                [key: ...]: ...;
                            };
                            endTime?: null | string;
                            id: string;
                            input?: unknown;
                            level:
                                | "DEBUG"
                                | "DEFAULT"
                                | "WARNING"
                                | "ERROR";
                            metadata?: unknown;
                            model?: null | string;
                            modelParameters?: null | {
                                [key: ...]: ...;
                            };
                            name?: null | string;
                            output?: unknown;
                            parentObservationId?: null | string;
                            promptId?: null | string;
                            startTime: string;
                            statusMessage?: null | string;
                            traceId?: null | string;
                            type: string;
                            usage?: {
                                input?: ...;
                                inputCost?: ...;
                                output?: ...;
                                outputCost?: ...;
                                total?: ...;
                                totalCost?: ...;
                                unit?: ...;
                            };
                            usageDetails?: null | {
                                [key: ...]: ...;
                            };
                            version?: null | string;
                        })[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                fromStartTime?: null | string;
                limit?: null | number;
                name?: null | string;
                page?: null | number;
                parentObservationId?: null | string;
                toStartTime?: null | string;
                traceId?: null | string;
                type?: null | string;
                userId?: null | string;
                version?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: ({
                            calculatedInputCost?: null | number;
                            calculatedOutputCost?: null | number;
                            calculatedTotalCost?: null | number;
                            inputPrice?: null | number;
                            latency?: null | number;
                            modelId?: null | string;
                            outputPrice?: null | number;
                            promptName?: null | string;
                            promptVersion?: null | number;
                            timeToFirstToken?: null | number;
                            totalPrice?: null | number;
                        } & {
                            completionStartTime?: null | string;
                            costDetails?: null | {
                                [key: ...]: ...;
                            };
                            endTime?: null | string;
                            id: string;
                            input?: unknown;
                            level:
                                | "DEBUG"
                                | "DEFAULT"
                                | "WARNING"
                                | "ERROR";
                            metadata?: unknown;
                            model?: null | string;
                            modelParameters?: null | {
                                [key: ...]: ...;
                            };
                            name?: null | string;
                            output?: unknown;
                            parentObservationId?: null | string;
                            promptId?: null | string;
                            startTime: string;
                            statusMessage?: null | string;
                            traceId?: null | string;
                            type: string;
                            usage?: {
                                input?: ...;
                                inputCost?: ...;
                                output?: ...;
                                outputCost?: ...;
                                total?: ...;
                                totalCost?: ...;
                                unit?: ...;
                            };
                            usageDetails?: null | {
                                [key: ...]: ...;
                            };
                            version?: null | string;
                        })[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a list of observations

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              fromStartTime?: null | string;
              limit?: null | number;
              name?: null | string;
              page?: null | number;
              parentObservationId?: null | string;
              toStartTime?: null | string;
              traceId?: null | string;
              type?: null | string;
              userId?: null | string;
              version?: null | string;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: {
            fromStartTime?: null | string;
            limit?: null | number;
            name?: null | string;
            page?: null | number;
            parentObservationId?: null | string;
            toStartTime?: null | string;
            traceId?: null | string;
            type?: null | string;
            userId?: null | string;
            version?: null | string;
        }
        • OptionalfromStartTime?: null | string

          Retrieve only observations with a start_time or or after this datetime (ISO 8601).

        • Optionallimit?: null | number

          Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit.

        • Optionalname?: null | string
        • Optionalpage?: null | number

          Page number, starts at 1.

        • OptionalparentObservationId?: null | string
        • OptionaltoStartTime?: null | string

          Retrieve only observations with a start_time before this datetime (ISO 8601).

        • OptionaltraceId?: null | string
        • Optionaltype?: null | string
        • OptionaluserId?: null | string
        • Optionalversion?: null | string

          Optional filter to only include observations with a certain version.

    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      data: ({
                          calculatedInputCost?: null | number;
                          calculatedOutputCost?: null | number;
                          calculatedTotalCost?: null | number;
                          inputPrice?: null | number;
                          latency?: null | number;
                          modelId?: null | string;
                          outputPrice?: null | number;
                          promptName?: null | string;
                          promptVersion?: null | number;
                          timeToFirstToken?: null | number;
                          totalPrice?: null | number;
                      } & {
                          completionStartTime?: null | string;
                          costDetails?: null | {
                              [key: ...]: ...;
                          };
                          endTime?: null | string;
                          id: string;
                          input?: unknown;
                          level:
                              | "DEBUG"
                              | "DEFAULT"
                              | "WARNING"
                              | "ERROR";
                          metadata?: unknown;
                          model?: null | string;
                          modelParameters?: null | {
                              [key: ...]: ...;
                          };
                          name?: null | string;
                          output?: unknown;
                          parentObservationId?: null | string;
                          promptId?: null | string;
                          startTime: string;
                          statusMessage?: null | string;
                          traceId?: null | string;
                          type: string;
                          usage?: {
                              input?: ...;
                              inputCost?: ...;
                              output?: ...;
                              outputCost?: ...;
                              total?: ...;
                              totalCost?: ...;
                              unit?: ...;
                          };
                          usageDetails?: null | {
                              [key: ...]: ...;
                          };
                          version?: null | string;
                      })[];
                      meta: {
                          limit: number;
                          page: number;
                          totalItems: number;
                          totalPages: number;
                      };
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    data: ({
                        calculatedInputCost?: null | number;
                        calculatedOutputCost?: null | number;
                        calculatedTotalCost?: null | number;
                        inputPrice?: null | number;
                        latency?: null | number;
                        modelId?: null | string;
                        outputPrice?: null | number;
                        promptName?: null | string;
                        promptVersion?: null | number;
                        timeToFirstToken?: null | number;
                        totalPrice?: null | number;
                    } & {
                        completionStartTime?: null | string;
                        costDetails?: null | {
                            [key: ...]: ...;
                        };
                        endTime?: null | string;
                        id: string;
                        input?: unknown;
                        level:
                            | "DEBUG"
                            | "DEFAULT"
                            | "WARNING"
                            | "ERROR";
                        metadata?: unknown;
                        model?: null | string;
                        modelParameters?: null | {
                            [key: ...]: ...;
                        };
                        name?: null | string;
                        output?: unknown;
                        parentObservationId?: null | string;
                        promptId?: null | string;
                        startTime: string;
                        statusMessage?: null | string;
                        traceId?: null | string;
                        type: string;
                        usage?: {
                            input?: ...;
                            inputCost?: ...;
                            output?: ...;
                            outputCost?: ...;
                            total?: ...;
                            totalCost?: ...;
                            unit?: ...;
                        };
                        usageDetails?: null | {
                            [key: ...]: ...;
                        };
                        version?: null | string;
                    })[];
                    meta: {
                        limit: number;
                        page: number;
                        totalItems: number;
                        totalPages: number;
                    };
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  data: ({
                      calculatedInputCost?: null | number;
                      calculatedOutputCost?: null | number;
                      calculatedTotalCost?: null | number;
                      inputPrice?: null | number;
                      latency?: null | number;
                      modelId?: null | string;
                      outputPrice?: null | number;
                      promptName?: null | string;
                      promptVersion?: null | number;
                      timeToFirstToken?: null | number;
                      totalPrice?: null | number;
                  } & {
                      completionStartTime?: null | string;
                      costDetails?: null | {
                          [key: ...]: ...;
                      };
                      endTime?: null | string;
                      id: string;
                      input?: unknown;
                      level:
                          | "DEBUG"
                          | "DEFAULT"
                          | "WARNING"
                          | "ERROR";
                      metadata?: unknown;
                      model?: null | string;
                      modelParameters?: null | {
                          [key: ...]: ...;
                      };
                      name?: null | string;
                      output?: unknown;
                      parentObservationId?: null | string;
                      promptId?: null | string;
                      startTime: string;
                      statusMessage?: null | string;
                      traceId?: null | string;
                      type: string;
                      usage?: {
                          input?: ...;
                          inputCost?: ...;
                          output?: ...;
                          outputCost?: ...;
                          total?: ...;
                          totalCost?: ...;
                          unit?: ...;
                      };
                      usageDetails?: null | {
                          [key: ...]: ...;
                      };
                      version?: null | string;
                  })[];
                  meta: {
                      limit: number;
                      page: number;
                      totalItems: number;
                      totalPages: number;
                  };
              };
          }
          • application/json: {
                data: ({
                    calculatedInputCost?: null | number;
                    calculatedOutputCost?: null | number;
                    calculatedTotalCost?: null | number;
                    inputPrice?: null | number;
                    latency?: null | number;
                    modelId?: null | string;
                    outputPrice?: null | number;
                    promptName?: null | string;
                    promptVersion?: null | number;
                    timeToFirstToken?: null | number;
                    totalPrice?: null | number;
                } & {
                    completionStartTime?: null | string;
                    costDetails?: null | {
                        [key: ...]: ...;
                    };
                    endTime?: null | string;
                    id: string;
                    input?: unknown;
                    level:
                        | "DEBUG"
                        | "DEFAULT"
                        | "WARNING"
                        | "ERROR";
                    metadata?: unknown;
                    model?: null | string;
                    modelParameters?: null | {
                        [key: ...]: ...;
                    };
                    name?: null | string;
                    output?: unknown;
                    parentObservationId?: null | string;
                    promptId?: null | string;
                    startTime: string;
                    statusMessage?: null | string;
                    traceId?: null | string;
                    type: string;
                    usage?: {
                        input?: ...;
                        inputCost?: ...;
                        output?: ...;
                        outputCost?: ...;
                        total?: ...;
                        totalCost?: ...;
                        unit?: ...;
                    };
                    usageDetails?: null | {
                        [key: ...]: ...;
                    };
                    version?: null | string;
                })[];
                meta: {
                    limit: number;
                    page: number;
                    totalItems: number;
                    totalPages: number;
                };
            }
            • data: ({
                  calculatedInputCost?: null | number;
                  calculatedOutputCost?: null | number;
                  calculatedTotalCost?: null | number;
                  inputPrice?: null | number;
                  latency?: null | number;
                  modelId?: null | string;
                  outputPrice?: null | number;
                  promptName?: null | string;
                  promptVersion?: null | number;
                  timeToFirstToken?: null | number;
                  totalPrice?: null | number;
              } & {
                  completionStartTime?: null | string;
                  costDetails?: null | {
                      [key: ...]: ...;
                  };
                  endTime?: null | string;
                  id: string;
                  input?: unknown;
                  level:
                      | "DEBUG"
                      | "DEFAULT"
                      | "WARNING"
                      | "ERROR";
                  metadata?: unknown;
                  model?: null | string;
                  modelParameters?: null | {
                      [key: ...]: ...;
                  };
                  name?: null | string;
                  output?: unknown;
                  parentObservationId?: null | string;
                  promptId?: null | string;
                  startTime: string;
                  statusMessage?: null | string;
                  traceId?: null | string;
                  type: string;
                  usage?: {
                      input?: ...;
                      inputCost?: ...;
                      output?: ...;
                      outputCost?: ...;
                      total?: ...;
                      totalCost?: ...;
                      unit?: ...;
                  };
                  usageDetails?: null | {
                      [key: ...]: ...;
                  };
                  version?: null | string;
              })[]
            • meta: {
                  limit: number;
                  page: number;
                  totalItems: number;
                  totalPages: number;
              }
              • limit: number

                number of items per page

              • page: number

                current page number

              • totalItems: number

                number of total items given the current filters/selection (if any)

              • totalPages: number

                number of total pages given the current limit

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/observations/{observationId}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                observationId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        calculatedInputCost?: null | number;
                        calculatedOutputCost?: null | number;
                        calculatedTotalCost?: null | number;
                        inputPrice?: null | number;
                        latency?: null | number;
                        modelId?: null | string;
                        outputPrice?: null | number;
                        promptName?: null | string;
                        promptVersion?: null | number;
                        timeToFirstToken?: null | number;
                        totalPrice?: null | number;
                    } & {
                        completionStartTime?: null | string;
                        costDetails?: null | {
                            [key: string]: number;
                        };
                        endTime?: null | string;
                        id: string;
                        input?: unknown;
                        level:
                            | "DEBUG"
                            | "DEFAULT"
                            | "WARNING"
                            | "ERROR";
                        metadata?: unknown;
                        model?: null | string;
                        modelParameters?: null | {
                            [key: string]: (...)[(...)]["MapValue"];
                        };
                        name?: null | string;
                        output?: unknown;
                        parentObservationId?: null | string;
                        promptId?: null | string;
                        startTime: string;
                        statusMessage?: null | string;
                        traceId?: null | string;
                        type: string;
                        usage?: {
                            input?: null | number;
                            inputCost?: null | number;
                            output?: null | number;
                            outputCost?: null | number;
                            total?: null | number;
                            totalCost?: null | number;
                            unit?:
                                | "CHARACTERS"
                                | "TOKENS"
                                | "MILLISECONDS"
                                | "SECONDS"
                                | "IMAGES"
                                | "REQUESTS";
                        };
                        usageDetails?: null | {
                            [key: string]: number;
                        };
                        version?: null | string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                observationId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        calculatedInputCost?: null | number;
                        calculatedOutputCost?: null | number;
                        calculatedTotalCost?: null | number;
                        inputPrice?: null | number;
                        latency?: null | number;
                        modelId?: null | string;
                        outputPrice?: null | number;
                        promptName?: null | string;
                        promptVersion?: null | number;
                        timeToFirstToken?: null | number;
                        totalPrice?: null | number;
                    } & {
                        completionStartTime?: null | string;
                        costDetails?: null | {
                            [key: string]: number;
                        };
                        endTime?: null | string;
                        id: string;
                        input?: unknown;
                        level:
                            | "DEBUG"
                            | "DEFAULT"
                            | "WARNING"
                            | "ERROR";
                        metadata?: unknown;
                        model?: null | string;
                        modelParameters?: null | {
                            [key: string]: (...)[(...)]["MapValue"];
                        };
                        name?: null | string;
                        output?: unknown;
                        parentObservationId?: null | string;
                        promptId?: null | string;
                        startTime: string;
                        statusMessage?: null | string;
                        traceId?: null | string;
                        type: string;
                        usage?: {
                            input?: null | number;
                            inputCost?: null | number;
                            output?: null | number;
                            outputCost?: null | number;
                            total?: null | number;
                            totalCost?: null | number;
                            unit?:
                                | "CHARACTERS"
                                | "TOKENS"
                                | "MILLISECONDS"
                                | "SECONDS"
                                | "IMAGES"
                                | "REQUESTS";
                        };
                        usageDetails?: null | {
                            [key: string]: number;
                        };
                        version?: null | string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a observation

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              observationId: string;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            observationId: string;
        }
        • observationId: string

          The unique langfuse identifier of an observation, can be an event, span or generation

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      calculatedInputCost?: null | number;
                      calculatedOutputCost?: null | number;
                      calculatedTotalCost?: null | number;
                      inputPrice?: null | number;
                      latency?: null | number;
                      modelId?: null | string;
                      outputPrice?: null | number;
                      promptName?: null | string;
                      promptVersion?: null | number;
                      timeToFirstToken?: null | number;
                      totalPrice?: null | number;
                  } & {
                      completionStartTime?: null | string;
                      costDetails?: null | {
                          [key: string]: number;
                      };
                      endTime?: null | string;
                      id: string;
                      input?: unknown;
                      level:
                          | "DEBUG"
                          | "DEFAULT"
                          | "WARNING"
                          | "ERROR";
                      metadata?: unknown;
                      model?: null | string;
                      modelParameters?: null | {
                          [key: string]: (...)[(...)]["MapValue"];
                      };
                      name?: null | string;
                      output?: unknown;
                      parentObservationId?: null | string;
                      promptId?: null | string;
                      startTime: string;
                      statusMessage?: null | string;
                      traceId?: null | string;
                      type: string;
                      usage?: {
                          input?: null | number;
                          inputCost?: null | number;
                          output?: null | number;
                          outputCost?: null | number;
                          total?: null | number;
                          totalCost?: null | number;
                          unit?:
                              | "CHARACTERS"
                              | "TOKENS"
                              | "MILLISECONDS"
                              | "SECONDS"
                              | "IMAGES"
                              | "REQUESTS";
                      };
                      usageDetails?: null | {
                          [key: string]: number;
                      };
                      version?: null | string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    calculatedInputCost?: null | number;
                    calculatedOutputCost?: null | number;
                    calculatedTotalCost?: null | number;
                    inputPrice?: null | number;
                    latency?: null | number;
                    modelId?: null | string;
                    outputPrice?: null | number;
                    promptName?: null | string;
                    promptVersion?: null | number;
                    timeToFirstToken?: null | number;
                    totalPrice?: null | number;
                } & {
                    completionStartTime?: null | string;
                    costDetails?: null | {
                        [key: string]: number;
                    };
                    endTime?: null | string;
                    id: string;
                    input?: unknown;
                    level:
                        | "DEBUG"
                        | "DEFAULT"
                        | "WARNING"
                        | "ERROR";
                    metadata?: unknown;
                    model?: null | string;
                    modelParameters?: null | {
                        [key: string]: (...)[(...)]["MapValue"];
                    };
                    name?: null | string;
                    output?: unknown;
                    parentObservationId?: null | string;
                    promptId?: null | string;
                    startTime: string;
                    statusMessage?: null | string;
                    traceId?: null | string;
                    type: string;
                    usage?: {
                        input?: null | number;
                        inputCost?: null | number;
                        output?: null | number;
                        outputCost?: null | number;
                        total?: null | number;
                        totalCost?: null | number;
                        unit?:
                            | "CHARACTERS"
                            | "TOKENS"
                            | "MILLISECONDS"
                            | "SECONDS"
                            | "IMAGES"
                            | "REQUESTS";
                    };
                    usageDetails?: null | {
                        [key: string]: number;
                    };
                    version?: null | string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  calculatedInputCost?: null | number;
                  calculatedOutputCost?: null | number;
                  calculatedTotalCost?: null | number;
                  inputPrice?: null | number;
                  latency?: null | number;
                  modelId?: null | string;
                  outputPrice?: null | number;
                  promptName?: null | string;
                  promptVersion?: null | number;
                  timeToFirstToken?: null | number;
                  totalPrice?: null | number;
              } & {
                  completionStartTime?: null | string;
                  costDetails?: null | {
                      [key: string]: number;
                  };
                  endTime?: null | string;
                  id: string;
                  input?: unknown;
                  level:
                      | "DEBUG"
                      | "DEFAULT"
                      | "WARNING"
                      | "ERROR";
                  metadata?: unknown;
                  model?: null | string;
                  modelParameters?: null | {
                      [key: string]: (...)[(...)]["MapValue"];
                  };
                  name?: null | string;
                  output?: unknown;
                  parentObservationId?: null | string;
                  promptId?: null | string;
                  startTime: string;
                  statusMessage?: null | string;
                  traceId?: null | string;
                  type: string;
                  usage?: {
                      input?: null | number;
                      inputCost?: null | number;
                      output?: null | number;
                      outputCost?: null | number;
                      total?: null | number;
                      totalCost?: null | number;
                      unit?:
                          | "CHARACTERS"
                          | "TOKENS"
                          | "MILLISECONDS"
                          | "SECONDS"
                          | "IMAGES"
                          | "REQUESTS";
                  };
                  usageDetails?: null | {
                      [key: string]: number;
                  };
                  version?: null | string;
              };
          }
          • application/json: {
                calculatedInputCost?: null | number;
                calculatedOutputCost?: null | number;
                calculatedTotalCost?: null | number;
                inputPrice?: null | number;
                latency?: null | number;
                modelId?: null | string;
                outputPrice?: null | number;
                promptName?: null | string;
                promptVersion?: null | number;
                timeToFirstToken?: null | number;
                totalPrice?: null | number;
            } & {
                completionStartTime?: null | string;
                costDetails?: null | {
                    [key: string]: number;
                };
                endTime?: null | string;
                id: string;
                input?: unknown;
                level:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                model?: null | string;
                modelParameters?: null | {
                    [key: string]: (...)[(...)]["MapValue"];
                };
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                promptId?: null | string;
                startTime: string;
                statusMessage?: null | string;
                traceId?: null | string;
                type: string;
                usage?: {
                    input?: null | number;
                    inputCost?: null | number;
                    output?: null | number;
                    outputCost?: null | number;
                    total?: null | number;
                    totalCost?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                };
                usageDetails?: null | {
                    [key: string]: number;
                };
                version?: null | string;
            }
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/projects: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            id: string;
                            name: string;
                        }[];
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            id: string;
                            name: string;
                        }[];
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get Project associated with API key

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      data: {
                          id: string;
                          name: string;
                      }[];
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    data: {
                        id: string;
                        name: string;
                    }[];
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  data: {
                      id: string;
                      name: string;
                  }[];
              };
          }
          • application/json: {
                data: {
                    id: string;
                    name: string;
                }[];
            }
            • data: {
                  id: string;
                  name: string;
              }[]
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/score-configs: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                limit?: null | number;
                page?: null | number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            categories?: null | {
                                label: ...;
                                value: ...;
                            }[];
                            createdAt: string;
                            dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                            description?: null | string;
                            id: string;
                            isArchived: boolean;
                            maxValue?: null | number;
                            minValue?: null | number;
                            name: string;
                            projectId: string;
                            updatedAt: string;
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    categories?: null | {
                        label: string;
                        value: number;
                    }[];
                    dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                    description?: null | string;
                    maxValue?: null | number;
                    minValue?: null | number;
                    name: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        categories?: null | {
                            label: string;
                            value: number;
                        }[];
                        createdAt: string;
                        dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                        description?: null | string;
                        id: string;
                        isArchived: boolean;
                        maxValue?: null | number;
                        minValue?: null | number;
                        name: string;
                        projectId: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                limit?: null | number;
                page?: null | number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            categories?: null | {
                                label: ...;
                                value: ...;
                            }[];
                            createdAt: string;
                            dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                            description?: null | string;
                            id: string;
                            isArchived: boolean;
                            maxValue?: null | number;
                            minValue?: null | number;
                            name: string;
                            projectId: string;
                            updatedAt: string;
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get all score configs

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              limit?: null | number;
              page?: null | number;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: {
            limit?: null | number;
            page?: null | number;
        }
        • Optionallimit?: null | number

          Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit

        • Optionalpage?: null | number

          Page number, starts at 1.

    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      data: {
                          categories?: null | {
                              label: ...;
                              value: ...;
                          }[];
                          createdAt: string;
                          dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                          description?: null | string;
                          id: string;
                          isArchived: boolean;
                          maxValue?: null | number;
                          minValue?: null | number;
                          name: string;
                          projectId: string;
                          updatedAt: string;
                      }[];
                      meta: {
                          limit: number;
                          page: number;
                          totalItems: number;
                          totalPages: number;
                      };
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    data: {
                        categories?: null | {
                            label: ...;
                            value: ...;
                        }[];
                        createdAt: string;
                        dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                        description?: null | string;
                        id: string;
                        isArchived: boolean;
                        maxValue?: null | number;
                        minValue?: null | number;
                        name: string;
                        projectId: string;
                        updatedAt: string;
                    }[];
                    meta: {
                        limit: number;
                        page: number;
                        totalItems: number;
                        totalPages: number;
                    };
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  data: {
                      categories?: null | {
                          label: ...;
                          value: ...;
                      }[];
                      createdAt: string;
                      dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                      description?: null | string;
                      id: string;
                      isArchived: boolean;
                      maxValue?: null | number;
                      minValue?: null | number;
                      name: string;
                      projectId: string;
                      updatedAt: string;
                  }[];
                  meta: {
                      limit: number;
                      page: number;
                      totalItems: number;
                      totalPages: number;
                  };
              };
          }
          • application/json: {
                data: {
                    categories?: null | {
                        label: ...;
                        value: ...;
                    }[];
                    createdAt: string;
                    dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                    description?: null | string;
                    id: string;
                    isArchived: boolean;
                    maxValue?: null | number;
                    minValue?: null | number;
                    name: string;
                    projectId: string;
                    updatedAt: string;
                }[];
                meta: {
                    limit: number;
                    page: number;
                    totalItems: number;
                    totalPages: number;
                };
            }
            • data: {
                  categories?: null | {
                      label: ...;
                      value: ...;
                  }[];
                  createdAt: string;
                  dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                  description?: null | string;
                  id: string;
                  isArchived: boolean;
                  maxValue?: null | number;
                  minValue?: null | number;
                  name: string;
                  projectId: string;
                  updatedAt: string;
              }[]
            • meta: {
                  limit: number;
                  page: number;
                  totalItems: number;
                  totalPages: number;
              }
              • limit: number

                number of items per page

              • page: number

                current page number

              • totalItems: number

                number of total items given the current filters/selection (if any)

              • totalPages: number

                number of total pages given the current limit

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    categories?: null | {
                        label: string;
                        value: number;
                    }[];
                    dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                    description?: null | string;
                    maxValue?: null | number;
                    minValue?: null | number;
                    name: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        categories?: null | {
                            label: string;
                            value: number;
                        }[];
                        createdAt: string;
                        dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                        description?: null | string;
                        id: string;
                        isArchived: boolean;
                        maxValue?: null | number;
                        minValue?: null | number;
                        name: string;
                        projectId: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Create a score configuration (config). Score configs are used to define the structure of scores

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: undefined
    • requestBody: {
          content: {
              application/json: {
                  categories?: null | {
                      label: string;
                      value: number;
                  }[];
                  dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                  description?: null | string;
                  maxValue?: null | number;
                  minValue?: null | number;
                  name: string;
              };
          };
      }
      • content: {
            application/json: {
                categories?: null | {
                    label: string;
                    value: number;
                }[];
                dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                description?: null | string;
                maxValue?: null | number;
                minValue?: null | number;
                name: string;
            };
        }
        • application/json: {
              categories?: null | {
                  label: string;
                  value: number;
              }[];
              dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
              description?: null | string;
              maxValue?: null | number;
              minValue?: null | number;
              name: string;
          }
          • Optionalcategories?: null | {
                label: string;
                value: number;
            }[]

            Configure custom categories for categorical scores. Pass a list of objects with label and value properties. Categories are autogenerated for boolean configs and cannot be passed

          • dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL"
          • Optionaldescription?: null | string

            Description is shown across the Langfuse UI and can be used to e.g. explain the config categories in detail, why a numeric range was set, or provide additional context on config name or usage

          • OptionalmaxValue?: null | number

            Format: double

            Configure a maximum value for numerical scores. If not set, the maximum value defaults to +∞

          • OptionalminValue?: null | number

            Format: double

            Configure a minimum value for numerical scores. If not set, the minimum value defaults to -∞

          • name: string
    • responses: {
          200: {
              content: {
                  application/json: {
                      categories?: null | {
                          label: string;
                          value: number;
                      }[];
                      createdAt: string;
                      dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                      description?: null | string;
                      id: string;
                      isArchived: boolean;
                      maxValue?: null | number;
                      minValue?: null | number;
                      name: string;
                      projectId: string;
                      updatedAt: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    categories?: null | {
                        label: string;
                        value: number;
                    }[];
                    createdAt: string;
                    dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                    description?: null | string;
                    id: string;
                    isArchived: boolean;
                    maxValue?: null | number;
                    minValue?: null | number;
                    name: string;
                    projectId: string;
                    updatedAt: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  categories?: null | {
                      label: string;
                      value: number;
                  }[];
                  createdAt: string;
                  dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                  description?: null | string;
                  id: string;
                  isArchived: boolean;
                  maxValue?: null | number;
                  minValue?: null | number;
                  name: string;
                  projectId: string;
                  updatedAt: string;
              };
          }
          • application/json: {
                categories?: null | {
                    label: string;
                    value: number;
                }[];
                createdAt: string;
                dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                description?: null | string;
                id: string;
                isArchived: boolean;
                maxValue?: null | number;
                minValue?: null | number;
                name: string;
                projectId: string;
                updatedAt: string;
            }
            • Optionalcategories?: null | {
                  label: string;
                  value: number;
              }[]

              Configures custom categories for categorical scores

            • createdAt: string

              Format: date-time

            • dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL"
            • Optionaldescription?: null | string
            • id: string
            • isArchived: boolean

              Whether the score config is archived. Defaults to false

            • OptionalmaxValue?: null | number

              Format: double

              Sets maximum value for numerical scores. If not set, the maximum value defaults to +∞

            • OptionalminValue?: null | number

              Format: double

              Sets minimum value for numerical scores. If not set, the minimum value defaults to -∞

            • name: string
            • projectId: string
            • updatedAt: string

              Format: date-time

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/score-configs/{configId}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                configId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        categories?: null | {
                            label: string;
                            value: number;
                        }[];
                        createdAt: string;
                        dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                        description?: null | string;
                        id: string;
                        isArchived: boolean;
                        maxValue?: null | number;
                        minValue?: null | number;
                        name: string;
                        projectId: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                configId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        categories?: null | {
                            label: string;
                            value: number;
                        }[];
                        createdAt: string;
                        dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                        description?: null | string;
                        id: string;
                        isArchived: boolean;
                        maxValue?: null | number;
                        minValue?: null | number;
                        name: string;
                        projectId: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a score config

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              configId: string;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            configId: string;
        }
        • configId: string

          The unique langfuse identifier of a score config

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      categories?: null | {
                          label: string;
                          value: number;
                      }[];
                      createdAt: string;
                      dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                      description?: null | string;
                      id: string;
                      isArchived: boolean;
                      maxValue?: null | number;
                      minValue?: null | number;
                      name: string;
                      projectId: string;
                      updatedAt: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    categories?: null | {
                        label: string;
                        value: number;
                    }[];
                    createdAt: string;
                    dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                    description?: null | string;
                    id: string;
                    isArchived: boolean;
                    maxValue?: null | number;
                    minValue?: null | number;
                    name: string;
                    projectId: string;
                    updatedAt: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  categories?: null | {
                      label: string;
                      value: number;
                  }[];
                  createdAt: string;
                  dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                  description?: null | string;
                  id: string;
                  isArchived: boolean;
                  maxValue?: null | number;
                  minValue?: null | number;
                  name: string;
                  projectId: string;
                  updatedAt: string;
              };
          }
          • application/json: {
                categories?: null | {
                    label: string;
                    value: number;
                }[];
                createdAt: string;
                dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                description?: null | string;
                id: string;
                isArchived: boolean;
                maxValue?: null | number;
                minValue?: null | number;
                name: string;
                projectId: string;
                updatedAt: string;
            }
            • Optionalcategories?: null | {
                  label: string;
                  value: number;
              }[]

              Configures custom categories for categorical scores

            • createdAt: string

              Format: date-time

            • dataType: "NUMERIC" | "BOOLEAN" | "CATEGORICAL"
            • Optionaldescription?: null | string
            • id: string
            • isArchived: boolean

              Whether the score config is archived. Defaults to false

            • OptionalmaxValue?: null | number

              Format: double

              Sets maximum value for numerical scores. If not set, the maximum value defaults to +∞

            • OptionalminValue?: null | number

              Format: double

              Sets minimum value for numerical scores. If not set, the minimum value defaults to -∞

            • name: string
            • projectId: string
            • updatedAt: string

              Format: date-time

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/scores: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                configId?: null | string;
                dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                fromTimestamp?: null | string;
                limit?: null | number;
                name?: null | string;
                operator?: null | string;
                page?: null | number;
                queueId?: null | string;
                scoreIds?: null | string;
                source?: "ANNOTATION" | "API" | "EVAL";
                toTimestamp?: null | string;
                traceTags?: (null | string)[];
                userId?: null | string;
                value?: null | number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: ({
                            dataType: "NUMERIC";
                        } & {
                            trace: {
                                tags?: ...;
                                userId?: ...;
                            };
                        } & {
                            value: number;
                        } & {
                            authorUserId?: (...) | (...) | (...);
                            comment?: (...) | (...) | (...);
                            configId?: (...) | (...) | (...);
                            createdAt: string;
                            id: string;
                            name: string;
                            observationId?: (...) | (...) | (...);
                            queueId?: (...) | (...) | (...);
                            source: (...) | (...) | (...);
                            timestamp: string;
                            traceId: string;
                            updatedAt: string;
                        } | {
                            dataType: "CATEGORICAL";
                        } & {
                            trace: {
                                tags?: ...;
                                userId?: ...;
                            };
                        } & {
                            stringValue: string;
                            value?: (...) | (...) | (...);
                        } & {
                            authorUserId?: (...) | (...) | (...);
                            comment?: (...) | (...) | (...);
                            configId?: (...) | (...) | (...);
                            createdAt: string;
                            id: string;
                            name: string;
                            observationId?: (...) | (...) | (...);
                            queueId?: (...) | (...) | (...);
                            source: (...) | (...) | (...);
                            timestamp: string;
                            traceId: string;
                            updatedAt: string;
                        } | {
                            dataType: "BOOLEAN";
                        } & {
                            trace: {
                                tags?: ...;
                                userId?: ...;
                            };
                        } & {
                            stringValue: string;
                            value: number;
                        } & {
                            authorUserId?: (...) | (...) | (...);
                            comment?: (...) | (...) | (...);
                            configId?: (...) | (...) | (...);
                            createdAt: string;
                            id: string;
                            name: string;
                            observationId?: (...) | (...) | (...);
                            queueId?: (...) | (...) | (...);
                            source: (...) | (...) | (...);
                            timestamp: string;
                            traceId: string;
                            updatedAt: string;
                        })[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    comment?: null | string;
                    configId?: null | string;
                    dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                    id?: null | string;
                    name: string;
                    observationId?: null | string;
                    traceId: string;
                    value: string | number;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        id: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                configId?: null | string;
                dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                fromTimestamp?: null | string;
                limit?: null | number;
                name?: null | string;
                operator?: null | string;
                page?: null | number;
                queueId?: null | string;
                scoreIds?: null | string;
                source?: "ANNOTATION" | "API" | "EVAL";
                toTimestamp?: null | string;
                traceTags?: (null | string)[];
                userId?: null | string;
                value?: null | number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: ({
                            dataType: "NUMERIC";
                        } & {
                            trace: {
                                tags?: ...;
                                userId?: ...;
                            };
                        } & {
                            value: number;
                        } & {
                            authorUserId?: (...) | (...) | (...);
                            comment?: (...) | (...) | (...);
                            configId?: (...) | (...) | (...);
                            createdAt: string;
                            id: string;
                            name: string;
                            observationId?: (...) | (...) | (...);
                            queueId?: (...) | (...) | (...);
                            source: (...) | (...) | (...);
                            timestamp: string;
                            traceId: string;
                            updatedAt: string;
                        } | {
                            dataType: "CATEGORICAL";
                        } & {
                            trace: {
                                tags?: ...;
                                userId?: ...;
                            };
                        } & {
                            stringValue: string;
                            value?: (...) | (...) | (...);
                        } & {
                            authorUserId?: (...) | (...) | (...);
                            comment?: (...) | (...) | (...);
                            configId?: (...) | (...) | (...);
                            createdAt: string;
                            id: string;
                            name: string;
                            observationId?: (...) | (...) | (...);
                            queueId?: (...) | (...) | (...);
                            source: (...) | (...) | (...);
                            timestamp: string;
                            traceId: string;
                            updatedAt: string;
                        } | {
                            dataType: "BOOLEAN";
                        } & {
                            trace: {
                                tags?: ...;
                                userId?: ...;
                            };
                        } & {
                            stringValue: string;
                            value: number;
                        } & {
                            authorUserId?: (...) | (...) | (...);
                            comment?: (...) | (...) | (...);
                            configId?: (...) | (...) | (...);
                            createdAt: string;
                            id: string;
                            name: string;
                            observationId?: (...) | (...) | (...);
                            queueId?: (...) | (...) | (...);
                            source: (...) | (...) | (...);
                            timestamp: string;
                            traceId: string;
                            updatedAt: string;
                        })[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a list of scores

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              configId?: null | string;
              dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
              fromTimestamp?: null | string;
              limit?: null | number;
              name?: null | string;
              operator?: null | string;
              page?: null | number;
              queueId?: null | string;
              scoreIds?: null | string;
              source?: "ANNOTATION" | "API" | "EVAL";
              toTimestamp?: null | string;
              traceTags?: (null | string)[];
              userId?: null | string;
              value?: null | number;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: {
            configId?: null | string;
            dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
            fromTimestamp?: null | string;
            limit?: null | number;
            name?: null | string;
            operator?: null | string;
            page?: null | number;
            queueId?: null | string;
            scoreIds?: null | string;
            source?: "ANNOTATION" | "API" | "EVAL";
            toTimestamp?: null | string;
            traceTags?: (null | string)[];
            userId?: null | string;
            value?: null | number;
        }
        • OptionalconfigId?: null | string

          Retrieve only scores with a specific configId.

        • OptionaldataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL"

          Retrieve only scores with a specific dataType.

        • OptionalfromTimestamp?: null | string

          Optional filter to only include scores created on or after a certain datetime (ISO 8601)

        • Optionallimit?: null | number

          Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit.

        • Optionalname?: null | string

          Retrieve only scores with this name.

        • Optionaloperator?: null | string

          Retrieve only scores with value.

        • Optionalpage?: null | number

          Page number, starts at 1.

        • OptionalqueueId?: null | string

          Retrieve only scores with a specific annotation queueId.

        • OptionalscoreIds?: null | string

          Comma-separated list of score IDs to limit the results to.

        • Optionalsource?: "ANNOTATION" | "API" | "EVAL"

          Retrieve only scores from a specific source.

        • OptionaltoTimestamp?: null | string

          Optional filter to only include scores created before a certain datetime (ISO 8601)

        • OptionaltraceTags?: (null | string)[]

          Only scores linked to traces that include all of these tags will be returned.

        • OptionaluserId?: null | string

          Retrieve only scores with this userId associated to the trace.

        • Optionalvalue?: null | number

          Retrieve only scores with value.

    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      data: ({
                          dataType: "NUMERIC";
                      } & {
                          trace: {
                              tags?: ...;
                              userId?: ...;
                          };
                      } & {
                          value: number;
                      } & {
                          authorUserId?: (...) | (...) | (...);
                          comment?: (...) | (...) | (...);
                          configId?: (...) | (...) | (...);
                          createdAt: string;
                          id: string;
                          name: string;
                          observationId?: (...) | (...) | (...);
                          queueId?: (...) | (...) | (...);
                          source: (...) | (...) | (...);
                          timestamp: string;
                          traceId: string;
                          updatedAt: string;
                      } | {
                          dataType: "CATEGORICAL";
                      } & {
                          trace: {
                              tags?: ...;
                              userId?: ...;
                          };
                      } & {
                          stringValue: string;
                          value?: (...) | (...) | (...);
                      } & {
                          authorUserId?: (...) | (...) | (...);
                          comment?: (...) | (...) | (...);
                          configId?: (...) | (...) | (...);
                          createdAt: string;
                          id: string;
                          name: string;
                          observationId?: (...) | (...) | (...);
                          queueId?: (...) | (...) | (...);
                          source: (...) | (...) | (...);
                          timestamp: string;
                          traceId: string;
                          updatedAt: string;
                      } | {
                          dataType: "BOOLEAN";
                      } & {
                          trace: {
                              tags?: ...;
                              userId?: ...;
                          };
                      } & {
                          stringValue: string;
                          value: number;
                      } & {
                          authorUserId?: (...) | (...) | (...);
                          comment?: (...) | (...) | (...);
                          configId?: (...) | (...) | (...);
                          createdAt: string;
                          id: string;
                          name: string;
                          observationId?: (...) | (...) | (...);
                          queueId?: (...) | (...) | (...);
                          source: (...) | (...) | (...);
                          timestamp: string;
                          traceId: string;
                          updatedAt: string;
                      })[];
                      meta: {
                          limit: number;
                          page: number;
                          totalItems: number;
                          totalPages: number;
                      };
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    data: ({
                        dataType: "NUMERIC";
                    } & {
                        trace: {
                            tags?: ...;
                            userId?: ...;
                        };
                    } & {
                        value: number;
                    } & {
                        authorUserId?: (...) | (...) | (...);
                        comment?: (...) | (...) | (...);
                        configId?: (...) | (...) | (...);
                        createdAt: string;
                        id: string;
                        name: string;
                        observationId?: (...) | (...) | (...);
                        queueId?: (...) | (...) | (...);
                        source: (...) | (...) | (...);
                        timestamp: string;
                        traceId: string;
                        updatedAt: string;
                    } | {
                        dataType: "CATEGORICAL";
                    } & {
                        trace: {
                            tags?: ...;
                            userId?: ...;
                        };
                    } & {
                        stringValue: string;
                        value?: (...) | (...) | (...);
                    } & {
                        authorUserId?: (...) | (...) | (...);
                        comment?: (...) | (...) | (...);
                        configId?: (...) | (...) | (...);
                        createdAt: string;
                        id: string;
                        name: string;
                        observationId?: (...) | (...) | (...);
                        queueId?: (...) | (...) | (...);
                        source: (...) | (...) | (...);
                        timestamp: string;
                        traceId: string;
                        updatedAt: string;
                    } | {
                        dataType: "BOOLEAN";
                    } & {
                        trace: {
                            tags?: ...;
                            userId?: ...;
                        };
                    } & {
                        stringValue: string;
                        value: number;
                    } & {
                        authorUserId?: (...) | (...) | (...);
                        comment?: (...) | (...) | (...);
                        configId?: (...) | (...) | (...);
                        createdAt: string;
                        id: string;
                        name: string;
                        observationId?: (...) | (...) | (...);
                        queueId?: (...) | (...) | (...);
                        source: (...) | (...) | (...);
                        timestamp: string;
                        traceId: string;
                        updatedAt: string;
                    })[];
                    meta: {
                        limit: number;
                        page: number;
                        totalItems: number;
                        totalPages: number;
                    };
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  data: ({
                      dataType: "NUMERIC";
                  } & {
                      trace: {
                          tags?: ...;
                          userId?: ...;
                      };
                  } & {
                      value: number;
                  } & {
                      authorUserId?: (...) | (...) | (...);
                      comment?: (...) | (...) | (...);
                      configId?: (...) | (...) | (...);
                      createdAt: string;
                      id: string;
                      name: string;
                      observationId?: (...) | (...) | (...);
                      queueId?: (...) | (...) | (...);
                      source: (...) | (...) | (...);
                      timestamp: string;
                      traceId: string;
                      updatedAt: string;
                  } | {
                      dataType: "CATEGORICAL";
                  } & {
                      trace: {
                          tags?: ...;
                          userId?: ...;
                      };
                  } & {
                      stringValue: string;
                      value?: (...) | (...) | (...);
                  } & {
                      authorUserId?: (...) | (...) | (...);
                      comment?: (...) | (...) | (...);
                      configId?: (...) | (...) | (...);
                      createdAt: string;
                      id: string;
                      name: string;
                      observationId?: (...) | (...) | (...);
                      queueId?: (...) | (...) | (...);
                      source: (...) | (...) | (...);
                      timestamp: string;
                      traceId: string;
                      updatedAt: string;
                  } | {
                      dataType: "BOOLEAN";
                  } & {
                      trace: {
                          tags?: ...;
                          userId?: ...;
                      };
                  } & {
                      stringValue: string;
                      value: number;
                  } & {
                      authorUserId?: (...) | (...) | (...);
                      comment?: (...) | (...) | (...);
                      configId?: (...) | (...) | (...);
                      createdAt: string;
                      id: string;
                      name: string;
                      observationId?: (...) | (...) | (...);
                      queueId?: (...) | (...) | (...);
                      source: (...) | (...) | (...);
                      timestamp: string;
                      traceId: string;
                      updatedAt: string;
                  })[];
                  meta: {
                      limit: number;
                      page: number;
                      totalItems: number;
                      totalPages: number;
                  };
              };
          }
          • application/json: {
                data: ({
                    dataType: "NUMERIC";
                } & {
                    trace: {
                        tags?: ...;
                        userId?: ...;
                    };
                } & {
                    value: number;
                } & {
                    authorUserId?: (...) | (...) | (...);
                    comment?: (...) | (...) | (...);
                    configId?: (...) | (...) | (...);
                    createdAt: string;
                    id: string;
                    name: string;
                    observationId?: (...) | (...) | (...);
                    queueId?: (...) | (...) | (...);
                    source: (...) | (...) | (...);
                    timestamp: string;
                    traceId: string;
                    updatedAt: string;
                } | {
                    dataType: "CATEGORICAL";
                } & {
                    trace: {
                        tags?: ...;
                        userId?: ...;
                    };
                } & {
                    stringValue: string;
                    value?: (...) | (...) | (...);
                } & {
                    authorUserId?: (...) | (...) | (...);
                    comment?: (...) | (...) | (...);
                    configId?: (...) | (...) | (...);
                    createdAt: string;
                    id: string;
                    name: string;
                    observationId?: (...) | (...) | (...);
                    queueId?: (...) | (...) | (...);
                    source: (...) | (...) | (...);
                    timestamp: string;
                    traceId: string;
                    updatedAt: string;
                } | {
                    dataType: "BOOLEAN";
                } & {
                    trace: {
                        tags?: ...;
                        userId?: ...;
                    };
                } & {
                    stringValue: string;
                    value: number;
                } & {
                    authorUserId?: (...) | (...) | (...);
                    comment?: (...) | (...) | (...);
                    configId?: (...) | (...) | (...);
                    createdAt: string;
                    id: string;
                    name: string;
                    observationId?: (...) | (...) | (...);
                    queueId?: (...) | (...) | (...);
                    source: (...) | (...) | (...);
                    timestamp: string;
                    traceId: string;
                    updatedAt: string;
                })[];
                meta: {
                    limit: number;
                    page: number;
                    totalItems: number;
                    totalPages: number;
                };
            }
            • data: ({
                  dataType: "NUMERIC";
              } & {
                  trace: {
                      tags?: ...;
                      userId?: ...;
                  };
              } & {
                  value: number;
              } & {
                  authorUserId?: (...) | (...) | (...);
                  comment?: (...) | (...) | (...);
                  configId?: (...) | (...) | (...);
                  createdAt: string;
                  id: string;
                  name: string;
                  observationId?: (...) | (...) | (...);
                  queueId?: (...) | (...) | (...);
                  source: (...) | (...) | (...);
                  timestamp: string;
                  traceId: string;
                  updatedAt: string;
              } | {
                  dataType: "CATEGORICAL";
              } & {
                  trace: {
                      tags?: ...;
                      userId?: ...;
                  };
              } & {
                  stringValue: string;
                  value?: (...) | (...) | (...);
              } & {
                  authorUserId?: (...) | (...) | (...);
                  comment?: (...) | (...) | (...);
                  configId?: (...) | (...) | (...);
                  createdAt: string;
                  id: string;
                  name: string;
                  observationId?: (...) | (...) | (...);
                  queueId?: (...) | (...) | (...);
                  source: (...) | (...) | (...);
                  timestamp: string;
                  traceId: string;
                  updatedAt: string;
              } | {
                  dataType: "BOOLEAN";
              } & {
                  trace: {
                      tags?: ...;
                      userId?: ...;
                  };
              } & {
                  stringValue: string;
                  value: number;
              } & {
                  authorUserId?: (...) | (...) | (...);
                  comment?: (...) | (...) | (...);
                  configId?: (...) | (...) | (...);
                  createdAt: string;
                  id: string;
                  name: string;
                  observationId?: (...) | (...) | (...);
                  queueId?: (...) | (...) | (...);
                  source: (...) | (...) | (...);
                  timestamp: string;
                  traceId: string;
                  updatedAt: string;
              })[]
            • meta: {
                  limit: number;
                  page: number;
                  totalItems: number;
                  totalPages: number;
              }
              • limit: number

                number of items per page

              • page: number

                current page number

              • totalItems: number

                number of total items given the current filters/selection (if any)

              • totalPages: number

                number of total pages given the current limit

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    comment?: null | string;
                    configId?: null | string;
                    dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                    id?: null | string;
                    name: string;
                    observationId?: null | string;
                    traceId: string;
                    value: string | number;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        id: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Create a score

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: undefined
    • requestBody: {
          content: {
              application/json: {
                  comment?: null | string;
                  configId?: null | string;
                  dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                  id?: null | string;
                  name: string;
                  observationId?: null | string;
                  traceId: string;
                  value: string | number;
              };
          };
      }
      • content: {
            application/json: {
                comment?: null | string;
                configId?: null | string;
                dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                id?: null | string;
                name: string;
                observationId?: null | string;
                traceId: string;
                value: string | number;
            };
        }
        • application/json: {
              comment?: null | string;
              configId?: null | string;
              dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
              id?: null | string;
              name: string;
              observationId?: null | string;
              traceId: string;
              value: string | number;
          }
          • Optionalcomment?: null | string
          • OptionalconfigId?: null | string

            Reference a score config on a score. The unique langfuse identifier of a score config. When passing this field, the dataType and stringValue fields are automatically populated.

          • OptionaldataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL"

            The data type of the score. When passing a configId this field is inferred. Otherwise, this field must be passed or will default to numeric.

          • Optionalid?: null | string
          • name: string
            novelty
            
          • OptionalobservationId?: null | string
          • traceId: string
            cdef-1234-5678-90ab
            
          • value: string | number

            The value of the score. Must be passed as string for categorical scores, and numeric for boolean and numeric scores. Boolean score values must equal either 1 or 0 (true or false)

    • responses: {
          200: {
              content: {
                  application/json: {
                      id: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    id: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  id: string;
              };
          }
          • application/json: {
                id: string;
            }
            • id: string

              The id of the created object in Langfuse

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/scores/{scoreId}: {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                scoreId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                scoreId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        dataType: "NUMERIC";
                    } & {
                        value: number;
                    } & {
                        authorUserId?: null | string;
                        comment?: null | string;
                        configId?: null | string;
                        createdAt: string;
                        id: string;
                        name: string;
                        observationId?: null | string;
                        queueId?: null | string;
                        source: "ANNOTATION" | "API" | "EVAL";
                        timestamp: string;
                        traceId: string;
                        updatedAt: string;
                    } | {
                        dataType: "CATEGORICAL";
                    } & {
                        stringValue: string;
                        value?: null | number;
                    } & {
                        authorUserId?: null | string;
                        comment?: null | string;
                        configId?: null | string;
                        createdAt: string;
                        id: string;
                        name: string;
                        observationId?: null | string;
                        queueId?: null | string;
                        source: "ANNOTATION" | "API" | "EVAL";
                        timestamp: string;
                        traceId: string;
                        updatedAt: string;
                    } | {
                        dataType: "BOOLEAN";
                    } & {
                        stringValue: string;
                        value: number;
                    } & {
                        authorUserId?: null | string;
                        comment?: null | string;
                        configId?: null | string;
                        createdAt: string;
                        id: string;
                        name: string;
                        observationId?: null | string;
                        queueId?: null | string;
                        source: "ANNOTATION" | "API" | "EVAL";
                        timestamp: string;
                        traceId: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                scoreId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            204: {
                content?: undefined;
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Delete a score

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              scoreId: string;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            scoreId: string;
        }
        • scoreId: string

          The unique langfuse identifier of a score

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          204: {
              content?: undefined;
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 204: {
            content?: undefined;
            headers: {
                [name: string]: unknown;
            };
        }
        • Optionalcontent?: undefined
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                scoreId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        dataType: "NUMERIC";
                    } & {
                        value: number;
                    } & {
                        authorUserId?: null | string;
                        comment?: null | string;
                        configId?: null | string;
                        createdAt: string;
                        id: string;
                        name: string;
                        observationId?: null | string;
                        queueId?: null | string;
                        source: "ANNOTATION" | "API" | "EVAL";
                        timestamp: string;
                        traceId: string;
                        updatedAt: string;
                    } | {
                        dataType: "CATEGORICAL";
                    } & {
                        stringValue: string;
                        value?: null | number;
                    } & {
                        authorUserId?: null | string;
                        comment?: null | string;
                        configId?: null | string;
                        createdAt: string;
                        id: string;
                        name: string;
                        observationId?: null | string;
                        queueId?: null | string;
                        source: "ANNOTATION" | "API" | "EVAL";
                        timestamp: string;
                        traceId: string;
                        updatedAt: string;
                    } | {
                        dataType: "BOOLEAN";
                    } & {
                        stringValue: string;
                        value: number;
                    } & {
                        authorUserId?: null | string;
                        comment?: null | string;
                        configId?: null | string;
                        createdAt: string;
                        id: string;
                        name: string;
                        observationId?: null | string;
                        queueId?: null | string;
                        source: "ANNOTATION" | "API" | "EVAL";
                        timestamp: string;
                        traceId: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a score

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              scoreId: string;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            scoreId: string;
        }
        • scoreId: string

          The unique langfuse identifier of a score

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      dataType: "NUMERIC";
                  } & {
                      value: number;
                  } & {
                      authorUserId?: null | string;
                      comment?: null | string;
                      configId?: null | string;
                      createdAt: string;
                      id: string;
                      name: string;
                      observationId?: null | string;
                      queueId?: null | string;
                      source: "ANNOTATION" | "API" | "EVAL";
                      timestamp: string;
                      traceId: string;
                      updatedAt: string;
                  } | {
                      dataType: "CATEGORICAL";
                  } & {
                      stringValue: string;
                      value?: null | number;
                  } & {
                      authorUserId?: null | string;
                      comment?: null | string;
                      configId?: null | string;
                      createdAt: string;
                      id: string;
                      name: string;
                      observationId?: null | string;
                      queueId?: null | string;
                      source: "ANNOTATION" | "API" | "EVAL";
                      timestamp: string;
                      traceId: string;
                      updatedAt: string;
                  } | {
                      dataType: "BOOLEAN";
                  } & {
                      stringValue: string;
                      value: number;
                  } & {
                      authorUserId?: null | string;
                      comment?: null | string;
                      configId?: null | string;
                      createdAt: string;
                      id: string;
                      name: string;
                      observationId?: null | string;
                      queueId?: null | string;
                      source: "ANNOTATION" | "API" | "EVAL";
                      timestamp: string;
                      traceId: string;
                      updatedAt: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    dataType: "NUMERIC";
                } & {
                    value: number;
                } & {
                    authorUserId?: null | string;
                    comment?: null | string;
                    configId?: null | string;
                    createdAt: string;
                    id: string;
                    name: string;
                    observationId?: null | string;
                    queueId?: null | string;
                    source: "ANNOTATION" | "API" | "EVAL";
                    timestamp: string;
                    traceId: string;
                    updatedAt: string;
                } | {
                    dataType: "CATEGORICAL";
                } & {
                    stringValue: string;
                    value?: null | number;
                } & {
                    authorUserId?: null | string;
                    comment?: null | string;
                    configId?: null | string;
                    createdAt: string;
                    id: string;
                    name: string;
                    observationId?: null | string;
                    queueId?: null | string;
                    source: "ANNOTATION" | "API" | "EVAL";
                    timestamp: string;
                    traceId: string;
                    updatedAt: string;
                } | {
                    dataType: "BOOLEAN";
                } & {
                    stringValue: string;
                    value: number;
                } & {
                    authorUserId?: null | string;
                    comment?: null | string;
                    configId?: null | string;
                    createdAt: string;
                    id: string;
                    name: string;
                    observationId?: null | string;
                    queueId?: null | string;
                    source: "ANNOTATION" | "API" | "EVAL";
                    timestamp: string;
                    traceId: string;
                    updatedAt: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  dataType: "NUMERIC";
              } & {
                  value: number;
              } & {
                  authorUserId?: null | string;
                  comment?: null | string;
                  configId?: null | string;
                  createdAt: string;
                  id: string;
                  name: string;
                  observationId?: null | string;
                  queueId?: null | string;
                  source: "ANNOTATION" | "API" | "EVAL";
                  timestamp: string;
                  traceId: string;
                  updatedAt: string;
              } | {
                  dataType: "CATEGORICAL";
              } & {
                  stringValue: string;
                  value?: null | number;
              } & {
                  authorUserId?: null | string;
                  comment?: null | string;
                  configId?: null | string;
                  createdAt: string;
                  id: string;
                  name: string;
                  observationId?: null | string;
                  queueId?: null | string;
                  source: "ANNOTATION" | "API" | "EVAL";
                  timestamp: string;
                  traceId: string;
                  updatedAt: string;
              } | {
                  dataType: "BOOLEAN";
              } & {
                  stringValue: string;
                  value: number;
              } & {
                  authorUserId?: null | string;
                  comment?: null | string;
                  configId?: null | string;
                  createdAt: string;
                  id: string;
                  name: string;
                  observationId?: null | string;
                  queueId?: null | string;
                  source: "ANNOTATION" | "API" | "EVAL";
                  timestamp: string;
                  traceId: string;
                  updatedAt: string;
              };
          }
          • application/json: {
                dataType: "NUMERIC";
            } & {
                value: number;
            } & {
                authorUserId?: null | string;
                comment?: null | string;
                configId?: null | string;
                createdAt: string;
                id: string;
                name: string;
                observationId?: null | string;
                queueId?: null | string;
                source: "ANNOTATION" | "API" | "EVAL";
                timestamp: string;
                traceId: string;
                updatedAt: string;
            } | {
                dataType: "CATEGORICAL";
            } & {
                stringValue: string;
                value?: null | number;
            } & {
                authorUserId?: null | string;
                comment?: null | string;
                configId?: null | string;
                createdAt: string;
                id: string;
                name: string;
                observationId?: null | string;
                queueId?: null | string;
                source: "ANNOTATION" | "API" | "EVAL";
                timestamp: string;
                traceId: string;
                updatedAt: string;
            } | {
                dataType: "BOOLEAN";
            } & {
                stringValue: string;
                value: number;
            } & {
                authorUserId?: null | string;
                comment?: null | string;
                configId?: null | string;
                createdAt: string;
                id: string;
                name: string;
                observationId?: null | string;
                queueId?: null | string;
                source: "ANNOTATION" | "API" | "EVAL";
                timestamp: string;
                traceId: string;
                updatedAt: string;
            }
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/sessions: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                fromTimestamp?: null | string;
                limit?: null | number;
                page?: null | number;
                toTimestamp?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            createdAt: string;
                            id: string;
                            projectId: string;
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                fromTimestamp?: null | string;
                limit?: null | number;
                page?: null | number;
                toTimestamp?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            createdAt: string;
                            id: string;
                            projectId: string;
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get sessions

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              fromTimestamp?: null | string;
              limit?: null | number;
              page?: null | number;
              toTimestamp?: null | string;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: {
            fromTimestamp?: null | string;
            limit?: null | number;
            page?: null | number;
            toTimestamp?: null | string;
        }
        • OptionalfromTimestamp?: null | string

          Optional filter to only include sessions created on or after a certain datetime (ISO 8601)

        • Optionallimit?: null | number

          Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit.

        • Optionalpage?: null | number

          Page number, starts at 1

        • OptionaltoTimestamp?: null | string

          Optional filter to only include sessions created before a certain datetime (ISO 8601)

    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      data: {
                          createdAt: string;
                          id: string;
                          projectId: string;
                      }[];
                      meta: {
                          limit: number;
                          page: number;
                          totalItems: number;
                          totalPages: number;
                      };
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    data: {
                        createdAt: string;
                        id: string;
                        projectId: string;
                    }[];
                    meta: {
                        limit: number;
                        page: number;
                        totalItems: number;
                        totalPages: number;
                    };
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  data: {
                      createdAt: string;
                      id: string;
                      projectId: string;
                  }[];
                  meta: {
                      limit: number;
                      page: number;
                      totalItems: number;
                      totalPages: number;
                  };
              };
          }
          • application/json: {
                data: {
                    createdAt: string;
                    id: string;
                    projectId: string;
                }[];
                meta: {
                    limit: number;
                    page: number;
                    totalItems: number;
                    totalPages: number;
                };
            }
            • data: {
                  createdAt: string;
                  id: string;
                  projectId: string;
              }[]
            • meta: {
                  limit: number;
                  page: number;
                  totalItems: number;
                  totalPages: number;
              }
              • limit: number

                number of items per page

              • page: number

                current page number

              • totalItems: number

                number of total items given the current filters/selection (if any)

              • totalPages: number

                number of total pages given the current limit

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/sessions/{sessionId}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                sessionId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        traces: {
                            id: string;
                            input?: unknown;
                            metadata?: unknown;
                            name?: null | string;
                            output?: unknown;
                            public?: null | boolean;
                            release?: null | string;
                            sessionId?: null | string;
                            tags?: null | (...)[];
                            timestamp: string;
                            userId?: null | string;
                            version?: null | string;
                        }[];
                    } & {
                        createdAt: string;
                        id: string;
                        projectId: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                sessionId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        traces: {
                            id: string;
                            input?: unknown;
                            metadata?: unknown;
                            name?: null | string;
                            output?: unknown;
                            public?: null | boolean;
                            release?: null | string;
                            sessionId?: null | string;
                            tags?: null | (...)[];
                            timestamp: string;
                            userId?: null | string;
                            version?: null | string;
                        }[];
                    } & {
                        createdAt: string;
                        id: string;
                        projectId: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    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=<sessionId>

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              sessionId: string;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            sessionId: string;
        }
        • sessionId: string

          The unique id of a session

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      traces: {
                          id: string;
                          input?: unknown;
                          metadata?: unknown;
                          name?: null | string;
                          output?: unknown;
                          public?: null | boolean;
                          release?: null | string;
                          sessionId?: null | string;
                          tags?: null | (...)[];
                          timestamp: string;
                          userId?: null | string;
                          version?: null | string;
                      }[];
                  } & {
                      createdAt: string;
                      id: string;
                      projectId: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    traces: {
                        id: string;
                        input?: unknown;
                        metadata?: unknown;
                        name?: null | string;
                        output?: unknown;
                        public?: null | boolean;
                        release?: null | string;
                        sessionId?: null | string;
                        tags?: null | (...)[];
                        timestamp: string;
                        userId?: null | string;
                        version?: null | string;
                    }[];
                } & {
                    createdAt: string;
                    id: string;
                    projectId: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  traces: {
                      id: string;
                      input?: unknown;
                      metadata?: unknown;
                      name?: null | string;
                      output?: unknown;
                      public?: null | boolean;
                      release?: null | string;
                      sessionId?: null | string;
                      tags?: null | (...)[];
                      timestamp: string;
                      userId?: null | string;
                      version?: null | string;
                  }[];
              } & {
                  createdAt: string;
                  id: string;
                  projectId: string;
              };
          }
          • application/json: {
                traces: {
                    id: string;
                    input?: unknown;
                    metadata?: unknown;
                    name?: null | string;
                    output?: unknown;
                    public?: null | boolean;
                    release?: null | string;
                    sessionId?: null | string;
                    tags?: null | (...)[];
                    timestamp: string;
                    userId?: null | string;
                    version?: null | string;
                }[];
            } & {
                createdAt: string;
                id: string;
                projectId: string;
            }
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/traces: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                fromTimestamp?: null | string;
                limit?: null | number;
                name?: null | string;
                orderBy?: null | string;
                page?: null | number;
                release?: null | string;
                sessionId?: null | string;
                tags?: (null | string)[];
                toTimestamp?: null | string;
                userId?: null | string;
                version?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: ({
                            htmlPath: string;
                            latency: number;
                            observations: string[];
                            scores: string[];
                            totalCost: number;
                        } & {
                            id: string;
                            input?: unknown;
                            metadata?: unknown;
                            name?: null | string;
                            output?: unknown;
                            public?: null | boolean;
                            release?: null | string;
                            sessionId?: null | string;
                            tags?: null | (...)[];
                            timestamp: string;
                            userId?: null | string;
                            version?: null | string;
                        })[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                fromTimestamp?: null | string;
                limit?: null | number;
                name?: null | string;
                orderBy?: null | string;
                page?: null | number;
                release?: null | string;
                sessionId?: null | string;
                tags?: (null | string)[];
                toTimestamp?: null | string;
                userId?: null | string;
                version?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: ({
                            htmlPath: string;
                            latency: number;
                            observations: string[];
                            scores: string[];
                            totalCost: number;
                        } & {
                            id: string;
                            input?: unknown;
                            metadata?: unknown;
                            name?: null | string;
                            output?: unknown;
                            public?: null | boolean;
                            release?: null | string;
                            sessionId?: null | string;
                            tags?: null | (...)[];
                            timestamp: string;
                            userId?: null | string;
                            version?: null | string;
                        })[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get list of traces

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              fromTimestamp?: null | string;
              limit?: null | number;
              name?: null | string;
              orderBy?: null | string;
              page?: null | number;
              release?: null | string;
              sessionId?: null | string;
              tags?: (null | string)[];
              toTimestamp?: null | string;
              userId?: null | string;
              version?: null | string;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: {
            fromTimestamp?: null | string;
            limit?: null | number;
            name?: null | string;
            orderBy?: null | string;
            page?: null | number;
            release?: null | string;
            sessionId?: null | string;
            tags?: (null | string)[];
            toTimestamp?: null | string;
            userId?: null | string;
            version?: null | string;
        }
        • OptionalfromTimestamp?: null | string

          Optional filter to only include traces with a trace.timestamp on or after a certain datetime (ISO 8601)

        • Optionallimit?: null | number

          Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit.

        • Optionalname?: null | string
        • OptionalorderBy?: null | string

          Format of the string [field].[asc/desc]. Fields: id, timestamp, name, userId, release, version, public, bookmarked, sessionId. Example: timestamp.asc

        • Optionalpage?: null | number

          Page number, starts at 1

        • Optionalrelease?: null | string

          Optional filter to only include traces with a certain release.

        • OptionalsessionId?: null | string
        • Optionaltags?: (null | string)[]

          Only traces that include all of these tags will be returned.

        • OptionaltoTimestamp?: null | string

          Optional filter to only include traces with a trace.timestamp before a certain datetime (ISO 8601)

        • OptionaluserId?: null | string
        • Optionalversion?: null | string

          Optional filter to only include traces with a certain version.

    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      data: ({
                          htmlPath: string;
                          latency: number;
                          observations: string[];
                          scores: string[];
                          totalCost: number;
                      } & {
                          id: string;
                          input?: unknown;
                          metadata?: unknown;
                          name?: null | string;
                          output?: unknown;
                          public?: null | boolean;
                          release?: null | string;
                          sessionId?: null | string;
                          tags?: null | (...)[];
                          timestamp: string;
                          userId?: null | string;
                          version?: null | string;
                      })[];
                      meta: {
                          limit: number;
                          page: number;
                          totalItems: number;
                          totalPages: number;
                      };
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    data: ({
                        htmlPath: string;
                        latency: number;
                        observations: string[];
                        scores: string[];
                        totalCost: number;
                    } & {
                        id: string;
                        input?: unknown;
                        metadata?: unknown;
                        name?: null | string;
                        output?: unknown;
                        public?: null | boolean;
                        release?: null | string;
                        sessionId?: null | string;
                        tags?: null | (...)[];
                        timestamp: string;
                        userId?: null | string;
                        version?: null | string;
                    })[];
                    meta: {
                        limit: number;
                        page: number;
                        totalItems: number;
                        totalPages: number;
                    };
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  data: ({
                      htmlPath: string;
                      latency: number;
                      observations: string[];
                      scores: string[];
                      totalCost: number;
                  } & {
                      id: string;
                      input?: unknown;
                      metadata?: unknown;
                      name?: null | string;
                      output?: unknown;
                      public?: null | boolean;
                      release?: null | string;
                      sessionId?: null | string;
                      tags?: null | (...)[];
                      timestamp: string;
                      userId?: null | string;
                      version?: null | string;
                  })[];
                  meta: {
                      limit: number;
                      page: number;
                      totalItems: number;
                      totalPages: number;
                  };
              };
          }
          • application/json: {
                data: ({
                    htmlPath: string;
                    latency: number;
                    observations: string[];
                    scores: string[];
                    totalCost: number;
                } & {
                    id: string;
                    input?: unknown;
                    metadata?: unknown;
                    name?: null | string;
                    output?: unknown;
                    public?: null | boolean;
                    release?: null | string;
                    sessionId?: null | string;
                    tags?: null | (...)[];
                    timestamp: string;
                    userId?: null | string;
                    version?: null | string;
                })[];
                meta: {
                    limit: number;
                    page: number;
                    totalItems: number;
                    totalPages: number;
                };
            }
            • data: ({
                  htmlPath: string;
                  latency: number;
                  observations: string[];
                  scores: string[];
                  totalCost: number;
              } & {
                  id: string;
                  input?: unknown;
                  metadata?: unknown;
                  name?: null | string;
                  output?: unknown;
                  public?: null | boolean;
                  release?: null | string;
                  sessionId?: null | string;
                  tags?: null | (...)[];
                  timestamp: string;
                  userId?: null | string;
                  version?: null | string;
              })[]
            • meta: {
                  limit: number;
                  page: number;
                  totalItems: number;
                  totalPages: number;
              }
              • limit: number

                number of items per page

              • page: number

                current page number

              • totalItems: number

                number of total items given the current filters/selection (if any)

              • totalPages: number

                number of total pages given the current limit

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/traces/{traceId}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                traceId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        htmlPath: string;
                        latency: number;
                        observations: ({
                            calculatedInputCost?: (...) | (...) | (...);
                            calculatedOutputCost?: (...) | (...) | (...);
                            calculatedTotalCost?: (...) | (...) | (...);
                            inputPrice?: (...) | (...) | (...);
                            latency?: (...) | (...) | (...);
                            modelId?: (...) | (...) | (...);
                            outputPrice?: (...) | (...) | (...);
                            promptName?: (...) | (...) | (...);
                            promptVersion?: (...) | (...) | (...);
                            timeToFirstToken?: (...) | (...) | (...);
                            totalPrice?: (...) | (...) | (...);
                        } & {
                            completionStartTime?: (...) | (...) | (...);
                            costDetails?: (...) | (...) | (...);
                            endTime?: (...) | (...) | (...);
                            id: string;
                            input?: unknown;
                            level:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            metadata?: unknown;
                            model?: (...) | (...) | (...);
                            modelParameters?: (...) | (...) | (...);
                            name?: (...) | (...) | (...);
                            output?: unknown;
                            parentObservationId?: (...) | (...) | (...);
                            promptId?: (...) | (...) | (...);
                            startTime: string;
                            statusMessage?: (...) | (...) | (...);
                            traceId?: (...) | (...) | (...);
                            type: string;
                            usage?: (...) | (...);
                            usageDetails?: (...) | (...) | (...);
                            version?: (...) | (...) | (...);
                        })[];
                        scores: ({
                            dataType: ...;
                        } & {
                            value: ...;
                        } & {
                            authorUserId?: ...;
                            comment?: ...;
                            configId?: ...;
                            createdAt: ...;
                            id: ...;
                            name: ...;
                            observationId?: ...;
                            queueId?: ...;
                            source: ...;
                            timestamp: ...;
                            traceId: ...;
                            updatedAt: ...;
                        } | {
                            dataType: ...;
                        } & {
                            stringValue: ...;
                            value?: ...;
                        } & {
                            authorUserId?: ...;
                            comment?: ...;
                            configId?: ...;
                            createdAt: ...;
                            id: ...;
                            name: ...;
                            observationId?: ...;
                            queueId?: ...;
                            source: ...;
                            timestamp: ...;
                            traceId: ...;
                            updatedAt: ...;
                        } | {
                            dataType: ...;
                        } & {
                            stringValue: ...;
                            value: ...;
                        } & {
                            authorUserId?: ...;
                            comment?: ...;
                            configId?: ...;
                            createdAt: ...;
                            id: ...;
                            name: ...;
                            observationId?: ...;
                            queueId?: ...;
                            source: ...;
                            timestamp: ...;
                            traceId: ...;
                            updatedAt: ...;
                        })[];
                        totalCost: number;
                    } & {
                        id: string;
                        input?: unknown;
                        metadata?: unknown;
                        name?: null | string;
                        output?: unknown;
                        public?: null | boolean;
                        release?: null | string;
                        sessionId?: null | string;
                        tags?: null | string[];
                        timestamp: string;
                        userId?: null | string;
                        version?: null | string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                traceId: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        htmlPath: string;
                        latency: number;
                        observations: ({
                            calculatedInputCost?: (...) | (...) | (...);
                            calculatedOutputCost?: (...) | (...) | (...);
                            calculatedTotalCost?: (...) | (...) | (...);
                            inputPrice?: (...) | (...) | (...);
                            latency?: (...) | (...) | (...);
                            modelId?: (...) | (...) | (...);
                            outputPrice?: (...) | (...) | (...);
                            promptName?: (...) | (...) | (...);
                            promptVersion?: (...) | (...) | (...);
                            timeToFirstToken?: (...) | (...) | (...);
                            totalPrice?: (...) | (...) | (...);
                        } & {
                            completionStartTime?: (...) | (...) | (...);
                            costDetails?: (...) | (...) | (...);
                            endTime?: (...) | (...) | (...);
                            id: string;
                            input?: unknown;
                            level:
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            metadata?: unknown;
                            model?: (...) | (...) | (...);
                            modelParameters?: (...) | (...) | (...);
                            name?: (...) | (...) | (...);
                            output?: unknown;
                            parentObservationId?: (...) | (...) | (...);
                            promptId?: (...) | (...) | (...);
                            startTime: string;
                            statusMessage?: (...) | (...) | (...);
                            traceId?: (...) | (...) | (...);
                            type: string;
                            usage?: (...) | (...);
                            usageDetails?: (...) | (...) | (...);
                            version?: (...) | (...) | (...);
                        })[];
                        scores: ({
                            dataType: ...;
                        } & {
                            value: ...;
                        } & {
                            authorUserId?: ...;
                            comment?: ...;
                            configId?: ...;
                            createdAt: ...;
                            id: ...;
                            name: ...;
                            observationId?: ...;
                            queueId?: ...;
                            source: ...;
                            timestamp: ...;
                            traceId: ...;
                            updatedAt: ...;
                        } | {
                            dataType: ...;
                        } & {
                            stringValue: ...;
                            value?: ...;
                        } & {
                            authorUserId?: ...;
                            comment?: ...;
                            configId?: ...;
                            createdAt: ...;
                            id: ...;
                            name: ...;
                            observationId?: ...;
                            queueId?: ...;
                            source: ...;
                            timestamp: ...;
                            traceId: ...;
                            updatedAt: ...;
                        } | {
                            dataType: ...;
                        } & {
                            stringValue: ...;
                            value: ...;
                        } & {
                            authorUserId?: ...;
                            comment?: ...;
                            configId?: ...;
                            createdAt: ...;
                            id: ...;
                            name: ...;
                            observationId?: ...;
                            queueId?: ...;
                            source: ...;
                            timestamp: ...;
                            traceId: ...;
                            updatedAt: ...;
                        })[];
                        totalCost: number;
                    } & {
                        id: string;
                        input?: unknown;
                        metadata?: unknown;
                        name?: null | string;
                        output?: unknown;
                        public?: null | boolean;
                        release?: null | string;
                        sessionId?: null | string;
                        tags?: null | string[];
                        timestamp: string;
                        userId?: null | string;
                        version?: null | string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a specific trace

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              traceId: string;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            traceId: string;
        }
        • traceId: string

          The unique langfuse identifier of a trace

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      htmlPath: string;
                      latency: number;
                      observations: ({
                          calculatedInputCost?: (...) | (...) | (...);
                          calculatedOutputCost?: (...) | (...) | (...);
                          calculatedTotalCost?: (...) | (...) | (...);
                          inputPrice?: (...) | (...) | (...);
                          latency?: (...) | (...) | (...);
                          modelId?: (...) | (...) | (...);
                          outputPrice?: (...) | (...) | (...);
                          promptName?: (...) | (...) | (...);
                          promptVersion?: (...) | (...) | (...);
                          timeToFirstToken?: (...) | (...) | (...);
                          totalPrice?: (...) | (...) | (...);
                      } & {
                          completionStartTime?: (...) | (...) | (...);
                          costDetails?: (...) | (...) | (...);
                          endTime?: (...) | (...) | (...);
                          id: string;
                          input?: unknown;
                          level:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          metadata?: unknown;
                          model?: (...) | (...) | (...);
                          modelParameters?: (...) | (...) | (...);
                          name?: (...) | (...) | (...);
                          output?: unknown;
                          parentObservationId?: (...) | (...) | (...);
                          promptId?: (...) | (...) | (...);
                          startTime: string;
                          statusMessage?: (...) | (...) | (...);
                          traceId?: (...) | (...) | (...);
                          type: string;
                          usage?: (...) | (...);
                          usageDetails?: (...) | (...) | (...);
                          version?: (...) | (...) | (...);
                      })[];
                      scores: ({
                          dataType: ...;
                      } & {
                          value: ...;
                      } & {
                          authorUserId?: ...;
                          comment?: ...;
                          configId?: ...;
                          createdAt: ...;
                          id: ...;
                          name: ...;
                          observationId?: ...;
                          queueId?: ...;
                          source: ...;
                          timestamp: ...;
                          traceId: ...;
                          updatedAt: ...;
                      } | {
                          dataType: ...;
                      } & {
                          stringValue: ...;
                          value?: ...;
                      } & {
                          authorUserId?: ...;
                          comment?: ...;
                          configId?: ...;
                          createdAt: ...;
                          id: ...;
                          name: ...;
                          observationId?: ...;
                          queueId?: ...;
                          source: ...;
                          timestamp: ...;
                          traceId: ...;
                          updatedAt: ...;
                      } | {
                          dataType: ...;
                      } & {
                          stringValue: ...;
                          value: ...;
                      } & {
                          authorUserId?: ...;
                          comment?: ...;
                          configId?: ...;
                          createdAt: ...;
                          id: ...;
                          name: ...;
                          observationId?: ...;
                          queueId?: ...;
                          source: ...;
                          timestamp: ...;
                          traceId: ...;
                          updatedAt: ...;
                      })[];
                      totalCost: number;
                  } & {
                      id: string;
                      input?: unknown;
                      metadata?: unknown;
                      name?: null | string;
                      output?: unknown;
                      public?: null | boolean;
                      release?: null | string;
                      sessionId?: null | string;
                      tags?: null | string[];
                      timestamp: string;
                      userId?: null | string;
                      version?: null | string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    htmlPath: string;
                    latency: number;
                    observations: ({
                        calculatedInputCost?: (...) | (...) | (...);
                        calculatedOutputCost?: (...) | (...) | (...);
                        calculatedTotalCost?: (...) | (...) | (...);
                        inputPrice?: (...) | (...) | (...);
                        latency?: (...) | (...) | (...);
                        modelId?: (...) | (...) | (...);
                        outputPrice?: (...) | (...) | (...);
                        promptName?: (...) | (...) | (...);
                        promptVersion?: (...) | (...) | (...);
                        timeToFirstToken?: (...) | (...) | (...);
                        totalPrice?: (...) | (...) | (...);
                    } & {
                        completionStartTime?: (...) | (...) | (...);
                        costDetails?: (...) | (...) | (...);
                        endTime?: (...) | (...) | (...);
                        id: string;
                        input?: unknown;
                        level:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        metadata?: unknown;
                        model?: (...) | (...) | (...);
                        modelParameters?: (...) | (...) | (...);
                        name?: (...) | (...) | (...);
                        output?: unknown;
                        parentObservationId?: (...) | (...) | (...);
                        promptId?: (...) | (...) | (...);
                        startTime: string;
                        statusMessage?: (...) | (...) | (...);
                        traceId?: (...) | (...) | (...);
                        type: string;
                        usage?: (...) | (...);
                        usageDetails?: (...) | (...) | (...);
                        version?: (...) | (...) | (...);
                    })[];
                    scores: ({
                        dataType: ...;
                    } & {
                        value: ...;
                    } & {
                        authorUserId?: ...;
                        comment?: ...;
                        configId?: ...;
                        createdAt: ...;
                        id: ...;
                        name: ...;
                        observationId?: ...;
                        queueId?: ...;
                        source: ...;
                        timestamp: ...;
                        traceId: ...;
                        updatedAt: ...;
                    } | {
                        dataType: ...;
                    } & {
                        stringValue: ...;
                        value?: ...;
                    } & {
                        authorUserId?: ...;
                        comment?: ...;
                        configId?: ...;
                        createdAt: ...;
                        id: ...;
                        name: ...;
                        observationId?: ...;
                        queueId?: ...;
                        source: ...;
                        timestamp: ...;
                        traceId: ...;
                        updatedAt: ...;
                    } | {
                        dataType: ...;
                    } & {
                        stringValue: ...;
                        value: ...;
                    } & {
                        authorUserId?: ...;
                        comment?: ...;
                        configId?: ...;
                        createdAt: ...;
                        id: ...;
                        name: ...;
                        observationId?: ...;
                        queueId?: ...;
                        source: ...;
                        timestamp: ...;
                        traceId: ...;
                        updatedAt: ...;
                    })[];
                    totalCost: number;
                } & {
                    id: string;
                    input?: unknown;
                    metadata?: unknown;
                    name?: null | string;
                    output?: unknown;
                    public?: null | boolean;
                    release?: null | string;
                    sessionId?: null | string;
                    tags?: null | string[];
                    timestamp: string;
                    userId?: null | string;
                    version?: null | string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  htmlPath: string;
                  latency: number;
                  observations: ({
                      calculatedInputCost?: (...) | (...) | (...);
                      calculatedOutputCost?: (...) | (...) | (...);
                      calculatedTotalCost?: (...) | (...) | (...);
                      inputPrice?: (...) | (...) | (...);
                      latency?: (...) | (...) | (...);
                      modelId?: (...) | (...) | (...);
                      outputPrice?: (...) | (...) | (...);
                      promptName?: (...) | (...) | (...);
                      promptVersion?: (...) | (...) | (...);
                      timeToFirstToken?: (...) | (...) | (...);
                      totalPrice?: (...) | (...) | (...);
                  } & {
                      completionStartTime?: (...) | (...) | (...);
                      costDetails?: (...) | (...) | (...);
                      endTime?: (...) | (...) | (...);
                      id: string;
                      input?: unknown;
                      level:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      metadata?: unknown;
                      model?: (...) | (...) | (...);
                      modelParameters?: (...) | (...) | (...);
                      name?: (...) | (...) | (...);
                      output?: unknown;
                      parentObservationId?: (...) | (...) | (...);
                      promptId?: (...) | (...) | (...);
                      startTime: string;
                      statusMessage?: (...) | (...) | (...);
                      traceId?: (...) | (...) | (...);
                      type: string;
                      usage?: (...) | (...);
                      usageDetails?: (...) | (...) | (...);
                      version?: (...) | (...) | (...);
                  })[];
                  scores: ({
                      dataType: ...;
                  } & {
                      value: ...;
                  } & {
                      authorUserId?: ...;
                      comment?: ...;
                      configId?: ...;
                      createdAt: ...;
                      id: ...;
                      name: ...;
                      observationId?: ...;
                      queueId?: ...;
                      source: ...;
                      timestamp: ...;
                      traceId: ...;
                      updatedAt: ...;
                  } | {
                      dataType: ...;
                  } & {
                      stringValue: ...;
                      value?: ...;
                  } & {
                      authorUserId?: ...;
                      comment?: ...;
                      configId?: ...;
                      createdAt: ...;
                      id: ...;
                      name: ...;
                      observationId?: ...;
                      queueId?: ...;
                      source: ...;
                      timestamp: ...;
                      traceId: ...;
                      updatedAt: ...;
                  } | {
                      dataType: ...;
                  } & {
                      stringValue: ...;
                      value: ...;
                  } & {
                      authorUserId?: ...;
                      comment?: ...;
                      configId?: ...;
                      createdAt: ...;
                      id: ...;
                      name: ...;
                      observationId?: ...;
                      queueId?: ...;
                      source: ...;
                      timestamp: ...;
                      traceId: ...;
                      updatedAt: ...;
                  })[];
                  totalCost: number;
              } & {
                  id: string;
                  input?: unknown;
                  metadata?: unknown;
                  name?: null | string;
                  output?: unknown;
                  public?: null | boolean;
                  release?: null | string;
                  sessionId?: null | string;
                  tags?: null | string[];
                  timestamp: string;
                  userId?: null | string;
                  version?: null | string;
              };
          }
          • application/json: {
                htmlPath: string;
                latency: number;
                observations: ({
                    calculatedInputCost?: (...) | (...) | (...);
                    calculatedOutputCost?: (...) | (...) | (...);
                    calculatedTotalCost?: (...) | (...) | (...);
                    inputPrice?: (...) | (...) | (...);
                    latency?: (...) | (...) | (...);
                    modelId?: (...) | (...) | (...);
                    outputPrice?: (...) | (...) | (...);
                    promptName?: (...) | (...) | (...);
                    promptVersion?: (...) | (...) | (...);
                    timeToFirstToken?: (...) | (...) | (...);
                    totalPrice?: (...) | (...) | (...);
                } & {
                    completionStartTime?: (...) | (...) | (...);
                    costDetails?: (...) | (...) | (...);
                    endTime?: (...) | (...) | (...);
                    id: string;
                    input?: unknown;
                    level:
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    metadata?: unknown;
                    model?: (...) | (...) | (...);
                    modelParameters?: (...) | (...) | (...);
                    name?: (...) | (...) | (...);
                    output?: unknown;
                    parentObservationId?: (...) | (...) | (...);
                    promptId?: (...) | (...) | (...);
                    startTime: string;
                    statusMessage?: (...) | (...) | (...);
                    traceId?: (...) | (...) | (...);
                    type: string;
                    usage?: (...) | (...);
                    usageDetails?: (...) | (...) | (...);
                    version?: (...) | (...) | (...);
                })[];
                scores: ({
                    dataType: ...;
                } & {
                    value: ...;
                } & {
                    authorUserId?: ...;
                    comment?: ...;
                    configId?: ...;
                    createdAt: ...;
                    id: ...;
                    name: ...;
                    observationId?: ...;
                    queueId?: ...;
                    source: ...;
                    timestamp: ...;
                    traceId: ...;
                    updatedAt: ...;
                } | {
                    dataType: ...;
                } & {
                    stringValue: ...;
                    value?: ...;
                } & {
                    authorUserId?: ...;
                    comment?: ...;
                    configId?: ...;
                    createdAt: ...;
                    id: ...;
                    name: ...;
                    observationId?: ...;
                    queueId?: ...;
                    source: ...;
                    timestamp: ...;
                    traceId: ...;
                    updatedAt: ...;
                } | {
                    dataType: ...;
                } & {
                    stringValue: ...;
                    value: ...;
                } & {
                    authorUserId?: ...;
                    comment?: ...;
                    configId?: ...;
                    createdAt: ...;
                    id: ...;
                    name: ...;
                    observationId?: ...;
                    queueId?: ...;
                    source: ...;
                    timestamp: ...;
                    traceId: ...;
                    updatedAt: ...;
                })[];
                totalCost: number;
            } & {
                id: string;
                input?: unknown;
                metadata?: unknown;
                name?: null | string;
                output?: unknown;
                public?: null | boolean;
                release?: null | string;
                sessionId?: null | string;
                tags?: null | string[];
                timestamp: string;
                userId?: null | string;
                version?: null | string;
            }
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/v2/datasets: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                limit?: null | number;
                page?: null | number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            createdAt: string;
                            description?: null | string;
                            id: string;
                            metadata?: unknown;
                            name: string;
                            projectId: string;
                            updatedAt: string;
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    description?: null | string;
                    metadata?: unknown;
                    name: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        createdAt: string;
                        description?: null | string;
                        id: string;
                        metadata?: unknown;
                        name: string;
                        projectId: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                limit?: null | number;
                page?: null | number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            createdAt: string;
                            description?: null | string;
                            id: string;
                            metadata?: unknown;
                            name: string;
                            projectId: string;
                            updatedAt: string;
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get all datasets

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              limit?: null | number;
              page?: null | number;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: {
            limit?: null | number;
            page?: null | number;
        }
        • Optionallimit?: null | number

          limit of items per page

        • Optionalpage?: null | number

          page number, starts at 1

    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      data: {
                          createdAt: string;
                          description?: null | string;
                          id: string;
                          metadata?: unknown;
                          name: string;
                          projectId: string;
                          updatedAt: string;
                      }[];
                      meta: {
                          limit: number;
                          page: number;
                          totalItems: number;
                          totalPages: number;
                      };
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    data: {
                        createdAt: string;
                        description?: null | string;
                        id: string;
                        metadata?: unknown;
                        name: string;
                        projectId: string;
                        updatedAt: string;
                    }[];
                    meta: {
                        limit: number;
                        page: number;
                        totalItems: number;
                        totalPages: number;
                    };
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  data: {
                      createdAt: string;
                      description?: null | string;
                      id: string;
                      metadata?: unknown;
                      name: string;
                      projectId: string;
                      updatedAt: string;
                  }[];
                  meta: {
                      limit: number;
                      page: number;
                      totalItems: number;
                      totalPages: number;
                  };
              };
          }
          • application/json: {
                data: {
                    createdAt: string;
                    description?: null | string;
                    id: string;
                    metadata?: unknown;
                    name: string;
                    projectId: string;
                    updatedAt: string;
                }[];
                meta: {
                    limit: number;
                    page: number;
                    totalItems: number;
                    totalPages: number;
                };
            }
            • data: {
                  createdAt: string;
                  description?: null | string;
                  id: string;
                  metadata?: unknown;
                  name: string;
                  projectId: string;
                  updatedAt: string;
              }[]
            • meta: {
                  limit: number;
                  page: number;
                  totalItems: number;
                  totalPages: number;
              }
              • limit: number

                number of items per page

              • page: number

                current page number

              • totalItems: number

                number of total items given the current filters/selection (if any)

              • totalPages: number

                number of total pages given the current limit

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    description?: null | string;
                    metadata?: unknown;
                    name: string;
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        createdAt: string;
                        description?: null | string;
                        id: string;
                        metadata?: unknown;
                        name: string;
                        projectId: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Create a dataset

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: undefined
    • requestBody: {
          content: {
              application/json: {
                  description?: null | string;
                  metadata?: unknown;
                  name: string;
              };
          };
      }
      • content: {
            application/json: {
                description?: null | string;
                metadata?: unknown;
                name: string;
            };
        }
        • application/json: {
              description?: null | string;
              metadata?: unknown;
              name: string;
          }
          • Optionaldescription?: null | string
          • Optionalmetadata?: unknown
          • name: string
    • responses: {
          200: {
              content: {
                  application/json: {
                      createdAt: string;
                      description?: null | string;
                      id: string;
                      metadata?: unknown;
                      name: string;
                      projectId: string;
                      updatedAt: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    createdAt: string;
                    description?: null | string;
                    id: string;
                    metadata?: unknown;
                    name: string;
                    projectId: string;
                    updatedAt: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  createdAt: string;
                  description?: null | string;
                  id: string;
                  metadata?: unknown;
                  name: string;
                  projectId: string;
                  updatedAt: string;
              };
          }
          • application/json: {
                createdAt: string;
                description?: null | string;
                id: string;
                metadata?: unknown;
                name: string;
                projectId: string;
                updatedAt: string;
            }
            • createdAt: string

              Format: date-time

            • Optionaldescription?: null | string
            • id: string
            • Optionalmetadata?: unknown
            • name: string
            • projectId: string
            • updatedAt: string

              Format: date-time

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/v2/datasets/{datasetName}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                datasetName: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        createdAt: string;
                        description?: null | string;
                        id: string;
                        metadata?: unknown;
                        name: string;
                        projectId: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                datasetName: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        createdAt: string;
                        description?: null | string;
                        id: string;
                        metadata?: unknown;
                        name: string;
                        projectId: string;
                        updatedAt: string;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a dataset

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              datasetName: string;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            datasetName: string;
        }
        • datasetName: string
      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      createdAt: string;
                      description?: null | string;
                      id: string;
                      metadata?: unknown;
                      name: string;
                      projectId: string;
                      updatedAt: string;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    createdAt: string;
                    description?: null | string;
                    id: string;
                    metadata?: unknown;
                    name: string;
                    projectId: string;
                    updatedAt: string;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  createdAt: string;
                  description?: null | string;
                  id: string;
                  metadata?: unknown;
                  name: string;
                  projectId: string;
                  updatedAt: string;
              };
          }
          • application/json: {
                createdAt: string;
                description?: null | string;
                id: string;
                metadata?: unknown;
                name: string;
                projectId: string;
                updatedAt: string;
            }
            • createdAt: string

              Format: date-time

            • Optionaldescription?: null | string
            • id: string
            • Optionalmetadata?: unknown
            • name: string
            • projectId: string
            • updatedAt: string

              Format: date-time

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/v2/prompts: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                fromUpdatedAt?: null | string;
                label?: null | string;
                limit?: null | number;
                name?: null | string;
                page?: null | number;
                tag?: null | string;
                toUpdatedAt?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            labels: string[];
                            lastConfig: unknown;
                            lastUpdatedAt: string;
                            name: string;
                            tags: string[];
                            versions: number[];
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "chat";
                } & {
                    commitMessage?: null | string;
                    config?: unknown;
                    labels?: null | string[];
                    name: string;
                    prompt: {
                        content: string;
                        role: string;
                    }[];
                    tags?: null | string[];
                } | {
                    type: "text";
                } & {
                    commitMessage?: null | string;
                    config?: unknown;
                    labels?: null | string[];
                    name: string;
                    prompt: string;
                    tags?: null | string[];
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "chat";
                    } & {
                        prompt: {
                            content: string;
                            role: string;
                        }[];
                    } & {
                        commitMessage?: null | string;
                        config: unknown;
                        labels: string[];
                        name: string;
                        tags: string[];
                        version: number;
                    } | {
                        type: "text";
                    } & {
                        prompt: string;
                    } & {
                        commitMessage?: null | string;
                        config: unknown;
                        labels: string[];
                        name: string;
                        tags: string[];
                        version: number;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                fromUpdatedAt?: null | string;
                label?: null | string;
                limit?: null | number;
                name?: null | string;
                page?: null | number;
                tag?: null | string;
                toUpdatedAt?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        data: {
                            labels: string[];
                            lastConfig: unknown;
                            lastUpdatedAt: string;
                            name: string;
                            tags: string[];
                            versions: number[];
                        }[];
                        meta: {
                            limit: number;
                            page: number;
                            totalItems: number;
                            totalPages: number;
                        };
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a list of prompt names with versions and labels

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              fromUpdatedAt?: null | string;
              label?: null | string;
              limit?: null | number;
              name?: null | string;
              page?: null | number;
              tag?: null | string;
              toUpdatedAt?: null | string;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: {
            fromUpdatedAt?: null | string;
            label?: null | string;
            limit?: null | number;
            name?: null | string;
            page?: null | number;
            tag?: null | string;
            toUpdatedAt?: null | string;
        }
        • OptionalfromUpdatedAt?: null | string

          Optional filter to only include prompt versions created/updated on or after a certain datetime (ISO 8601)

        • Optionallabel?: null | string
        • Optionallimit?: null | number

          limit of items per page

        • Optionalname?: null | string
        • Optionalpage?: null | number

          page number, starts at 1

        • Optionaltag?: null | string
        • OptionaltoUpdatedAt?: null | string

          Optional filter to only include prompt versions created/updated before a certain datetime (ISO 8601)

    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      data: {
                          labels: string[];
                          lastConfig: unknown;
                          lastUpdatedAt: string;
                          name: string;
                          tags: string[];
                          versions: number[];
                      }[];
                      meta: {
                          limit: number;
                          page: number;
                          totalItems: number;
                          totalPages: number;
                      };
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    data: {
                        labels: string[];
                        lastConfig: unknown;
                        lastUpdatedAt: string;
                        name: string;
                        tags: string[];
                        versions: number[];
                    }[];
                    meta: {
                        limit: number;
                        page: number;
                        totalItems: number;
                        totalPages: number;
                    };
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  data: {
                      labels: string[];
                      lastConfig: unknown;
                      lastUpdatedAt: string;
                      name: string;
                      tags: string[];
                      versions: number[];
                  }[];
                  meta: {
                      limit: number;
                      page: number;
                      totalItems: number;
                      totalPages: number;
                  };
              };
          }
          • application/json: {
                data: {
                    labels: string[];
                    lastConfig: unknown;
                    lastUpdatedAt: string;
                    name: string;
                    tags: string[];
                    versions: number[];
                }[];
                meta: {
                    limit: number;
                    page: number;
                    totalItems: number;
                    totalPages: number;
                };
            }
            • data: {
                  labels: string[];
                  lastConfig: unknown;
                  lastUpdatedAt: string;
                  name: string;
                  tags: string[];
                  versions: number[];
              }[]
            • meta: {
                  limit: number;
                  page: number;
                  totalItems: number;
                  totalPages: number;
              }
              • limit: number

                number of items per page

              • page: number

                current page number

              • totalItems: number

                number of total items given the current filters/selection (if any)

              • totalPages: number

                number of total pages given the current limit

        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    type: "chat";
                } & {
                    commitMessage?: null | string;
                    config?: unknown;
                    labels?: null | string[];
                    name: string;
                    prompt: {
                        content: string;
                        role: string;
                    }[];
                    tags?: null | string[];
                } | {
                    type: "text";
                } & {
                    commitMessage?: null | string;
                    config?: unknown;
                    labels?: null | string[];
                    name: string;
                    prompt: string;
                    tags?: null | string[];
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "chat";
                    } & {
                        prompt: {
                            content: string;
                            role: string;
                        }[];
                    } & {
                        commitMessage?: null | string;
                        config: unknown;
                        labels: string[];
                        name: string;
                        tags: string[];
                        version: number;
                    } | {
                        type: "text";
                    } & {
                        prompt: string;
                    } & {
                        commitMessage?: null | string;
                        config: unknown;
                        labels: string[];
                        name: string;
                        tags: string[];
                        version: number;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Create a new version for the prompt with the given name

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: undefined
    • requestBody: {
          content: {
              application/json: {
                  type: "chat";
              } & {
                  commitMessage?: null | string;
                  config?: unknown;
                  labels?: null | string[];
                  name: string;
                  prompt: {
                      content: string;
                      role: string;
                  }[];
                  tags?: null | string[];
              } | {
                  type: "text";
              } & {
                  commitMessage?: null | string;
                  config?: unknown;
                  labels?: null | string[];
                  name: string;
                  prompt: string;
                  tags?: null | string[];
              };
          };
      }
      • content: {
            application/json: {
                type: "chat";
            } & {
                commitMessage?: null | string;
                config?: unknown;
                labels?: null | string[];
                name: string;
                prompt: {
                    content: string;
                    role: string;
                }[];
                tags?: null | string[];
            } | {
                type: "text";
            } & {
                commitMessage?: null | string;
                config?: unknown;
                labels?: null | string[];
                name: string;
                prompt: string;
                tags?: null | string[];
            };
        }
        • application/json: {
              type: "chat";
          } & {
              commitMessage?: null | string;
              config?: unknown;
              labels?: null | string[];
              name: string;
              prompt: {
                  content: string;
                  role: string;
              }[];
              tags?: null | string[];
          } | {
              type: "text";
          } & {
              commitMessage?: null | string;
              config?: unknown;
              labels?: null | string[];
              name: string;
              prompt: string;
              tags?: null | string[];
          }
    • responses: {
          200: {
              content: {
                  application/json: {
                      type: "chat";
                  } & {
                      prompt: {
                          content: string;
                          role: string;
                      }[];
                  } & {
                      commitMessage?: null | string;
                      config: unknown;
                      labels: string[];
                      name: string;
                      tags: string[];
                      version: number;
                  } | {
                      type: "text";
                  } & {
                      prompt: string;
                  } & {
                      commitMessage?: null | string;
                      config: unknown;
                      labels: string[];
                      name: string;
                      tags: string[];
                      version: number;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    type: "chat";
                } & {
                    prompt: {
                        content: string;
                        role: string;
                    }[];
                } & {
                    commitMessage?: null | string;
                    config: unknown;
                    labels: string[];
                    name: string;
                    tags: string[];
                    version: number;
                } | {
                    type: "text";
                } & {
                    prompt: string;
                } & {
                    commitMessage?: null | string;
                    config: unknown;
                    labels: string[];
                    name: string;
                    tags: string[];
                    version: number;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  type: "chat";
              } & {
                  prompt: {
                      content: string;
                      role: string;
                  }[];
              } & {
                  commitMessage?: null | string;
                  config: unknown;
                  labels: string[];
                  name: string;
                  tags: string[];
                  version: number;
              } | {
                  type: "text";
              } & {
                  prompt: string;
              } & {
                  commitMessage?: null | string;
                  config: unknown;
                  labels: string[];
                  name: string;
                  tags: string[];
                  version: number;
              };
          }
          • application/json: {
                type: "chat";
            } & {
                prompt: {
                    content: string;
                    role: string;
                }[];
            } & {
                commitMessage?: null | string;
                config: unknown;
                labels: string[];
                name: string;
                tags: string[];
                version: number;
            } | {
                type: "text";
            } & {
                prompt: string;
            } & {
                commitMessage?: null | string;
                config: unknown;
                labels: string[];
                name: string;
                tags: string[];
                version: number;
            }
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/v2/prompts/{name}/versions/{version}: {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                name: string;
                version: number;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    newLabels: string[];
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "chat";
                    } & {
                        prompt: {
                            content: string;
                            role: string;
                        }[];
                    } & {
                        commitMessage?: null | string;
                        config: unknown;
                        labels: string[];
                        name: string;
                        tags: string[];
                        version: number;
                    } | {
                        type: "text";
                    } & {
                        prompt: string;
                    } & {
                        commitMessage?: null | string;
                        config: unknown;
                        labels: string[];
                        name: string;
                        tags: string[];
                        version: number;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • patch: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                name: string;
                version: number;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                application/json: {
                    newLabels: string[];
                };
            };
        };
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "chat";
                    } & {
                        prompt: {
                            content: string;
                            role: string;
                        }[];
                    } & {
                        commitMessage?: null | string;
                        config: unknown;
                        labels: string[];
                        name: string;
                        tags: string[];
                        version: number;
                    } | {
                        type: "text";
                    } & {
                        prompt: string;
                    } & {
                        commitMessage?: null | string;
                        config: unknown;
                        labels: string[];
                        name: string;
                        tags: string[];
                        version: number;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Update labels for a specific prompt version

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              name: string;
              version: number;
          };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            name: string;
            version: number;
        }
        • name: string

          The name of the prompt

        • version: number

          Version of the prompt to update

      • Optionalquery?: undefined
    • requestBody: {
          content: {
              application/json: {
                  newLabels: string[];
              };
          };
      }
      • content: {
            application/json: {
                newLabels: string[];
            };
        }
        • application/json: {
              newLabels: string[];
          }
          • newLabels: string[]

            New labels for the prompt version. Labels are unique across versions. The "latest" label is reserved and managed by Langfuse.

    • responses: {
          200: {
              content: {
                  application/json: {
                      type: "chat";
                  } & {
                      prompt: {
                          content: string;
                          role: string;
                      }[];
                  } & {
                      commitMessage?: null | string;
                      config: unknown;
                      labels: string[];
                      name: string;
                      tags: string[];
                      version: number;
                  } | {
                      type: "text";
                  } & {
                      prompt: string;
                  } & {
                      commitMessage?: null | string;
                      config: unknown;
                      labels: string[];
                      name: string;
                      tags: string[];
                      version: number;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    type: "chat";
                } & {
                    prompt: {
                        content: string;
                        role: string;
                    }[];
                } & {
                    commitMessage?: null | string;
                    config: unknown;
                    labels: string[];
                    name: string;
                    tags: string[];
                    version: number;
                } | {
                    type: "text";
                } & {
                    prompt: string;
                } & {
                    commitMessage?: null | string;
                    config: unknown;
                    labels: string[];
                    name: string;
                    tags: string[];
                    version: number;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  type: "chat";
              } & {
                  prompt: {
                      content: string;
                      role: string;
                  }[];
              } & {
                  commitMessage?: null | string;
                  config: unknown;
                  labels: string[];
                  name: string;
                  tags: string[];
                  version: number;
              } | {
                  type: "text";
              } & {
                  prompt: string;
              } & {
                  commitMessage?: null | string;
                  config: unknown;
                  labels: string[];
                  name: string;
                  tags: string[];
                  version: number;
              };
          }
          • application/json: {
                type: "chat";
            } & {
                prompt: {
                    content: string;
                    role: string;
                }[];
            } & {
                commitMessage?: null | string;
                config: unknown;
                labels: string[];
                name: string;
                tags: string[];
                version: number;
            } | {
                type: "text";
            } & {
                prompt: string;
            } & {
                commitMessage?: null | string;
                config: unknown;
                labels: string[];
                name: string;
                tags: string[];
                version: number;
            }
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
/api/public/v2/prompts/{promptName}: {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                promptName: string;
            };
            query?: {
                label?: null | string;
                version?: null | number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "chat";
                    } & {
                        prompt: {
                            content: string;
                            role: string;
                        }[];
                    } & {
                        commitMessage?: null | string;
                        config: unknown;
                        labels: string[];
                        name: string;
                        tags: string[];
                        version: number;
                    } | {
                        type: "text";
                    } & {
                        prompt: string;
                    } & {
                        commitMessage?: null | string;
                        config: unknown;
                        labels: string[];
                        name: string;
                        tags: string[];
                        version: number;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                promptName: string;
            };
            query?: {
                label?: null | string;
                version?: null | number;
            };
        };
        requestBody?: undefined;
        responses: {
            200: {
                content: {
                    application/json: {
                        type: "chat";
                    } & {
                        prompt: {
                            content: string;
                            role: string;
                        }[];
                    } & {
                        commitMessage?: null | string;
                        config: unknown;
                        labels: string[];
                        name: string;
                        tags: string[];
                        version: number;
                    } | {
                        type: "text";
                    } & {
                        prompt: string;
                    } & {
                        commitMessage?: null | string;
                        config: unknown;
                        labels: string[];
                        name: string;
                        tags: string[];
                        version: number;
                    };
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            400: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            401: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            403: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            404: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
            405: {
                content: {
                    application/json: unknown;
                };
                headers: {
                    [name: string]: unknown;
                };
            };
        };
    }

    Get a prompt

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: {
              promptName: string;
          };
          query?: {
              label?: null | string;
              version?: null | number;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: {
            promptName: string;
        }
        • promptName: string

          The name of the prompt

      • Optionalquery?: {
            label?: null | string;
            version?: null | number;
        }
        • Optionallabel?: null | string

          Label of the prompt to be retrieved. Defaults to "production" if no label or version is set.

        • Optionalversion?: null | number

          Version of the prompt to be retrieved.

    • OptionalrequestBody?: undefined
    • responses: {
          200: {
              content: {
                  application/json: {
                      type: "chat";
                  } & {
                      prompt: {
                          content: string;
                          role: string;
                      }[];
                  } & {
                      commitMessage?: null | string;
                      config: unknown;
                      labels: string[];
                      name: string;
                      tags: string[];
                      version: number;
                  } | {
                      type: "text";
                  } & {
                      prompt: string;
                  } & {
                      commitMessage?: null | string;
                      config: unknown;
                      labels: string[];
                      name: string;
                      tags: string[];
                      version: number;
                  };
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          400: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          401: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          403: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          404: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
          405: {
              content: {
                  application/json: unknown;
              };
              headers: {
                  [name: string]: unknown;
              };
          };
      }
      • 200: {
            content: {
                application/json: {
                    type: "chat";
                } & {
                    prompt: {
                        content: string;
                        role: string;
                    }[];
                } & {
                    commitMessage?: null | string;
                    config: unknown;
                    labels: string[];
                    name: string;
                    tags: string[];
                    version: number;
                } | {
                    type: "text";
                } & {
                    prompt: string;
                } & {
                    commitMessage?: null | string;
                    config: unknown;
                    labels: string[];
                    name: string;
                    tags: string[];
                    version: number;
                };
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: {
                  type: "chat";
              } & {
                  prompt: {
                      content: string;
                      role: string;
                  }[];
              } & {
                  commitMessage?: null | string;
                  config: unknown;
                  labels: string[];
                  name: string;
                  tags: string[];
                  version: number;
              } | {
                  type: "text";
              } & {
                  prompt: string;
              } & {
                  commitMessage?: null | string;
                  config: unknown;
                  labels: string[];
                  name: string;
                  tags: string[];
                  version: number;
              };
          }
          • application/json: {
                type: "chat";
            } & {
                prompt: {
                    content: string;
                    role: string;
                }[];
            } & {
                commitMessage?: null | string;
                config: unknown;
                labels: string[];
                name: string;
                tags: string[];
                version: number;
            } | {
                type: "text";
            } & {
                prompt: string;
            } & {
                commitMessage?: null | string;
                config: unknown;
                labels: string[];
                name: string;
                tags: string[];
                version: number;
            }
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 400: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 401: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 403: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 404: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
      • 405: {
            content: {
                application/json: unknown;
            };
            headers: {
                [name: string]: unknown;
            };
        }
        • content: {
              application/json: unknown;
          }
          • application/json: unknown
        • headers: {
              [name: string]: unknown;
          }
          • [name: string]: unknown
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    }
    • Optionalcookie?: undefined
    • Optionalheader?: undefined
    • Optionalpath?: undefined
    • Optionalquery?: undefined
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined