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

interface paths {
    "/v1/annotation_configs": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: { cursor?: null | string; limit?: number };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: (
                                | {
                                    description?: null
                                    | string;
                                    id: string;
                                    name: string;
                                    optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                                    type: "CATEGORICAL";
                                    values: { label: ...; score?: ... }[];
                                }
                                | {
                                    description?: null
                                    | string;
                                    id: string;
                                    lower_bound?: null | number;
                                    name: string;
                                    optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                                    type: "CONTINUOUS";
                                    upper_bound?: null | number;
                                }
                                | {
                                    description?: null
                                    | string;
                                    id: string;
                                    name: string;
                                    type: "FREEFORM";
                                }
                            )[];
                            next_cursor: null
                            | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    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;
                        name: string;
                        optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                        type: "CATEGORICAL";
                        values: { label: string; score?: null | number }[];
                    }
                    | {
                        description?: null
                        | string;
                        lower_bound?: null | number;
                        name: string;
                        optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                        type: "CONTINUOUS";
                        upper_bound?: null | number;
                    }
                    | { description?: null
                    | string; name: string; type: "FREEFORM" };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: | {
                                description?: null
                                | string;
                                id: string;
                                name: string;
                                optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                                type: "CATEGORICAL";
                                values: { label: string; score?: (...) | (...) | (...) }[];
                            }
                            | {
                                description?: null
                                | string;
                                id: string;
                                lower_bound?: null | number;
                                name: string;
                                optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                                type: "CONTINUOUS";
                                upper_bound?: null | number;
                            }
                            | {
                                description?: null
                                | string;
                                id: string;
                                name: string;
                                type: "FREEFORM";
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/v1/annotation_configs/{config_id}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { config_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: | {
                                description?: null
                                | string;
                                id: string;
                                name: string;
                                optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                                type: "CATEGORICAL";
                                values: { label: string; score?: (...) | (...) | (...) }[];
                            }
                            | {
                                description?: null
                                | string;
                                id: string;
                                lower_bound?: null | number;
                                name: string;
                                optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                                type: "CONTINUOUS";
                                upper_bound?: null | number;
                            }
                            | {
                                description?: null
                                | string;
                                id: string;
                                name: string;
                                type: "FREEFORM";
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { config_id: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": | {
                        description?: null
                        | string;
                        name: string;
                        optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                        type: "CATEGORICAL";
                        values: { label: string; score?: null | number }[];
                    }
                    | {
                        description?: null
                        | string;
                        lower_bound?: null | number;
                        name: string;
                        optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                        type: "CONTINUOUS";
                        upper_bound?: null | number;
                    }
                    | { description?: null
                    | string; name: string; type: "FREEFORM" };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: | {
                                description?: null
                                | string;
                                id: string;
                                name: string;
                                optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                                type: "CATEGORICAL";
                                values: { label: string; score?: (...) | (...) | (...) }[];
                            }
                            | {
                                description?: null
                                | string;
                                id: string;
                                lower_bound?: null | number;
                                name: string;
                                optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                                type: "CONTINUOUS";
                                upper_bound?: null | number;
                            }
                            | {
                                description?: null
                                | string;
                                id: string;
                                name: string;
                                type: "FREEFORM";
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    };
    "/v1/annotation_configs/{config_identifier}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { config_identifier: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: | {
                                description?: null
                                | string;
                                id: string;
                                name: string;
                                optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                                type: "CATEGORICAL";
                                values: { label: string; score?: (...) | (...) | (...) }[];
                            }
                            | {
                                description?: null
                                | string;
                                id: string;
                                lower_bound?: null | number;
                                name: string;
                                optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                                type: "CONTINUOUS";
                                upper_bound?: null | number;
                            }
                            | {
                                description?: null
                                | string;
                                id: string;
                                name: string;
                                type: "FREEFORM";
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    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;
    };
    "/v1/datasets": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: { cursor?: null
                | string; limit?: number; name?: null | string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                created_at: string;
                                description: null
                                | string;
                                example_count: number;
                                id: string;
                                metadata: { [key: string]: unknown };
                                name: string;
                                updated_at: string;
                            }[];
                            next_cursor: null
                            | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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;
    };
    "/v1/datasets/{dataset_id}/experiments": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { dataset_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                created_at: string;
                                dataset_id: string;
                                dataset_version_id: string;
                                id: string;
                                metadata: { [key: string]: unknown };
                                project_name: null | string;
                                repetitions: number;
                                updated_at: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    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: { dataset_id: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        description?: null
                        | string;
                        metadata?: null | { [key: string]: unknown };
                        name?: null | string;
                        repetitions?: number;
                        version_id?: null | string;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                created_at: string;
                                dataset_id: string;
                                dataset_version_id: string;
                                id: string;
                                metadata: { [key: string]: unknown };
                                project_name: null | string;
                                repetitions: number;
                                updated_at: string;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/v1/datasets/{id}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "204": { content?: undefined; headers: { [name: string]: unknown } };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                created_at: string;
                                description: null
                                | string;
                                example_count: number;
                                id: string;
                                metadata: { [key: string]: unknown };
                                name: string;
                                updated_at: string;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    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;
    };
    "/v1/datasets/{id}/csv": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { id: string };
                query?: { version_id?: null | string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: { "text/csv": string };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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;
    };
    "/v1/datasets/{id}/examples": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { id: string };
                query?: { version_id?: null | string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                dataset_id: string;
                                examples: {
                                    id: string;
                                    input: { [key: string]: unknown };
                                    metadata: { [key: string]: unknown };
                                    output: { [key: string]: unknown };
                                    updated_at: string;
                                }[];
                                version_id: string;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    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;
    };
    "/v1/datasets/{id}/jsonl/openai_evals": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { id: string };
                query?: { version_id?: null | string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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;
    };
    "/v1/datasets/{id}/jsonl/openai_ft": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { id: string };
                query?: { version_id?: null | string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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;
    };
    "/v1/datasets/{id}/versions": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { id: string };
                query?: { cursor?: null | string; limit?: number };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                created_at: string;
                                description: null
                                | string;
                                metadata: { [key: string]: unknown };
                                version_id: string;
                            }[];
                            next_cursor: null
                            | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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;
    };
    "/v1/datasets/upload": {
        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?: { sync?: boolean };
            };
            requestBody?: {
                content: {
                    "application/json": {
                        action?: "create"
                        | "append";
                        description?: string;
                        inputs: Record<string, unknown>[];
                        metadata?: Record<string, unknown>[];
                        name: string;
                        outputs?: Record<string, unknown>[];
                    };
                    "multipart/form-data": {
                        action?: "create"
                        | "append";
                        description?: string;
                        file: string;
                        "input_keys[]": string[];
                        "metadata_keys[]"?: string[];
                        name: string;
                        "output_keys[]": string[];
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": | null
                        | { data: { dataset_id: string; version_id: string } };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "409": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/v1/evaluations": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: { project_name?: null
                | string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: { "application/json": unknown };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: {
                    "content-encoding"?: null
                    | string;
                    "content-type"?: null | string;
                };
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/x-pandas-arrow": string;
                    "application/x-protobuf": string;
                };
            };
            responses: {
                "204": { content?: undefined; headers: { [name: string]: unknown } };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "415": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/v1/experiment_evaluations": {
        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": {
                        annotator_kind: "LLM"
                        | "CODE"
                        | "HUMAN";
                        end_time: string;
                        error?: null | string;
                        experiment_run_id: string;
                        metadata?: null | { [key: string]: unknown };
                        name: string;
                        result?:
                            | null
                            | {
                                explanation?: null
                                | string;
                                label?: null | string;
                                score?: null | number;
                            };
                        start_time: string;
                        trace_id?: null
                        | string;
                    };
                };
            };
            responses: {
                "200": {
                    content: { "application/json": { data: { id: string } } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/v1/experiments/{experiment_id}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { experiment_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                created_at: string;
                                dataset_id: string;
                                dataset_version_id: string;
                                id: string;
                                metadata: { [key: string]: unknown };
                                project_name: null | string;
                                repetitions: number;
                                updated_at: string;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    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;
    };
    "/v1/experiments/{experiment_id}/csv": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { experiment_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: { "application/json": unknown; "text/csv": string };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    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;
    };
    "/v1/experiments/{experiment_id}/json": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { experiment_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    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;
    };
    "/v1/experiments/{experiment_id}/runs": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { experiment_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                dataset_example_id: string;
                                end_time: string;
                                error?: null
                                | string;
                                experiment_id: string;
                                id: string;
                                output: unknown;
                                repetition_number: number;
                                start_time: string;
                                trace_id?: null | string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    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: { experiment_id: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        dataset_example_id: string;
                        end_time: string;
                        error?: null
                        | string;
                        output: unknown;
                        repetition_number: number;
                        start_time: string;
                        trace_id?: null | string;
                    };
                };
            };
            responses: {
                "200": {
                    content: { "application/json": { data: { id: string } } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "409": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/v1/projects": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    cursor?: null
                    | string;
                    include_experiment_projects?: boolean;
                    limit?: number;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: { description?: null
                            | string; id: string; name: string }[];
                            next_cursor: null | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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; name: string };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: { description?: null
                            | string; id: string; name: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/v1/projects/{project_identifier}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { project_identifier: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "204": { content?: undefined; headers: { [name: string]: unknown } };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { project_identifier: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: { description?: null
                            | string; id: string; name: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { project_identifier: string };
                query?: undefined;
            };
            requestBody: {
                content: { "application/json": { description?: null
                | string } };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: { description?: null
                            | string; id: string; name: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    };
    "/v1/projects/{project_identifier}/span_annotations": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { project_identifier: string };
                query: {
                    cursor?: null | string;
                    exclude_annotation_names?: null | string[];
                    include_annotation_names?: null | string[];
                    limit?: number;
                    span_ids: string[];
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                annotator_kind: "LLM"
                                | "CODE"
                                | "HUMAN";
                                created_at: string;
                                id: string;
                                identifier?: string;
                                metadata?: null | { [key: string]: unknown };
                                name: string;
                                result?:
                                    | null
                                    | {
                                        explanation?: (...)
                                        | (...)
                                        | (...);
                                        label?: (...) | (...) | (...);
                                        score?: (...) | (...) | (...);
                                    };
                                source: "API"
                                | "APP";
                                span_id: string;
                                updated_at: string;
                                user_id: null | string;
                            }[];
                            next_cursor: null
                            | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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;
    };
    "/v1/projects/{project_identifier}/spans": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { project_identifier: string };
                query?: {
                    cursor?: null | string;
                    end_time?: null | string;
                    limit?: number;
                    start_time?: null | string;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                attributes?: { [key: string]: unknown };
                                context: { span_id: string; trace_id: string };
                                end_time: string;
                                events?: { attributes?: ...; name: ...; timestamp: ... }[];
                                id?: string;
                                name: string;
                                parent_id?: null | string;
                                span_kind: string;
                                start_time: string;
                                status_code: string;
                                status_message?: string;
                            }[];
                            next_cursor: null
                            | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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: { project_identifier: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        data: {
                            attributes?: { [key: string]: unknown };
                            context: { span_id: string; trace_id: string };
                            end_time: string;
                            events?: {
                                attributes?: (...) | (...);
                                name: string;
                                timestamp: string;
                            }[];
                            id?: string;
                            name: string;
                            parent_id?: null
                            | string;
                            span_kind: string;
                            start_time: string;
                            status_code: string;
                            status_message?: string;
                        }[];
                    };
                };
            };
            responses: {
                "202": {
                    content: {
                        "application/json": {
                            total_queued: number;
                            total_received: number;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/v1/projects/{project_identifier}/spans/otlpv1": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { project_identifier: string };
                query?: {
                    cursor?: null | string;
                    end_time?: null | string;
                    limit?: number;
                    start_time?: null | string;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                attributes?: null
                                | { key?: ...; value?: ... }[];
                                dropped_attributes_count?: null | number;
                                dropped_events_count?: null | number;
                                dropped_links_count?: null | number;
                                end_time_unix_nano?: null | string | number;
                                events?:
                                    | null
                                    | {
                                        attributes?: ...;
                                        dropped_attributes_count?: ...;
                                        name?: ...;
                                        time_unix_nano?: ...;
                                    }[];
                                flags?: null
                                | number;
                                kind?:
                                    | null
                                    | number
                                    | "SPAN_KIND_UNSPECIFIED"
                                    | "SPAN_KIND_INTERNAL"
                                    | "SPAN_KIND_SERVER"
                                    | "SPAN_KIND_CLIENT"
                                    | "SPAN_KIND_PRODUCER"
                                    | "SPAN_KIND_CONSUMER";
                                links?: null;
                                name?: null
                                | string;
                                parent_span_id?: null | string;
                                span_id?: null | string;
                                start_time_unix_nano?: null | string | number;
                                status?:
                                    | null
                                    | { code?: (...)
                                    | (...)
                                    | (...); message?: (...) | (...) | (...) };
                                trace_id?: null | string;
                                trace_state?: null | string;
                            }[];
                            next_cursor: null
                            | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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;
    };
    "/v1/prompt_versions/{prompt_version_id}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { prompt_version_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                description?: null
                                | string;
                                id: string;
                                invocation_parameters:
                                    | {
                                        anthropic: {
                                            max_tokens: number;
                                            stop_sequences?: (...)
                                            | (...);
                                            temperature?: (...) | (...);
                                            thinking?: (...) | (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "anthropic";
                                    }
                                    | {
                                        aws: {
                                            max_tokens?: (...)
                                            | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "aws";
                                    }
                                    | {
                                        azure_openai: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "azure_openai";
                                    }
                                    | {
                                        deepseek: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "deepseek";
                                    }
                                    | {
                                        google: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_output_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            stop_sequences?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_k?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "google";
                                    }
                                    | {
                                        ollama: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "ollama";
                                    }
                                    | {
                                        openai: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "openai";
                                    }
                                    | {
                                        type: "xai";
                                        xai: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                    };
                                model_name: string;
                                model_provider: | "OPENAI"
                                | "AZURE_OPENAI"
                                | "ANTHROPIC"
                                | "GOOGLE"
                                | "DEEPSEEK"
                                | "XAI"
                                | "OLLAMA"
                                | "AWS";
                                response_format?: | null
                                | {
                                    json_schema: {
                                        description?: (...)
                                        | (...);
                                        name: string;
                                        schema?: (...) | (...);
                                        strict?: (...) | (...) | (...);
                                    };
                                    type: "json_schema";
                                };
                                template: | {
                                    messages: { content: ...; role: ... }[];
                                    type: "chat";
                                }
                                | { template: string; type: "string" };
                                template_format: "NONE" | "MUSTACHE" | "F_STRING";
                                template_type: "STR" | "CHAT";
                                tools?:
                                    | null
                                    | {
                                        disable_parallel_tool_calls?: boolean;
                                        tool_choice?: | { type: ... }
                                        | { type: ... }
                                        | { function_name: ...; type: ... }
                                        | { type: ... };
                                        tools: { function: ...; type: ... }[];
                                        type: "tools";
                                    };
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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;
    };
    "/v1/prompt_versions/{prompt_version_id}/tags": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { prompt_version_id: string };
                query?: { cursor?: null | string; limit?: number };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: { description?: null
                            | string; id: string; name: string }[];
                            next_cursor: null | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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: { prompt_version_id: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": { description?: null
                    | string; name: string };
                };
            };
            responses: {
                "204": { content?: undefined; headers: { [name: string]: unknown } };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/v1/prompts": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: { cursor?: null
                | string; limit?: number };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                description?: null
                                | string;
                                id: string;
                                name: string;
                                source_prompt_id?: null | string;
                            }[];
                            next_cursor: null
                            | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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": {
                        prompt: {
                            description?: null
                            | string;
                            name: string;
                            source_prompt_id?: null | string;
                        };
                        version: {
                            description?: null
                            | string;
                            invocation_parameters:
                                | {
                                    anthropic: {
                                        max_tokens: number;
                                        stop_sequences?: (...)[];
                                        temperature?: number;
                                        thinking?: { type: ... } | { budget_tokens: ...; type: ... };
                                        top_p?: number;
                                    };
                                    type: "anthropic";
                                }
                                | {
                                    aws: {
                                        max_tokens?: number;
                                        temperature?: number;
                                        top_p?: number;
                                    };
                                    type: "aws";
                                }
                                | {
                                    azure_openai: {
                                        frequency_penalty?: number;
                                        max_completion_tokens?: number;
                                        max_tokens?: number;
                                        presence_penalty?: number;
                                        reasoning_effort?: "minimal"
                                        | "low"
                                        | "medium"
                                        | "high";
                                        seed?: number;
                                        temperature?: number;
                                        top_p?: number;
                                    };
                                    type: "azure_openai";
                                }
                                | {
                                    deepseek: {
                                        frequency_penalty?: number;
                                        max_completion_tokens?: number;
                                        max_tokens?: number;
                                        presence_penalty?: number;
                                        reasoning_effort?: "minimal"
                                        | "low"
                                        | "medium"
                                        | "high";
                                        seed?: number;
                                        temperature?: number;
                                        top_p?: number;
                                    };
                                    type: "deepseek";
                                }
                                | {
                                    google: {
                                        frequency_penalty?: number;
                                        max_output_tokens?: number;
                                        presence_penalty?: number;
                                        stop_sequences?: (...)[];
                                        temperature?: number;
                                        top_k?: number;
                                        top_p?: number;
                                    };
                                    type: "google";
                                }
                                | {
                                    ollama: {
                                        frequency_penalty?: number;
                                        max_completion_tokens?: number;
                                        max_tokens?: number;
                                        presence_penalty?: number;
                                        reasoning_effort?: "minimal"
                                        | "low"
                                        | "medium"
                                        | "high";
                                        seed?: number;
                                        temperature?: number;
                                        top_p?: number;
                                    };
                                    type: "ollama";
                                }
                                | {
                                    openai: {
                                        frequency_penalty?: number;
                                        max_completion_tokens?: number;
                                        max_tokens?: number;
                                        presence_penalty?: number;
                                        reasoning_effort?: "minimal"
                                        | "low"
                                        | "medium"
                                        | "high";
                                        seed?: number;
                                        temperature?: number;
                                        top_p?: number;
                                    };
                                    type: "openai";
                                }
                                | {
                                    type: "xai";
                                    xai: {
                                        frequency_penalty?: number;
                                        max_completion_tokens?: number;
                                        max_tokens?: number;
                                        presence_penalty?: number;
                                        reasoning_effort?: "minimal"
                                        | "low"
                                        | "medium"
                                        | "high";
                                        seed?: number;
                                        temperature?: number;
                                        top_p?: number;
                                    };
                                };
                            model_name: string;
                            model_provider: | "OPENAI"
                            | "AZURE_OPENAI"
                            | "ANTHROPIC"
                            | "GOOGLE"
                            | "DEEPSEEK"
                            | "XAI"
                            | "OLLAMA"
                            | "AWS";
                            response_format?: | null
                            | {
                                json_schema: {
                                    description?: string;
                                    name: string;
                                    schema?: { [key: ...]: ... };
                                    strict?: boolean;
                                };
                                type: "json_schema";
                            };
                            template: | {
                                messages: {
                                    content: (...)
                                    | (...);
                                    role: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                }[];
                                type: "chat";
                            }
                            | { template: string; type: "string" };
                            template_format: "NONE" | "MUSTACHE" | "F_STRING";
                            template_type: "STR" | "CHAT";
                            tools?:
                                | null
                                | {
                                    disable_parallel_tool_calls?: boolean;
                                    tool_choice?: | { type: "none" }
                                    | { type: "one_or_more" }
                                    | { function_name: string; type: "specific_function" }
                                    | { type: "zero_or_more" };
                                    tools: {
                                        function: {
                                            description?: ...;
                                            name: ...;
                                            parameters?: ...;
                                            strict?: ...;
                                        };
                                        type: "function";
                                    }[];
                                    type: "tools";
                                };
                        };
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                description?: null
                                | string;
                                id: string;
                                invocation_parameters:
                                    | {
                                        anthropic: {
                                            max_tokens: number;
                                            stop_sequences?: (...)
                                            | (...);
                                            temperature?: (...) | (...);
                                            thinking?: (...) | (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "anthropic";
                                    }
                                    | {
                                        aws: {
                                            max_tokens?: (...)
                                            | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "aws";
                                    }
                                    | {
                                        azure_openai: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "azure_openai";
                                    }
                                    | {
                                        deepseek: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "deepseek";
                                    }
                                    | {
                                        google: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_output_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            stop_sequences?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_k?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "google";
                                    }
                                    | {
                                        ollama: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "ollama";
                                    }
                                    | {
                                        openai: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "openai";
                                    }
                                    | {
                                        type: "xai";
                                        xai: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                    };
                                model_name: string;
                                model_provider: | "OPENAI"
                                | "AZURE_OPENAI"
                                | "ANTHROPIC"
                                | "GOOGLE"
                                | "DEEPSEEK"
                                | "XAI"
                                | "OLLAMA"
                                | "AWS";
                                response_format?: | null
                                | {
                                    json_schema: {
                                        description?: (...)
                                        | (...);
                                        name: string;
                                        schema?: (...) | (...);
                                        strict?: (...) | (...) | (...);
                                    };
                                    type: "json_schema";
                                };
                                template: | {
                                    messages: { content: ...; role: ... }[];
                                    type: "chat";
                                }
                                | { template: string; type: "string" };
                                template_format: "NONE" | "MUSTACHE" | "F_STRING";
                                template_type: "STR" | "CHAT";
                                tools?:
                                    | null
                                    | {
                                        disable_parallel_tool_calls?: boolean;
                                        tool_choice?: | { type: ... }
                                        | { type: ... }
                                        | { function_name: ...; type: ... }
                                        | { type: ... };
                                        tools: { function: ...; type: ... }[];
                                        type: "tools";
                                    };
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/v1/prompts/{prompt_identifier}/latest": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { prompt_identifier: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                description?: null
                                | string;
                                id: string;
                                invocation_parameters:
                                    | {
                                        anthropic: {
                                            max_tokens: number;
                                            stop_sequences?: (...)
                                            | (...);
                                            temperature?: (...) | (...);
                                            thinking?: (...) | (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "anthropic";
                                    }
                                    | {
                                        aws: {
                                            max_tokens?: (...)
                                            | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "aws";
                                    }
                                    | {
                                        azure_openai: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "azure_openai";
                                    }
                                    | {
                                        deepseek: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "deepseek";
                                    }
                                    | {
                                        google: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_output_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            stop_sequences?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_k?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "google";
                                    }
                                    | {
                                        ollama: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "ollama";
                                    }
                                    | {
                                        openai: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "openai";
                                    }
                                    | {
                                        type: "xai";
                                        xai: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                    };
                                model_name: string;
                                model_provider: | "OPENAI"
                                | "AZURE_OPENAI"
                                | "ANTHROPIC"
                                | "GOOGLE"
                                | "DEEPSEEK"
                                | "XAI"
                                | "OLLAMA"
                                | "AWS";
                                response_format?: | null
                                | {
                                    json_schema: {
                                        description?: (...)
                                        | (...);
                                        name: string;
                                        schema?: (...) | (...);
                                        strict?: (...) | (...) | (...);
                                    };
                                    type: "json_schema";
                                };
                                template: | {
                                    messages: { content: ...; role: ... }[];
                                    type: "chat";
                                }
                                | { template: string; type: "string" };
                                template_format: "NONE" | "MUSTACHE" | "F_STRING";
                                template_type: "STR" | "CHAT";
                                tools?:
                                    | null
                                    | {
                                        disable_parallel_tool_calls?: boolean;
                                        tool_choice?: | { type: ... }
                                        | { type: ... }
                                        | { function_name: ...; type: ... }
                                        | { type: ... };
                                        tools: { function: ...; type: ... }[];
                                        type: "tools";
                                    };
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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;
    };
    "/v1/prompts/{prompt_identifier}/tags/{tag_name}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { prompt_identifier: string; tag_name: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                description?: null
                                | string;
                                id: string;
                                invocation_parameters:
                                    | {
                                        anthropic: {
                                            max_tokens: number;
                                            stop_sequences?: (...)
                                            | (...);
                                            temperature?: (...) | (...);
                                            thinking?: (...) | (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "anthropic";
                                    }
                                    | {
                                        aws: {
                                            max_tokens?: (...)
                                            | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "aws";
                                    }
                                    | {
                                        azure_openai: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "azure_openai";
                                    }
                                    | {
                                        deepseek: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "deepseek";
                                    }
                                    | {
                                        google: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_output_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            stop_sequences?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_k?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "google";
                                    }
                                    | {
                                        ollama: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "ollama";
                                    }
                                    | {
                                        openai: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                        type: "openai";
                                    }
                                    | {
                                        type: "xai";
                                        xai: {
                                            frequency_penalty?: (...)
                                            | (...);
                                            max_completion_tokens?: (...) | (...);
                                            max_tokens?: (...) | (...);
                                            presence_penalty?: (...) | (...);
                                            reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                            seed?: (...) | (...);
                                            temperature?: (...) | (...);
                                            top_p?: (...) | (...);
                                        };
                                    };
                                model_name: string;
                                model_provider: | "OPENAI"
                                | "AZURE_OPENAI"
                                | "ANTHROPIC"
                                | "GOOGLE"
                                | "DEEPSEEK"
                                | "XAI"
                                | "OLLAMA"
                                | "AWS";
                                response_format?: | null
                                | {
                                    json_schema: {
                                        description?: (...)
                                        | (...);
                                        name: string;
                                        schema?: (...) | (...);
                                        strict?: (...) | (...) | (...);
                                    };
                                    type: "json_schema";
                                };
                                template: | {
                                    messages: { content: ...; role: ... }[];
                                    type: "chat";
                                }
                                | { template: string; type: "string" };
                                template_format: "NONE" | "MUSTACHE" | "F_STRING";
                                template_type: "STR" | "CHAT";
                                tools?:
                                    | null
                                    | {
                                        disable_parallel_tool_calls?: boolean;
                                        tool_choice?: | { type: ... }
                                        | { type: ... }
                                        | { function_name: ...; type: ... }
                                        | { type: ... };
                                        tools: { function: ...; type: ... }[];
                                        type: "tools";
                                    };
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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;
    };
    "/v1/prompts/{prompt_identifier}/versions": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { prompt_identifier: string };
                query?: { cursor?: null | string; limit?: number };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                description?: null
                                | string;
                                id: string;
                                invocation_parameters:
                                    | {
                                        anthropic: {
                                            max_tokens: ...;
                                            stop_sequences?: ...;
                                            temperature?: ...;
                                            thinking?: ...;
                                            top_p?: ...;
                                        };
                                        type: "anthropic";
                                    }
                                    | {
                                        aws: { max_tokens?: ...; temperature?: ...; top_p?: ... };
                                        type: "aws";
                                    }
                                    | {
                                        azure_openai: {
                                            frequency_penalty?: ...;
                                            max_completion_tokens?: ...;
                                            max_tokens?: ...;
                                            presence_penalty?: ...;
                                            reasoning_effort?: ...;
                                            seed?: ...;
                                            temperature?: ...;
                                            top_p?: ...;
                                        };
                                        type: "azure_openai";
                                    }
                                    | {
                                        deepseek: {
                                            frequency_penalty?: ...;
                                            max_completion_tokens?: ...;
                                            max_tokens?: ...;
                                            presence_penalty?: ...;
                                            reasoning_effort?: ...;
                                            seed?: ...;
                                            temperature?: ...;
                                            top_p?: ...;
                                        };
                                        type: "deepseek";
                                    }
                                    | {
                                        google: {
                                            frequency_penalty?: ...;
                                            max_output_tokens?: ...;
                                            presence_penalty?: ...;
                                            stop_sequences?: ...;
                                            temperature?: ...;
                                            top_k?: ...;
                                            top_p?: ...;
                                        };
                                        type: "google";
                                    }
                                    | {
                                        ollama: {
                                            frequency_penalty?: ...;
                                            max_completion_tokens?: ...;
                                            max_tokens?: ...;
                                            presence_penalty?: ...;
                                            reasoning_effort?: ...;
                                            seed?: ...;
                                            temperature?: ...;
                                            top_p?: ...;
                                        };
                                        type: "ollama";
                                    }
                                    | {
                                        openai: {
                                            frequency_penalty?: ...;
                                            max_completion_tokens?: ...;
                                            max_tokens?: ...;
                                            presence_penalty?: ...;
                                            reasoning_effort?: ...;
                                            seed?: ...;
                                            temperature?: ...;
                                            top_p?: ...;
                                        };
                                        type: "openai";
                                    }
                                    | {
                                        type: "xai";
                                        xai: {
                                            frequency_penalty?: ...;
                                            max_completion_tokens?: ...;
                                            max_tokens?: ...;
                                            presence_penalty?: ...;
                                            reasoning_effort?: ...;
                                            seed?: ...;
                                            temperature?: ...;
                                            top_p?: ...;
                                        };
                                    };
                                model_name: string;
                                model_provider: | "OPENAI"
                                | "AZURE_OPENAI"
                                | "ANTHROPIC"
                                | "GOOGLE"
                                | "DEEPSEEK"
                                | "XAI"
                                | "OLLAMA"
                                | "AWS";
                                response_format?: | null
                                | {
                                    json_schema: {
                                        description?: ...;
                                        name: ...;
                                        schema?: ...;
                                        strict?: ...;
                                    };
                                    type: "json_schema";
                                };
                                template: | { messages: (...)[]; type: "chat" }
                                | { template: string; type: "string" };
                                template_format: "NONE" | "MUSTACHE" | "F_STRING";
                                template_type: "STR" | "CHAT";
                                tools?:
                                    | null
                                    | {
                                        disable_parallel_tool_calls?: (...)
                                        | (...)
                                        | (...);
                                        tool_choice?: (...) | (...) | (...) | (...) | (...);
                                        tools: (...)[];
                                        type: "tools";
                                    };
                            }[];
                            next_cursor: null
                            | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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;
    };
    "/v1/span_annotations": {
        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?: { sync?: boolean };
            };
            requestBody: {
                content: {
                    "application/json": {
                        data: {
                            annotator_kind: "LLM"
                            | "CODE"
                            | "HUMAN";
                            identifier?: string;
                            metadata?: null | { [key: string]: unknown };
                            name: string;
                            result?:
                                | null
                                | {
                                    explanation?: null
                                    | string;
                                    label?: null | string;
                                    score?: null | number;
                                };
                            span_id: string;
                        }[];
                    };
                };
            };
            responses: {
                "200": {
                    content: { "application/json": { data: { id: string }[] } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/v1/spans/{span_identifier}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { span_identifier: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "204": { content?: undefined; headers: { [name: string]: unknown } };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/v1/traces/{trace_identifier}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { trace_identifier: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "204": { content?: undefined; headers: { [name: string]: unknown } };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/v1/users": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: { cursor?: string; limit?: number };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: (
                                | {
                                    auth_method: "LOCAL";
                                    created_at: string;
                                    email: string;
                                    id: string;
                                    password?: string;
                                    password_needs_reset: boolean;
                                    role: "SYSTEM"
                                    | "ADMIN"
                                    | "MEMBER";
                                    updated_at: string;
                                    username: string;
                                }
                                | {
                                    auth_method: "OAUTH2";
                                    created_at: string;
                                    email: string;
                                    id: string;
                                    oauth2_client_id?: string;
                                    oauth2_user_id?: string;
                                    profile_picture_url?: string;
                                    role: "SYSTEM"
                                    | "ADMIN"
                                    | "MEMBER";
                                    updated_at: string;
                                    username: string;
                                }
                            )[];
                            next_cursor: null
                            | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    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": {
                        send_welcome_email?: boolean;
                        user: | {
                            auth_method: "LOCAL";
                            email: string;
                            password?: string;
                            role: "SYSTEM"
                            | "ADMIN"
                            | "MEMBER";
                            username: string;
                        }
                        | {
                            auth_method: "OAUTH2";
                            email: string;
                            oauth2_client_id?: string;
                            oauth2_user_id?: string;
                            role: "SYSTEM"
                            | "ADMIN"
                            | "MEMBER";
                            username: string;
                        };
                    };
                };
            };
            responses: {
                "201": {
                    content: {
                        "application/json": {
                            data: | {
                                auth_method: "LOCAL";
                                created_at: string;
                                email: string;
                                id: string;
                                password?: string;
                                password_needs_reset: boolean;
                                role: "SYSTEM"
                                | "ADMIN"
                                | "MEMBER";
                                updated_at: string;
                                username: string;
                            }
                            | {
                                auth_method: "OAUTH2";
                                created_at: string;
                                email: string;
                                id: string;
                                oauth2_client_id?: string;
                                oauth2_user_id?: string;
                                profile_picture_url?: string;
                                role: "SYSTEM"
                                | "ADMIN"
                                | "MEMBER";
                                updated_at: string;
                                username: string;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "409": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/v1/users/{user_id}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { user_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "204": { content?: undefined; headers: { [name: string]: unknown } };
                "403": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "text/plain": string };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
}

Properties

"/v1/annotation_configs": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { cursor?: null | string; limit?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: (
                            | {
                                description?: null
                                | string;
                                id: string;
                                name: string;
                                optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                                type: "CATEGORICAL";
                                values: { label: ...; score?: ... }[];
                            }
                            | {
                                description?: null
                                | string;
                                id: string;
                                lower_bound?: null | number;
                                name: string;
                                optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                                type: "CONTINUOUS";
                                upper_bound?: null | number;
                            }
                            | {
                                description?: null
                                | string;
                                id: string;
                                name: string;
                                type: "FREEFORM";
                            }
                        )[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                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;
                    name: string;
                    optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                    type: "CATEGORICAL";
                    values: { label: string; score?: null | number }[];
                }
                | {
                    description?: null
                    | string;
                    lower_bound?: null | number;
                    name: string;
                    optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                    type: "CONTINUOUS";
                    upper_bound?: null | number;
                }
                | { description?: null
                | string; name: string; type: "FREEFORM" };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CATEGORICAL";
                            values: { label: string; score?: (...) | (...) | (...) }[];
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            lower_bound?: null | number;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CONTINUOUS";
                            upper_bound?: null | number;
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            type: "FREEFORM";
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { cursor?: null | string; limit?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: (
                            | {
                                description?: null
                                | string;
                                id: string;
                                name: string;
                                optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                                type: "CATEGORICAL";
                                values: { label: ...; score?: ... }[];
                            }
                            | {
                                description?: null
                                | string;
                                id: string;
                                lower_bound?: null | number;
                                name: string;
                                optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                                type: "CONTINUOUS";
                                upper_bound?: null | number;
                            }
                            | {
                                description?: null
                                | string;
                                id: string;
                                name: string;
                                type: "FREEFORM";
                            }
                        )[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    List annotation configurations

    Retrieve a paginated list of all annotation configurations in the system.

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

          Cursor for pagination (base64-encoded annotation config ID)

        • Optionallimit?: number

          Maximum number of configs to return

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: (
                          | {
                              description?: null
                              | string;
                              id: string;
                              name: string;
                              optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                              type: "CATEGORICAL";
                              values: { label: ...; score?: ... }[];
                          }
                          | {
                              description?: null
                              | string;
                              id: string;
                              lower_bound?: null | number;
                              name: string;
                              optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                              type: "CONTINUOUS";
                              upper_bound?: null | number;
                          }
                          | {
                              description?: null
                              | string;
                              id: string;
                              name: string;
                              type: "FREEFORM";
                          }
                      )[];
                      next_cursor: null
                      | string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: (
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CATEGORICAL";
                            values: { label: ...; score?: ... }[];
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            lower_bound?: null | number;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CONTINUOUS";
                            upper_bound?: null | number;
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            type: "FREEFORM";
                        }
                    )[];
                    next_cursor: null
                    | string;
                };
            };
            headers: { [name: string]: unknown };
        }

        A list of annotation configurations with pagination information

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": | {
                    description?: null
                    | string;
                    name: string;
                    optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                    type: "CATEGORICAL";
                    values: { label: string; score?: null | number }[];
                }
                | {
                    description?: null
                    | string;
                    lower_bound?: null | number;
                    name: string;
                    optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                    type: "CONTINUOUS";
                    upper_bound?: null | number;
                }
                | { description?: null
                | string; name: string; type: "FREEFORM" };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CATEGORICAL";
                            values: { label: string; score?: (...) | (...) | (...) }[];
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            lower_bound?: null | number;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CONTINUOUS";
                            upper_bound?: null | number;
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            type: "FREEFORM";
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Create an annotation configuration

    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • requestBody: {
          content: {
              "application/json":
                  | {
                      description?: null
                      | string;
                      name: string;
                      optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                      type: "CATEGORICAL";
                      values: { label: string; score?: null | number }[];
                  }
                  | {
                      description?: null
                      | string;
                      lower_bound?: null | number;
                      name: string;
                      optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                      type: "CONTINUOUS";
                      upper_bound?: null | number;
                  }
                  | { description?: null
                  | string; name: string; type: "FREEFORM" };
          };
      }
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data:
                          | {
                              description?: null
                              | string;
                              id: string;
                              name: string;
                              optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                              type: "CATEGORICAL";
                              values: { label: string; score?: (...) | (...) | (...) }[];
                          }
                          | {
                              description?: null
                              | string;
                              id: string;
                              lower_bound?: null | number;
                              name: string;
                              optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                              type: "CONTINUOUS";
                              upper_bound?: null | number;
                          }
                          | {
                              description?: null
                              | string;
                              id: string;
                              name: string;
                              type: "FREEFORM";
                          };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data:
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CATEGORICAL";
                            values: { label: string; score?: (...) | (...) | (...) }[];
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            lower_bound?: null | number;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CONTINUOUS";
                            upper_bound?: null | number;
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            type: "FREEFORM";
                        };
                };
            };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/annotation_configs/{config_id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { config_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CATEGORICAL";
                            values: { label: string; score?: (...) | (...) | (...) }[];
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            lower_bound?: null | number;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CONTINUOUS";
                            upper_bound?: null | number;
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            type: "FREEFORM";
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { config_id: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": | {
                    description?: null
                    | string;
                    name: string;
                    optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                    type: "CATEGORICAL";
                    values: { label: string; score?: null | number }[];
                }
                | {
                    description?: null
                    | string;
                    lower_bound?: null | number;
                    name: string;
                    optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                    type: "CONTINUOUS";
                    upper_bound?: null | number;
                }
                | { description?: null
                | string; name: string; type: "FREEFORM" };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CATEGORICAL";
                            values: { label: string; score?: (...) | (...) | (...) }[];
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            lower_bound?: null | number;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CONTINUOUS";
                            upper_bound?: null | number;
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            type: "FREEFORM";
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { config_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CATEGORICAL";
                            values: { label: string; score?: (...) | (...) | (...) }[];
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            lower_bound?: null | number;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CONTINUOUS";
                            upper_bound?: null | number;
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            type: "FREEFORM";
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Delete an annotation configuration

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

          ID of the annotation configuration

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data:
                          | {
                              description?: null
                              | string;
                              id: string;
                              name: string;
                              optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                              type: "CATEGORICAL";
                              values: { label: string; score?: (...) | (...) | (...) }[];
                          }
                          | {
                              description?: null
                              | string;
                              id: string;
                              lower_bound?: null | number;
                              name: string;
                              optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                              type: "CONTINUOUS";
                              upper_bound?: null | number;
                          }
                          | {
                              description?: null
                              | string;
                              id: string;
                              name: string;
                              type: "FREEFORM";
                          };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data:
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CATEGORICAL";
                            values: { label: string; score?: (...) | (...) | (...) }[];
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            lower_bound?: null | number;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CONTINUOUS";
                            upper_bound?: null | number;
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            type: "FREEFORM";
                        };
                };
            };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { config_id: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": | {
                    description?: null
                    | string;
                    name: string;
                    optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                    type: "CATEGORICAL";
                    values: { label: string; score?: null | number }[];
                }
                | {
                    description?: null
                    | string;
                    lower_bound?: null | number;
                    name: string;
                    optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                    type: "CONTINUOUS";
                    upper_bound?: null | number;
                }
                | { description?: null
                | string; name: string; type: "FREEFORM" };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CATEGORICAL";
                            values: { label: string; score?: (...) | (...) | (...) }[];
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            lower_bound?: null | number;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CONTINUOUS";
                            upper_bound?: null | number;
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            type: "FREEFORM";
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Update an annotation configuration

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

          ID of the annotation configuration

      • Optionalquery?: undefined
    • requestBody: {
          content: {
              "application/json":
                  | {
                      description?: null
                      | string;
                      name: string;
                      optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                      type: "CATEGORICAL";
                      values: { label: string; score?: null | number }[];
                  }
                  | {
                      description?: null
                      | string;
                      lower_bound?: null | number;
                      name: string;
                      optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                      type: "CONTINUOUS";
                      upper_bound?: null | number;
                  }
                  | { description?: null
                  | string; name: string; type: "FREEFORM" };
          };
      }
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data:
                          | {
                              description?: null
                              | string;
                              id: string;
                              name: string;
                              optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                              type: "CATEGORICAL";
                              values: { label: string; score?: (...) | (...) | (...) }[];
                          }
                          | {
                              description?: null
                              | string;
                              id: string;
                              lower_bound?: null | number;
                              name: string;
                              optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                              type: "CONTINUOUS";
                              upper_bound?: null | number;
                          }
                          | {
                              description?: null
                              | string;
                              id: string;
                              name: string;
                              type: "FREEFORM";
                          };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data:
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CATEGORICAL";
                            values: { label: string; score?: (...) | (...) | (...) }[];
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            lower_bound?: null | number;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CONTINUOUS";
                            upper_bound?: null | number;
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            type: "FREEFORM";
                        };
                };
            };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionaltrace?: undefined
"/v1/annotation_configs/{config_identifier}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { config_identifier: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CATEGORICAL";
                            values: { label: string; score?: (...) | (...) | (...) }[];
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            lower_bound?: null | number;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CONTINUOUS";
                            upper_bound?: null | number;
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            type: "FREEFORM";
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                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: { config_identifier: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CATEGORICAL";
                            values: { label: string; score?: (...) | (...) | (...) }[];
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            lower_bound?: null | number;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CONTINUOUS";
                            upper_bound?: null | number;
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            type: "FREEFORM";
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get an annotation configuration by ID or name

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

          ID or name of the annotation configuration

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data:
                          | {
                              description?: null
                              | string;
                              id: string;
                              name: string;
                              optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                              type: "CATEGORICAL";
                              values: { label: string; score?: (...) | (...) | (...) }[];
                          }
                          | {
                              description?: null
                              | string;
                              id: string;
                              lower_bound?: null | number;
                              name: string;
                              optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                              type: "CONTINUOUS";
                              upper_bound?: null | number;
                          }
                          | {
                              description?: null
                              | string;
                              id: string;
                              name: string;
                              type: "FREEFORM";
                          };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data:
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CATEGORICAL";
                            values: { label: string; score?: (...) | (...) | (...) }[];
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            lower_bound?: null | number;
                            name: string;
                            optimization_direction: "MINIMIZE" | "MAXIMIZE" | "NONE";
                            type: "CONTINUOUS";
                            upper_bound?: null | number;
                        }
                        | {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            type: "FREEFORM";
                        };
                };
            };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/datasets": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { cursor?: null | string; limit?: number; name?: null | string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            created_at: string;
                            description: null
                            | string;
                            example_count: number;
                            id: string;
                            metadata: { [key: string]: unknown };
                            name: string;
                            updated_at: string;
                        }[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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?: { cursor?: null | string; limit?: number; name?: null | string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            created_at: string;
                            description: null
                            | string;
                            example_count: number;
                            id: string;
                            metadata: { [key: string]: unknown };
                            name: string;
                            updated_at: string;
                        }[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    List datasets

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: { cursor?: null | string; limit?: number; name?: null | string };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: { cursor?: null | string; limit?: number; name?: null | string }
        • Optionalcursor?: null | string

          Cursor for pagination

        • Optionallimit?: number

          The max number of datasets to return at a time.

        • Optionalname?: null | string

          An optional dataset name to filter by

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          created_at: string;
                          description: null | string;
                          example_count: number;
                          id: string;
                          metadata: { [key: string]: unknown };
                          name: string;
                          updated_at: string;
                      }[];
                      next_cursor: null
                      | string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        created_at: string;
                        description: null | string;
                        example_count: number;
                        id: string;
                        metadata: { [key: string]: unknown };
                        name: string;
                        updated_at: string;
                    }[];
                    next_cursor: null
                    | string;
                };
            };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/datasets/{dataset_id}/experiments": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { dataset_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            created_at: string;
                            dataset_id: string;
                            dataset_version_id: string;
                            id: string;
                            metadata: { [key: string]: unknown };
                            project_name: null | string;
                            repetitions: number;
                            updated_at: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                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: { dataset_id: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    description?: null
                    | string;
                    metadata?: null | { [key: string]: unknown };
                    name?: null | string;
                    repetitions?: number;
                    version_id?: null | string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            created_at: string;
                            dataset_id: string;
                            dataset_version_id: string;
                            id: string;
                            metadata: { [key: string]: unknown };
                            project_name: null | string;
                            repetitions: number;
                            updated_at: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { dataset_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            created_at: string;
                            dataset_id: string;
                            dataset_version_id: string;
                            id: string;
                            metadata: { [key: string]: unknown };
                            project_name: null | string;
                            repetitions: number;
                            updated_at: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    List experiments by dataset

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { dataset_id: string };
          query?: undefined;
      }
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          created_at: string;
                          dataset_id: string;
                          dataset_version_id: string;
                          id: string;
                          metadata: { [key: string]: unknown };
                          project_name: null | string;
                          repetitions: number;
                          updated_at: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        created_at: string;
                        dataset_id: string;
                        dataset_version_id: string;
                        id: string;
                        metadata: { [key: string]: unknown };
                        project_name: null | string;
                        repetitions: number;
                        updated_at: string;
                    }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Experiments retrieved successfully

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { dataset_id: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    description?: null
                    | string;
                    metadata?: null | { [key: string]: unknown };
                    name?: null | string;
                    repetitions?: number;
                    version_id?: null | string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            created_at: string;
                            dataset_id: string;
                            dataset_version_id: string;
                            id: string;
                            metadata: { [key: string]: unknown };
                            project_name: null | string;
                            repetitions: number;
                            updated_at: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Create experiment on a dataset

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { dataset_id: string };
          query?: undefined;
      }
    • requestBody: {
          content: {
              "application/json": {
                  description?: null | string;
                  metadata?: null | { [key: string]: unknown };
                  name?: null | string;
                  repetitions?: number;
                  version_id?: null | string;
              };
          };
      }
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          created_at: string;
                          dataset_id: string;
                          dataset_version_id: string;
                          id: string;
                          metadata: { [key: string]: unknown };
                          project_name: null | string;
                          repetitions: number;
                          updated_at: string;
                      };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        created_at: string;
                        dataset_id: string;
                        dataset_version_id: string;
                        id: string;
                        metadata: { [key: string]: unknown };
                        project_name: null | string;
                        repetitions: number;
                        updated_at: string;
                    };
                };
            };
            headers: { [name: string]: unknown };
        }

        Experiment retrieved successfully

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Dataset or DatasetVersion not found

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/datasets/{id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            created_at: string;
                            description: null
                            | string;
                            example_count: number;
                            id: string;
                            metadata: { [key: string]: unknown };
                            name: string;
                            updated_at: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                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 } };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Delete dataset by ID

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

          The ID of the dataset to delete.

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "204": { content?: undefined; headers: { [name: string]: unknown } };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 204: { content?: undefined; headers: { [name: string]: unknown } }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Dataset not found

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Invalid dataset ID

  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            created_at: string;
                            description: null
                            | string;
                            example_count: number;
                            id: string;
                            metadata: { [key: string]: unknown };
                            name: string;
                            updated_at: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get dataset by ID

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

          The ID of the dataset

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          created_at: string;
                          description: null | string;
                          example_count: number;
                          id: string;
                          metadata: { [key: string]: unknown };
                          name: string;
                          updated_at: string;
                      };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        created_at: string;
                        description: null | string;
                        example_count: number;
                        id: string;
                        metadata: { [key: string]: unknown };
                        name: string;
                        updated_at: string;
                    };
                };
            };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/datasets/{id}/csv": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: { version_id?: null | string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "text/csv": string };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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?: { version_id?: null | string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "text/csv": string };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Download dataset examples as CSV file

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { id: string };
          query?: { version_id?: null | string };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { id: string }
        • id: string

          The ID of the dataset

      • Optionalquery?: { version_id?: null | string }
        • Optionalversion_id?: null | string

          The ID of the dataset version (if omitted, returns data from the latest version)

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: { "text/csv": string };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: { content: { "text/csv": string }; headers: { [name: string]: unknown } }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/datasets/{id}/examples": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: { version_id?: null | string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            dataset_id: string;
                            examples: {
                                id: string;
                                input: { [key: string]: unknown };
                                metadata: { [key: string]: unknown };
                                output: { [key: string]: unknown };
                                updated_at: string;
                            }[];
                            version_id: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                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?: { version_id?: null | string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            dataset_id: string;
                            examples: {
                                id: string;
                                input: { [key: string]: unknown };
                                metadata: { [key: string]: unknown };
                                output: { [key: string]: unknown };
                                updated_at: string;
                            }[];
                            version_id: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get examples from a dataset

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { id: string };
          query?: { version_id?: null | string };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { id: string }
        • id: string

          The ID of the dataset

      • Optionalquery?: { version_id?: null | string }
        • Optionalversion_id?: null | string

          The ID of the dataset version (if omitted, returns data from the latest version)

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          dataset_id: string;
                          examples: {
                              id: string;
                              input: { [key: string]: unknown };
                              metadata: { [key: string]: unknown };
                              output: { [key: string]: unknown };
                              updated_at: string;
                          }[];
                          version_id: string;
                      };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        dataset_id: string;
                        examples: {
                            id: string;
                            input: { [key: string]: unknown };
                            metadata: { [key: string]: unknown };
                            output: { [key: string]: unknown };
                            updated_at: string;
                        }[];
                        version_id: string;
                    };
                };
            };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/datasets/{id}/jsonl/openai_evals": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: { version_id?: null | string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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?: { version_id?: null | string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Download dataset examples as OpenAI evals JSONL file

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { id: string };
          query?: { version_id?: null | string };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { id: string }
        • id: string

          The ID of the dataset

      • Optionalquery?: { version_id?: null | string }
        • Optionalversion_id?: null | string

          The ID of the dataset version (if omitted, returns data from the latest version)

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Invalid dataset or version ID

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/datasets/{id}/jsonl/openai_ft": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: { version_id?: null | string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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?: { version_id?: null | string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Download dataset examples as OpenAI fine-tuning JSONL file

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { id: string };
          query?: { version_id?: null | string };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { id: string }
        • id: string

          The ID of the dataset

      • Optionalquery?: { version_id?: null | string }
        • Optionalversion_id?: null | string

          The ID of the dataset version (if omitted, returns data from the latest version)

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Invalid dataset or version ID

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/datasets/{id}/versions": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: { cursor?: null | string; limit?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            created_at: string;
                            description: null
                            | string;
                            metadata: { [key: string]: unknown };
                            version_id: string;
                        }[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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?: { cursor?: null | string; limit?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            created_at: string;
                            description: null
                            | string;
                            metadata: { [key: string]: unknown };
                            version_id: string;
                        }[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    List dataset versions

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { id: string };
          query?: { cursor?: null | string; limit?: number };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { id: string }
        • id: string

          The ID of the dataset

      • Optionalquery?: { cursor?: null | string; limit?: number }
        • Optionalcursor?: null | string

          Cursor for pagination

        • Optionallimit?: number

          The max number of dataset versions to return at a time

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          created_at: string;
                          description: null | string;
                          metadata: { [key: string]: unknown };
                          version_id: string;
                      }[];
                      next_cursor: null
                      | string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        created_at: string;
                        description: null | string;
                        metadata: { [key: string]: unknown };
                        version_id: string;
                    }[];
                    next_cursor: null
                    | string;
                };
            };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/datasets/upload": {
    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?: { sync?: boolean };
        };
        requestBody?: {
            content: {
                "application/json": {
                    action?: "create"
                    | "append";
                    description?: string;
                    inputs: Record<string, unknown>[];
                    metadata?: Record<string, unknown>[];
                    name: string;
                    outputs?: Record<string, unknown>[];
                };
                "multipart/form-data": {
                    action?: "create"
                    | "append";
                    description?: string;
                    file: string;
                    "input_keys[]": string[];
                    "metadata_keys[]"?: string[];
                    name: string;
                    "output_keys[]": string[];
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": | null
                    | { data: { dataset_id: string; version_id: string } };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "409": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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 }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { sync?: boolean };
        };
        requestBody?: {
            content: {
                "application/json": {
                    action?: "create"
                    | "append";
                    description?: string;
                    inputs: Record<string, unknown>[];
                    metadata?: Record<string, unknown>[];
                    name: string;
                    outputs?: Record<string, unknown>[];
                };
                "multipart/form-data": {
                    action?: "create"
                    | "append";
                    description?: string;
                    file: string;
                    "input_keys[]": string[];
                    "metadata_keys[]"?: string[];
                    name: string;
                    "output_keys[]": string[];
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": | null
                    | { data: { dataset_id: string; version_id: string } };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "409": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Upload dataset from JSON, CSV, or PyArrow

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: { sync?: boolean };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: { sync?: boolean }
        • Optionalsync?: boolean

          If true, fulfill request synchronously and return JSON containing dataset_id.

    • OptionalrequestBody?: {
          content: {
              "application/json": {
                  action?: "create" | "append";
                  description?: string;
                  inputs: Record<string, unknown>[];
                  metadata?: Record<string, unknown>[];
                  name: string;
                  outputs?: Record<string, unknown>[];
              };
              "multipart/form-data": {
                  action?: "create"
                  | "append";
                  description?: string;
                  file: string;
                  "input_keys[]": string[];
                  "metadata_keys[]"?: string[];
                  name: string;
                  "output_keys[]": string[];
              };
          };
      }
    • responses: {
          "200": {
              content: {
                  "application/json":
                      | null
                      | { data: { dataset_id: string; version_id: string } };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "409": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json":
                    | null
                    | { data: { dataset_id: string; version_id: string } };
            };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 409: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Dataset of the same name already exists

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Invalid request body

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/evaluations": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { project_name?: null | string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: {
                "content-encoding"?: null
                | string;
                "content-type"?: null | string;
            };
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/x-pandas-arrow": string;
                "application/x-protobuf": string;
            };
        };
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "415": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { project_name?: null | string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get span, trace, or document evaluations from a project

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: { project_name?: null | string };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: { project_name?: null | string }
        • Optionalproject_name?: null | string

          The name of the project to get evaluations from (if omitted, evaluations will be drawn from the default project)

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: { "application/json": unknown };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: { "application/json": unknown };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: {
                "content-encoding"?: null | string;
                "content-type"?: null | string;
            };
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/x-pandas-arrow": string;
                "application/x-protobuf": string;
            };
        };
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "415": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Add span, trace, or document evaluations

    • parameters: {
          cookie?: undefined;
          header?: {
              "content-encoding"?: null | string;
              "content-type"?: null | string;
          };
          path?: undefined;
          query?: undefined;
      }
    • requestBody: {
          content: {
              "application/x-pandas-arrow": string;
              "application/x-protobuf": string;
          };
      }
    • responses: {
          "204": { content?: undefined; headers: { [name: string]: unknown } };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "415": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 204: { content?: undefined; headers: { [name: string]: unknown } }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 415: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unsupported content type, only gzipped protobuf and pandas-arrow are supported

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/experiment_evaluations": {
    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": {
                    annotator_kind: "LLM"
                    | "CODE"
                    | "HUMAN";
                    end_time: string;
                    error?: null | string;
                    experiment_run_id: string;
                    metadata?: null | { [key: string]: unknown };
                    name: string;
                    result?:
                        | null
                        | {
                            explanation?: null
                            | string;
                            label?: null | string;
                            score?: null | number;
                        };
                    start_time: string;
                    trace_id?: null
                    | string;
                };
            };
        };
        responses: {
            "200": {
                content: { "application/json": { data: { id: string } } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                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 }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    annotator_kind: "LLM"
                    | "CODE"
                    | "HUMAN";
                    end_time: string;
                    error?: null | string;
                    experiment_run_id: string;
                    metadata?: null | { [key: string]: unknown };
                    name: string;
                    result?:
                        | null
                        | {
                            explanation?: null
                            | string;
                            label?: null | string;
                            score?: null | number;
                        };
                    start_time: string;
                    trace_id?: null
                    | string;
                };
            };
        };
        responses: {
            "200": {
                content: { "application/json": { data: { id: string } } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Create or update evaluation for an experiment run

    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • requestBody: {
          content: {
              "application/json": {
                  annotator_kind: "LLM" | "CODE" | "HUMAN";
                  end_time: string;
                  error?: null | string;
                  experiment_run_id: string;
                  metadata?: null | { [key: string]: unknown };
                  name: string;
                  result?:
                      | null
                      | {
                          explanation?: null
                          | string;
                          label?: null | string;
                          score?: null | number;
                      };
                  start_time: string;
                  trace_id?: null
                  | string;
              };
          };
      }
    • responses: {
          "200": {
              content: { "application/json": { data: { id: string } } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: { "application/json": { data: { id: string } } };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Experiment run not found

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/experiments/{experiment_id}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { experiment_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            created_at: string;
                            dataset_id: string;
                            dataset_version_id: string;
                            id: string;
                            metadata: { [key: string]: unknown };
                            project_name: null | string;
                            repetitions: number;
                            updated_at: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                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: { experiment_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            created_at: string;
                            dataset_id: string;
                            dataset_version_id: string;
                            id: string;
                            metadata: { [key: string]: unknown };
                            project_name: null | string;
                            repetitions: number;
                            updated_at: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get experiment by ID

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { experiment_id: string };
          query?: undefined;
      }
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          created_at: string;
                          dataset_id: string;
                          dataset_version_id: string;
                          id: string;
                          metadata: { [key: string]: unknown };
                          project_name: null | string;
                          repetitions: number;
                          updated_at: string;
                      };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        created_at: string;
                        dataset_id: string;
                        dataset_version_id: string;
                        id: string;
                        metadata: { [key: string]: unknown };
                        project_name: null | string;
                        repetitions: number;
                        updated_at: string;
                    };
                };
            };
            headers: { [name: string]: unknown };
        }

        Experiment retrieved successfully

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Experiment not found

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/experiments/{experiment_id}/csv": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { experiment_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown; "text/csv": string };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                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: { experiment_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown; "text/csv": string };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Download experiment runs as a CSV file

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { experiment_id: string };
          query?: undefined;
      }
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: { "application/json": unknown; "text/csv": string };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: { "application/json": unknown; "text/csv": string };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/experiments/{experiment_id}/json": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { experiment_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                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: { experiment_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Download experiment runs as a JSON file

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { experiment_id: string };
          query?: undefined;
      }
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Experiment not found

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/experiments/{experiment_id}/runs": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { experiment_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            dataset_example_id: string;
                            end_time: string;
                            error?: null
                            | string;
                            experiment_id: string;
                            id: string;
                            output: unknown;
                            repetition_number: number;
                            start_time: string;
                            trace_id?: null | string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                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: { experiment_id: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    dataset_example_id: string;
                    end_time: string;
                    error?: null
                    | string;
                    output: unknown;
                    repetition_number: number;
                    start_time: string;
                    trace_id?: null | string;
                };
            };
        };
        responses: {
            "200": {
                content: { "application/json": { data: { id: string } } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "409": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { experiment_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            dataset_example_id: string;
                            end_time: string;
                            error?: null
                            | string;
                            experiment_id: string;
                            id: string;
                            output: unknown;
                            repetition_number: number;
                            start_time: string;
                            trace_id?: null | string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    List runs for an experiment

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { experiment_id: string };
          query?: undefined;
      }
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          dataset_example_id: string;
                          end_time: string;
                          error?: null | string;
                          experiment_id: string;
                          id: string;
                          output: unknown;
                          repetition_number: number;
                          start_time: string;
                          trace_id?: null | string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        dataset_example_id: string;
                        end_time: string;
                        error?: null | string;
                        experiment_id: string;
                        id: string;
                        output: unknown;
                        repetition_number: number;
                        start_time: string;
                        trace_id?: null | string;
                    }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Experiment runs retrieved successfully

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Experiment not found

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { experiment_id: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    dataset_example_id: string;
                    end_time: string;
                    error?: null
                    | string;
                    output: unknown;
                    repetition_number: number;
                    start_time: string;
                    trace_id?: null | string;
                };
            };
        };
        responses: {
            "200": {
                content: { "application/json": { data: { id: string } } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "409": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Create run for an experiment

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { experiment_id: string };
          query?: undefined;
      }
    • requestBody: {
          content: {
              "application/json": {
                  dataset_example_id: string;
                  end_time: string;
                  error?: null | string;
                  output: unknown;
                  repetition_number: number;
                  start_time: string;
                  trace_id?: null | string;
              };
          };
      }
    • responses: {
          "200": {
              content: { "application/json": { data: { id: string } } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "409": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: { "application/json": { data: { id: string } } };
            headers: { [name: string]: unknown };
        }

        Experiment run created successfully

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Experiment or dataset example not found

      • 409: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        This experiment run has already been submitted

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/projects": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                cursor?: null | string;
                include_experiment_projects?: boolean;
                limit?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: { description?: null
                        | string; id: string; name: string }[];
                        next_cursor: null | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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; name: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: { description?: null
                        | string; id: string; name: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                cursor?: null | string;
                include_experiment_projects?: boolean;
                limit?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: { description?: null
                        | string; id: string; name: string }[];
                        next_cursor: null | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    List all projects

    Retrieve a paginated list of all projects in the system.

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: {
              cursor?: null | string;
              include_experiment_projects?: boolean;
              limit?: number;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: {
            cursor?: null | string;
            include_experiment_projects?: boolean;
            limit?: number;
        }
        • Optionalcursor?: null | string

          Cursor for pagination (project ID)

        • Optionalinclude_experiment_projects?: boolean

          Include experiment projects in the response. Experiment projects are created from running experiments.

        • Optionallimit?: number

          The max number of projects to return at a time.

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: { description?: null | string; id: string; name: string }[];
                      next_cursor: null | string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: { description?: null | string; id: string; name: string }[];
                    next_cursor: null | string;
                };
            };
            headers: { [name: string]: unknown };
        }

        A list of projects with pagination information

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": { description?: null
                | string; name: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: { description?: null
                        | string; id: string; name: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Create a new project

    Create a new project with the specified configuration.

    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • requestBody: {
          content: {
              "application/json": { description?: null | string; name: string };
          };
      }
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: { description?: null | string; id: string; name: string };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: { description?: null | string; id: string; name: string };
                };
            };
            headers: { [name: string]: unknown };
        }

        The newly created project

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/projects/{project_identifier}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { project_identifier: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { project_identifier: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: { description?: null
                        | string; id: string; name: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { project_identifier: string };
            query?: undefined;
        };
        requestBody: {
            content: { "application/json": { description?: null
            | string } };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: { description?: null
                        | string; id: string; name: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    };
    trace?: undefined;
}

Type declaration

  • delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { project_identifier: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Delete a project by ID or name

    Delete an existing project and all its associated data. The project identifier is either project ID or project name. The default project cannot be deleted. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

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

          The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "204": { content?: undefined; headers: { [name: string]: unknown } };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 204: { content?: undefined; headers: { [name: string]: unknown } }

        No content returned on successful deletion

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { project_identifier: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: { description?: null
                        | string; id: string; name: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get project by ID or name

    Retrieve a specific project using its unique identifier: either project ID or project name. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

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

          The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: { description?: null | string; id: string; name: string };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: { description?: null | string; id: string; name: string };
                };
            };
            headers: { [name: string]: unknown };
        }

        The requested project

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { project_identifier: string };
            query?: undefined;
        };
        requestBody: {
            content: { "application/json": { description?: null
            | string } };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: { description?: null
                        | string; id: string; name: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Update a project by ID or name

    Update an existing project with new configuration. Project names cannot be changed. The project identifier is either project ID or project name. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

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

          The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

      • Optionalquery?: undefined
    • requestBody: { content: { "application/json": { description?: null | string } } }
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: { description?: null | string; id: string; name: string };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: { description?: null | string; id: string; name: string };
                };
            };
            headers: { [name: string]: unknown };
        }

        The updated project

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionaltrace?: undefined
"/v1/projects/{project_identifier}/span_annotations": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { project_identifier: string };
            query: {
                cursor?: null | string;
                exclude_annotation_names?: null | string[];
                include_annotation_names?: null | string[];
                limit?: number;
                span_ids: string[];
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            annotator_kind: "LLM"
                            | "CODE"
                            | "HUMAN";
                            created_at: string;
                            id: string;
                            identifier?: string;
                            metadata?: null | { [key: string]: unknown };
                            name: string;
                            result?:
                                | null
                                | {
                                    explanation?: (...)
                                    | (...)
                                    | (...);
                                    label?: (...) | (...) | (...);
                                    score?: (...) | (...) | (...);
                                };
                            source: "API"
                            | "APP";
                            span_id: string;
                            updated_at: string;
                            user_id: null | string;
                        }[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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: { project_identifier: string };
            query: {
                cursor?: null | string;
                exclude_annotation_names?: null | string[];
                include_annotation_names?: null | string[];
                limit?: number;
                span_ids: string[];
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            annotator_kind: "LLM"
                            | "CODE"
                            | "HUMAN";
                            created_at: string;
                            id: string;
                            identifier?: string;
                            metadata?: null | { [key: string]: unknown };
                            name: string;
                            result?:
                                | null
                                | {
                                    explanation?: (...)
                                    | (...)
                                    | (...);
                                    label?: (...) | (...) | (...);
                                    score?: (...) | (...) | (...);
                                };
                            source: "API"
                            | "APP";
                            span_id: string;
                            updated_at: string;
                            user_id: null | string;
                        }[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get span annotations for a list of span_ids.

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { project_identifier: string };
          query: {
              cursor?: null | string;
              exclude_annotation_names?: null | string[];
              include_annotation_names?: null | string[];
              limit?: number;
              span_ids: string[];
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { project_identifier: string }
        • project_identifier: string

          The project identifier: either project ID or project name. If using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

      • query: {
            cursor?: null | string;
            exclude_annotation_names?: null | string[];
            include_annotation_names?: null | string[];
            limit?: number;
            span_ids: string[];
        }
        • Optionalcursor?: null | string

          A cursor for pagination

        • Optionalexclude_annotation_names?: null | string[]

          Optional list of annotation names to exclude from results.

        • Optionalinclude_annotation_names?: null | string[]

          Optional list of annotation names to include. If provided, only annotations with these names will be returned. 'note' annotations are excluded by default unless explicitly included in this list.

        • Optionallimit?: number

          The maximum number of annotations to return in a single request

        • span_ids: string[]

          One or more span id to fetch annotations for

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          annotator_kind: "LLM" | "CODE" | "HUMAN";
                          created_at: string;
                          id: string;
                          identifier?: string;
                          metadata?: null | { [key: string]: unknown };
                          name: string;
                          result?:
                              | null
                              | {
                                  explanation?: (...)
                                  | (...)
                                  | (...);
                                  label?: (...) | (...) | (...);
                                  score?: (...) | (...) | (...);
                              };
                          source: "API"
                          | "APP";
                          span_id: string;
                          updated_at: string;
                          user_id: null | string;
                      }[];
                      next_cursor: null
                      | string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        annotator_kind: "LLM" | "CODE" | "HUMAN";
                        created_at: string;
                        id: string;
                        identifier?: string;
                        metadata?: null | { [key: string]: unknown };
                        name: string;
                        result?:
                            | null
                            | {
                                explanation?: (...)
                                | (...)
                                | (...);
                                label?: (...) | (...) | (...);
                                score?: (...) | (...) | (...);
                            };
                        source: "API"
                        | "APP";
                        span_id: string;
                        updated_at: string;
                        user_id: null | string;
                    }[];
                    next_cursor: null
                    | string;
                };
            };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Project or spans not found

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Invalid parameters

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/projects/{project_identifier}/spans": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { project_identifier: string };
            query?: {
                cursor?: null | string;
                end_time?: null | string;
                limit?: number;
                start_time?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            attributes?: { [key: string]: unknown };
                            context: { span_id: string; trace_id: string };
                            end_time: string;
                            events?: { attributes?: ...; name: ...; timestamp: ... }[];
                            id?: string;
                            name: string;
                            parent_id?: null | string;
                            span_kind: string;
                            start_time: string;
                            status_code: string;
                            status_message?: string;
                        }[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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: { project_identifier: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    data: {
                        attributes?: { [key: string]: unknown };
                        context: { span_id: string; trace_id: string };
                        end_time: string;
                        events?: {
                            attributes?: (...) | (...);
                            name: string;
                            timestamp: string;
                        }[];
                        id?: string;
                        name: string;
                        parent_id?: null
                        | string;
                        span_kind: string;
                        start_time: string;
                        status_code: string;
                        status_message?: string;
                    }[];
                };
            };
        };
        responses: {
            "202": {
                content: {
                    "application/json": { total_queued: number; total_received: number };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { project_identifier: string };
            query?: {
                cursor?: null | string;
                end_time?: null | string;
                limit?: number;
                start_time?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            attributes?: { [key: string]: unknown };
                            context: { span_id: string; trace_id: string };
                            end_time: string;
                            events?: { attributes?: ...; name: ...; timestamp: ... }[];
                            id?: string;
                            name: string;
                            parent_id?: null | string;
                            span_kind: string;
                            start_time: string;
                            status_code: string;
                            status_message?: string;
                        }[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    List spans with simple filters (no DSL)

    Return spans within a project filtered by time range. Supports cursor-based pagination.

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { project_identifier: string };
          query?: {
              cursor?: null | string;
              end_time?: null | string;
              limit?: number;
              start_time?: null | string;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { project_identifier: string }
        • project_identifier: string

          The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

      • Optionalquery?: {
            cursor?: null | string;
            end_time?: null | string;
            limit?: number;
            start_time?: null | string;
        }
        • Optionalcursor?: null | string

          Pagination cursor (Span Global ID)

        • Optionalend_time?: null | string

          Exclusive upper bound time

        • Optionallimit?: number

          Maximum number of spans to return

        • Optionalstart_time?: null | string

          Inclusive lower bound time

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          attributes?: { [key: string]: unknown };
                          context: { span_id: string; trace_id: string };
                          end_time: string;
                          events?: { attributes?: ...; name: ...; timestamp: ... }[];
                          id?: string;
                          name: string;
                          parent_id?: null | string;
                          span_kind: string;
                          start_time: string;
                          status_code: string;
                          status_message?: string;
                      }[];
                      next_cursor: null
                      | string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        attributes?: { [key: string]: unknown };
                        context: { span_id: string; trace_id: string };
                        end_time: string;
                        events?: { attributes?: ...; name: ...; timestamp: ... }[];
                        id?: string;
                        name: string;
                        parent_id?: null | string;
                        span_kind: string;
                        start_time: string;
                        status_code: string;
                        status_message?: string;
                    }[];
                    next_cursor: null
                    | string;
                };
            };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { project_identifier: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    data: {
                        attributes?: { [key: string]: unknown };
                        context: { span_id: string; trace_id: string };
                        end_time: string;
                        events?: {
                            attributes?: (...) | (...);
                            name: string;
                            timestamp: string;
                        }[];
                        id?: string;
                        name: string;
                        parent_id?: null
                        | string;
                        span_kind: string;
                        start_time: string;
                        status_code: string;
                        status_message?: string;
                    }[];
                };
            };
        };
        responses: {
            "202": {
                content: {
                    "application/json": { total_queued: number; total_received: number };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Create spans

    Submit spans to be inserted into a project. If any spans are invalid or duplicates, no spans will be inserted.

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

          The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

      • Optionalquery?: undefined
    • requestBody: {
          content: {
              "application/json": {
                  data: {
                      attributes?: { [key: string]: unknown };
                      context: { span_id: string; trace_id: string };
                      end_time: string;
                      events?: { attributes?: (...) | (...); name: string; timestamp: string }[];
                      id?: string;
                      name: string;
                      parent_id?: null | string;
                      span_kind: string;
                      start_time: string;
                      status_code: string;
                      status_message?: string;
                  }[];
              };
          };
      }
    • responses: {
          "202": {
              content: {
                  "application/json": { total_queued: number; total_received: number };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 202: {
            content: {
                "application/json": { total_queued: number; total_received: number };
            };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 400: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Bad Request

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/projects/{project_identifier}/spans/otlpv1": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { project_identifier: string };
            query?: {
                cursor?: null | string;
                end_time?: null | string;
                limit?: number;
                start_time?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            attributes?: null
                            | { key?: ...; value?: ... }[];
                            dropped_attributes_count?: null | number;
                            dropped_events_count?: null | number;
                            dropped_links_count?: null | number;
                            end_time_unix_nano?: null | string | number;
                            events?:
                                | null
                                | {
                                    attributes?: ...;
                                    dropped_attributes_count?: ...;
                                    name?: ...;
                                    time_unix_nano?: ...;
                                }[];
                            flags?: null
                            | number;
                            kind?:
                                | null
                                | number
                                | "SPAN_KIND_UNSPECIFIED"
                                | "SPAN_KIND_INTERNAL"
                                | "SPAN_KIND_SERVER"
                                | "SPAN_KIND_CLIENT"
                                | "SPAN_KIND_PRODUCER"
                                | "SPAN_KIND_CONSUMER";
                            links?: null;
                            name?: null
                            | string;
                            parent_span_id?: null | string;
                            span_id?: null | string;
                            start_time_unix_nano?: null | string | number;
                            status?:
                                | null
                                | { code?: (...)
                                | (...)
                                | (...); message?: (...) | (...) | (...) };
                            trace_id?: null | string;
                            trace_state?: null | string;
                        }[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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: { project_identifier: string };
            query?: {
                cursor?: null | string;
                end_time?: null | string;
                limit?: number;
                start_time?: null | string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            attributes?: null
                            | { key?: ...; value?: ... }[];
                            dropped_attributes_count?: null | number;
                            dropped_events_count?: null | number;
                            dropped_links_count?: null | number;
                            end_time_unix_nano?: null | string | number;
                            events?:
                                | null
                                | {
                                    attributes?: ...;
                                    dropped_attributes_count?: ...;
                                    name?: ...;
                                    time_unix_nano?: ...;
                                }[];
                            flags?: null
                            | number;
                            kind?:
                                | null
                                | number
                                | "SPAN_KIND_UNSPECIFIED"
                                | "SPAN_KIND_INTERNAL"
                                | "SPAN_KIND_SERVER"
                                | "SPAN_KIND_CLIENT"
                                | "SPAN_KIND_PRODUCER"
                                | "SPAN_KIND_CONSUMER";
                            links?: null;
                            name?: null
                            | string;
                            parent_span_id?: null | string;
                            span_id?: null | string;
                            start_time_unix_nano?: null | string | number;
                            status?:
                                | null
                                | { code?: (...)
                                | (...)
                                | (...); message?: (...) | (...) | (...) };
                            trace_id?: null | string;
                            trace_state?: null | string;
                        }[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Search spans with simple filters (no DSL)

    Return spans within a project filtered by time range. Supports cursor-based pagination.

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { project_identifier: string };
          query?: {
              cursor?: null | string;
              end_time?: null | string;
              limit?: number;
              start_time?: null | string;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { project_identifier: string }
        • project_identifier: string

          The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

      • Optionalquery?: {
            cursor?: null | string;
            end_time?: null | string;
            limit?: number;
            start_time?: null | string;
        }
        • Optionalcursor?: null | string

          Pagination cursor (Span Global ID)

        • Optionalend_time?: null | string

          Exclusive upper bound time

        • Optionallimit?: number

          Maximum number of spans to return

        • Optionalstart_time?: null | string

          Inclusive lower bound time

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          attributes?: null | { key?: ...; value?: ... }[];
                          dropped_attributes_count?: null | number;
                          dropped_events_count?: null | number;
                          dropped_links_count?: null | number;
                          end_time_unix_nano?: null | string | number;
                          events?:
                              | null
                              | {
                                  attributes?: ...;
                                  dropped_attributes_count?: ...;
                                  name?: ...;
                                  time_unix_nano?: ...;
                              }[];
                          flags?: null
                          | number;
                          kind?:
                              | null
                              | number
                              | "SPAN_KIND_UNSPECIFIED"
                              | "SPAN_KIND_INTERNAL"
                              | "SPAN_KIND_SERVER"
                              | "SPAN_KIND_CLIENT"
                              | "SPAN_KIND_PRODUCER"
                              | "SPAN_KIND_CONSUMER";
                          links?: null;
                          name?: null
                          | string;
                          parent_span_id?: null | string;
                          span_id?: null | string;
                          start_time_unix_nano?: null | string | number;
                          status?:
                              | null
                              | { code?: (...)
                              | (...)
                              | (...); message?: (...) | (...) | (...) };
                          trace_id?: null | string;
                          trace_state?: null | string;
                      }[];
                      next_cursor: null
                      | string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        attributes?: null | { key?: ...; value?: ... }[];
                        dropped_attributes_count?: null | number;
                        dropped_events_count?: null | number;
                        dropped_links_count?: null | number;
                        end_time_unix_nano?: null | string | number;
                        events?:
                            | null
                            | {
                                attributes?: ...;
                                dropped_attributes_count?: ...;
                                name?: ...;
                                time_unix_nano?: ...;
                            }[];
                        flags?: null
                        | number;
                        kind?:
                            | null
                            | number
                            | "SPAN_KIND_UNSPECIFIED"
                            | "SPAN_KIND_INTERNAL"
                            | "SPAN_KIND_SERVER"
                            | "SPAN_KIND_CLIENT"
                            | "SPAN_KIND_PRODUCER"
                            | "SPAN_KIND_CONSUMER";
                        links?: null;
                        name?: null
                        | string;
                        parent_span_id?: null | string;
                        span_id?: null | string;
                        start_time_unix_nano?: null | string | number;
                        status?:
                            | null
                            | { code?: (...)
                            | (...)
                            | (...); message?: (...) | (...) | (...) };
                        trace_id?: null | string;
                        trace_state?: null | string;
                    }[];
                    next_cursor: null
                    | string;
                };
            };
            headers: { [name: string]: unknown };
        }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/prompt_versions/{prompt_version_id}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { prompt_version_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            description?: null
                            | string;
                            id: string;
                            invocation_parameters:
                                | {
                                    anthropic: {
                                        max_tokens: number;
                                        stop_sequences?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        thinking?: (...) | (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "anthropic";
                                }
                                | {
                                    aws: {
                                        max_tokens?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "aws";
                                }
                                | {
                                    azure_openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "azure_openai";
                                }
                                | {
                                    deepseek: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "deepseek";
                                }
                                | {
                                    google: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_output_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        stop_sequences?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_k?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "google";
                                }
                                | {
                                    ollama: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "ollama";
                                }
                                | {
                                    openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "openai";
                                }
                                | {
                                    type: "xai";
                                    xai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                };
                            model_name: string;
                            model_provider: | "OPENAI"
                            | "AZURE_OPENAI"
                            | "ANTHROPIC"
                            | "GOOGLE"
                            | "DEEPSEEK"
                            | "XAI"
                            | "OLLAMA"
                            | "AWS";
                            response_format?: | null
                            | {
                                json_schema: {
                                    description?: (...)
                                    | (...);
                                    name: string;
                                    schema?: (...) | (...);
                                    strict?: (...) | (...) | (...);
                                };
                                type: "json_schema";
                            };
                            template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                            | { template: string; type: "string" };
                            template_format: "NONE" | "MUSTACHE" | "F_STRING";
                            template_type: "STR" | "CHAT";
                            tools?:
                                | null
                                | {
                                    disable_parallel_tool_calls?: boolean;
                                    tool_choice?: | { type: ... }
                                    | { type: ... }
                                    | { function_name: ...; type: ... }
                                    | { type: ... };
                                    tools: { function: ...; type: ... }[];
                                    type: "tools";
                                };
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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: { prompt_version_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            description?: null
                            | string;
                            id: string;
                            invocation_parameters:
                                | {
                                    anthropic: {
                                        max_tokens: number;
                                        stop_sequences?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        thinking?: (...) | (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "anthropic";
                                }
                                | {
                                    aws: {
                                        max_tokens?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "aws";
                                }
                                | {
                                    azure_openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "azure_openai";
                                }
                                | {
                                    deepseek: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "deepseek";
                                }
                                | {
                                    google: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_output_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        stop_sequences?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_k?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "google";
                                }
                                | {
                                    ollama: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "ollama";
                                }
                                | {
                                    openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "openai";
                                }
                                | {
                                    type: "xai";
                                    xai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                };
                            model_name: string;
                            model_provider: | "OPENAI"
                            | "AZURE_OPENAI"
                            | "ANTHROPIC"
                            | "GOOGLE"
                            | "DEEPSEEK"
                            | "XAI"
                            | "OLLAMA"
                            | "AWS";
                            response_format?: | null
                            | {
                                json_schema: {
                                    description?: (...)
                                    | (...);
                                    name: string;
                                    schema?: (...) | (...);
                                    strict?: (...) | (...) | (...);
                                };
                                type: "json_schema";
                            };
                            template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                            | { template: string; type: "string" };
                            template_format: "NONE" | "MUSTACHE" | "F_STRING";
                            template_type: "STR" | "CHAT";
                            tools?:
                                | null
                                | {
                                    disable_parallel_tool_calls?: boolean;
                                    tool_choice?: | { type: ... }
                                    | { type: ... }
                                    | { function_name: ...; type: ... }
                                    | { type: ... };
                                    tools: { function: ...; type: ... }[];
                                    type: "tools";
                                };
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get prompt version by ID

    Retrieve a specific prompt version using its unique identifier. A prompt version contains the actual template and configuration.

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

          The ID of the prompt version.

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          description?: null | string;
                          id: string;
                          invocation_parameters:
                              | {
                                  anthropic: {
                                      max_tokens: number;
                                      stop_sequences?: (...)
                                      | (...);
                                      temperature?: (...) | (...);
                                      thinking?: (...) | (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "anthropic";
                              }
                              | {
                                  aws: {
                                      max_tokens?: (...)
                                      | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "aws";
                              }
                              | {
                                  azure_openai: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "azure_openai";
                              }
                              | {
                                  deepseek: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "deepseek";
                              }
                              | {
                                  google: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_output_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      stop_sequences?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_k?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "google";
                              }
                              | {
                                  ollama: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "ollama";
                              }
                              | {
                                  openai: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "openai";
                              }
                              | {
                                  type: "xai";
                                  xai: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                              };
                          model_name: string;
                          model_provider: | "OPENAI"
                          | "AZURE_OPENAI"
                          | "ANTHROPIC"
                          | "GOOGLE"
                          | "DEEPSEEK"
                          | "XAI"
                          | "OLLAMA"
                          | "AWS";
                          response_format?: | null
                          | {
                              json_schema: {
                                  description?: (...)
                                  | (...);
                                  name: string;
                                  schema?: (...) | (...);
                                  strict?: (...) | (...) | (...);
                              };
                              type: "json_schema";
                          };
                          template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                          | { template: string; type: "string" };
                          template_format: "NONE" | "MUSTACHE" | "F_STRING";
                          template_type: "STR" | "CHAT";
                          tools?:
                              | null
                              | {
                                  disable_parallel_tool_calls?: boolean;
                                  tool_choice?: | { type: ... }
                                  | { type: ... }
                                  | { function_name: ...; type: ... }
                                  | { type: ... };
                                  tools: { function: ...; type: ... }[];
                                  type: "tools";
                              };
                      };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        description?: null | string;
                        id: string;
                        invocation_parameters:
                            | {
                                anthropic: {
                                    max_tokens: number;
                                    stop_sequences?: (...)
                                    | (...);
                                    temperature?: (...) | (...);
                                    thinking?: (...) | (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "anthropic";
                            }
                            | {
                                aws: {
                                    max_tokens?: (...)
                                    | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "aws";
                            }
                            | {
                                azure_openai: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "azure_openai";
                            }
                            | {
                                deepseek: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "deepseek";
                            }
                            | {
                                google: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_output_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    stop_sequences?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_k?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "google";
                            }
                            | {
                                ollama: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "ollama";
                            }
                            | {
                                openai: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "openai";
                            }
                            | {
                                type: "xai";
                                xai: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                            };
                        model_name: string;
                        model_provider: | "OPENAI"
                        | "AZURE_OPENAI"
                        | "ANTHROPIC"
                        | "GOOGLE"
                        | "DEEPSEEK"
                        | "XAI"
                        | "OLLAMA"
                        | "AWS";
                        response_format?: | null
                        | {
                            json_schema: {
                                description?: (...)
                                | (...);
                                name: string;
                                schema?: (...) | (...);
                                strict?: (...) | (...) | (...);
                            };
                            type: "json_schema";
                        };
                        template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                        | { template: string; type: "string" };
                        template_format: "NONE" | "MUSTACHE" | "F_STRING";
                        template_type: "STR" | "CHAT";
                        tools?:
                            | null
                            | {
                                disable_parallel_tool_calls?: boolean;
                                tool_choice?: | { type: ... }
                                | { type: ... }
                                | { function_name: ...; type: ... }
                                | { type: ... };
                                tools: { function: ...; type: ... }[];
                                type: "tools";
                            };
                    };
                };
            };
            headers: { [name: string]: unknown };
        }

        The requested prompt version

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/prompt_versions/{prompt_version_id}/tags": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { prompt_version_id: string };
            query?: { cursor?: null | string; limit?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: { description?: null
                        | string; id: string; name: string }[];
                        next_cursor: null | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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: { prompt_version_id: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": { description?: null
                | string; name: string };
            };
        };
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { prompt_version_id: string };
            query?: { cursor?: null | string; limit?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: { description?: null
                        | string; id: string; name: string }[];
                        next_cursor: null | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    List prompt version tags

    Retrieve all tags associated with a specific prompt version. Tags are used to identify and categorize different versions of a prompt.

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { prompt_version_id: string };
          query?: { cursor?: null | string; limit?: number };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { prompt_version_id: string }
        • prompt_version_id: string

          The ID of the prompt version.

      • Optionalquery?: { cursor?: null | string; limit?: number }
        • Optionalcursor?: null | string

          Cursor for pagination (base64-encoded promptVersionTag ID)

        • Optionallimit?: number

          The max number of tags to return at a time.

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: { description?: null | string; id: string; name: string }[];
                      next_cursor: null | string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: { description?: null | string; id: string; name: string }[];
                    next_cursor: null | string;
                };
            };
            headers: { [name: string]: unknown };
        }

        A list of tags associated with the prompt version

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { prompt_version_id: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": { description?: null
                | string; name: string };
            };
        };
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Add tag to prompt version

    Add a new tag to a specific prompt version. Tags help identify and categorize different versions of a prompt.

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

          The ID of the prompt version.

      • Optionalquery?: undefined
    • requestBody: {
          content: {
              "application/json": { description?: null | string; name: string };
          };
      }
    • responses: {
          "204": { content?: undefined; headers: { [name: string]: unknown } };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 204: { content?: undefined; headers: { [name: string]: unknown } }

        No content returned on successful tag creation

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/prompts": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { cursor?: null | string; limit?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            source_prompt_id?: null | string;
                        }[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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": {
                    prompt: {
                        description?: null
                        | string;
                        name: string;
                        source_prompt_id?: null | string;
                    };
                    version: {
                        description?: null
                        | string;
                        invocation_parameters:
                            | {
                                anthropic: {
                                    max_tokens: number;
                                    stop_sequences?: (...)[];
                                    temperature?: number;
                                    thinking?: { type: ... } | { budget_tokens: ...; type: ... };
                                    top_p?: number;
                                };
                                type: "anthropic";
                            }
                            | {
                                aws: {
                                    max_tokens?: number;
                                    temperature?: number;
                                    top_p?: number;
                                };
                                type: "aws";
                            }
                            | {
                                azure_openai: {
                                    frequency_penalty?: number;
                                    max_completion_tokens?: number;
                                    max_tokens?: number;
                                    presence_penalty?: number;
                                    reasoning_effort?: "minimal"
                                    | "low"
                                    | "medium"
                                    | "high";
                                    seed?: number;
                                    temperature?: number;
                                    top_p?: number;
                                };
                                type: "azure_openai";
                            }
                            | {
                                deepseek: {
                                    frequency_penalty?: number;
                                    max_completion_tokens?: number;
                                    max_tokens?: number;
                                    presence_penalty?: number;
                                    reasoning_effort?: "minimal"
                                    | "low"
                                    | "medium"
                                    | "high";
                                    seed?: number;
                                    temperature?: number;
                                    top_p?: number;
                                };
                                type: "deepseek";
                            }
                            | {
                                google: {
                                    frequency_penalty?: number;
                                    max_output_tokens?: number;
                                    presence_penalty?: number;
                                    stop_sequences?: (...)[];
                                    temperature?: number;
                                    top_k?: number;
                                    top_p?: number;
                                };
                                type: "google";
                            }
                            | {
                                ollama: {
                                    frequency_penalty?: number;
                                    max_completion_tokens?: number;
                                    max_tokens?: number;
                                    presence_penalty?: number;
                                    reasoning_effort?: "minimal"
                                    | "low"
                                    | "medium"
                                    | "high";
                                    seed?: number;
                                    temperature?: number;
                                    top_p?: number;
                                };
                                type: "ollama";
                            }
                            | {
                                openai: {
                                    frequency_penalty?: number;
                                    max_completion_tokens?: number;
                                    max_tokens?: number;
                                    presence_penalty?: number;
                                    reasoning_effort?: "minimal"
                                    | "low"
                                    | "medium"
                                    | "high";
                                    seed?: number;
                                    temperature?: number;
                                    top_p?: number;
                                };
                                type: "openai";
                            }
                            | {
                                type: "xai";
                                xai: {
                                    frequency_penalty?: number;
                                    max_completion_tokens?: number;
                                    max_tokens?: number;
                                    presence_penalty?: number;
                                    reasoning_effort?: "minimal"
                                    | "low"
                                    | "medium"
                                    | "high";
                                    seed?: number;
                                    temperature?: number;
                                    top_p?: number;
                                };
                            };
                        model_name: string;
                        model_provider: | "OPENAI"
                        | "AZURE_OPENAI"
                        | "ANTHROPIC"
                        | "GOOGLE"
                        | "DEEPSEEK"
                        | "XAI"
                        | "OLLAMA"
                        | "AWS";
                        response_format?: | null
                        | {
                            json_schema: {
                                description?: string;
                                name: string;
                                schema?: { [key: ...]: ... };
                                strict?: boolean;
                            };
                            type: "json_schema";
                        };
                        template: | {
                            messages: {
                                content: (...)
                                | (...);
                                role: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                            }[];
                            type: "chat";
                        }
                        | { template: string; type: "string" };
                        template_format: "NONE" | "MUSTACHE" | "F_STRING";
                        template_type: "STR" | "CHAT";
                        tools?:
                            | null
                            | {
                                disable_parallel_tool_calls?: boolean;
                                tool_choice?: | { type: "none" }
                                | { type: "one_or_more" }
                                | { function_name: string; type: "specific_function" }
                                | { type: "zero_or_more" };
                                tools: {
                                    function: {
                                        description?: ...;
                                        name: ...;
                                        parameters?: ...;
                                        strict?: ...;
                                    };
                                    type: "function";
                                }[];
                                type: "tools";
                            };
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            description?: null
                            | string;
                            id: string;
                            invocation_parameters:
                                | {
                                    anthropic: {
                                        max_tokens: number;
                                        stop_sequences?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        thinking?: (...) | (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "anthropic";
                                }
                                | {
                                    aws: {
                                        max_tokens?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "aws";
                                }
                                | {
                                    azure_openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "azure_openai";
                                }
                                | {
                                    deepseek: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "deepseek";
                                }
                                | {
                                    google: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_output_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        stop_sequences?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_k?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "google";
                                }
                                | {
                                    ollama: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "ollama";
                                }
                                | {
                                    openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "openai";
                                }
                                | {
                                    type: "xai";
                                    xai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                };
                            model_name: string;
                            model_provider: | "OPENAI"
                            | "AZURE_OPENAI"
                            | "ANTHROPIC"
                            | "GOOGLE"
                            | "DEEPSEEK"
                            | "XAI"
                            | "OLLAMA"
                            | "AWS";
                            response_format?: | null
                            | {
                                json_schema: {
                                    description?: (...)
                                    | (...);
                                    name: string;
                                    schema?: (...) | (...);
                                    strict?: (...) | (...) | (...);
                                };
                                type: "json_schema";
                            };
                            template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                            | { template: string; type: "string" };
                            template_format: "NONE" | "MUSTACHE" | "F_STRING";
                            template_type: "STR" | "CHAT";
                            tools?:
                                | null
                                | {
                                    disable_parallel_tool_calls?: boolean;
                                    tool_choice?: | { type: ... }
                                    | { type: ... }
                                    | { function_name: ...; type: ... }
                                    | { type: ... };
                                    tools: { function: ...; type: ... }[];
                                    type: "tools";
                                };
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { cursor?: null | string; limit?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            description?: null
                            | string;
                            id: string;
                            name: string;
                            source_prompt_id?: null | string;
                        }[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    List all prompts

    Retrieve a paginated list of all prompts in the system. A prompt can have multiple versions.

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

          Cursor for pagination (base64-encoded prompt ID)

        • Optionallimit?: number

          The max number of prompts to return at a time.

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          description?: null | string;
                          id: string;
                          name: string;
                          source_prompt_id?: null | string;
                      }[];
                      next_cursor: null
                      | string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        description?: null | string;
                        id: string;
                        name: string;
                        source_prompt_id?: null | string;
                    }[];
                    next_cursor: null
                    | string;
                };
            };
            headers: { [name: string]: unknown };
        }

        A list of prompts with pagination information

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    prompt: {
                        description?: null
                        | string;
                        name: string;
                        source_prompt_id?: null | string;
                    };
                    version: {
                        description?: null
                        | string;
                        invocation_parameters:
                            | {
                                anthropic: {
                                    max_tokens: number;
                                    stop_sequences?: (...)[];
                                    temperature?: number;
                                    thinking?: { type: ... } | { budget_tokens: ...; type: ... };
                                    top_p?: number;
                                };
                                type: "anthropic";
                            }
                            | {
                                aws: { max_tokens?: number; temperature?: number; top_p?: number };
                                type: "aws";
                            }
                            | {
                                azure_openai: {
                                    frequency_penalty?: number;
                                    max_completion_tokens?: number;
                                    max_tokens?: number;
                                    presence_penalty?: number;
                                    reasoning_effort?: "minimal"
                                    | "low"
                                    | "medium"
                                    | "high";
                                    seed?: number;
                                    temperature?: number;
                                    top_p?: number;
                                };
                                type: "azure_openai";
                            }
                            | {
                                deepseek: {
                                    frequency_penalty?: number;
                                    max_completion_tokens?: number;
                                    max_tokens?: number;
                                    presence_penalty?: number;
                                    reasoning_effort?: "minimal"
                                    | "low"
                                    | "medium"
                                    | "high";
                                    seed?: number;
                                    temperature?: number;
                                    top_p?: number;
                                };
                                type: "deepseek";
                            }
                            | {
                                google: {
                                    frequency_penalty?: number;
                                    max_output_tokens?: number;
                                    presence_penalty?: number;
                                    stop_sequences?: (...)[];
                                    temperature?: number;
                                    top_k?: number;
                                    top_p?: number;
                                };
                                type: "google";
                            }
                            | {
                                ollama: {
                                    frequency_penalty?: number;
                                    max_completion_tokens?: number;
                                    max_tokens?: number;
                                    presence_penalty?: number;
                                    reasoning_effort?: "minimal"
                                    | "low"
                                    | "medium"
                                    | "high";
                                    seed?: number;
                                    temperature?: number;
                                    top_p?: number;
                                };
                                type: "ollama";
                            }
                            | {
                                openai: {
                                    frequency_penalty?: number;
                                    max_completion_tokens?: number;
                                    max_tokens?: number;
                                    presence_penalty?: number;
                                    reasoning_effort?: "minimal"
                                    | "low"
                                    | "medium"
                                    | "high";
                                    seed?: number;
                                    temperature?: number;
                                    top_p?: number;
                                };
                                type: "openai";
                            }
                            | {
                                type: "xai";
                                xai: {
                                    frequency_penalty?: number;
                                    max_completion_tokens?: number;
                                    max_tokens?: number;
                                    presence_penalty?: number;
                                    reasoning_effort?: "minimal"
                                    | "low"
                                    | "medium"
                                    | "high";
                                    seed?: number;
                                    temperature?: number;
                                    top_p?: number;
                                };
                            };
                        model_name: string;
                        model_provider: | "OPENAI"
                        | "AZURE_OPENAI"
                        | "ANTHROPIC"
                        | "GOOGLE"
                        | "DEEPSEEK"
                        | "XAI"
                        | "OLLAMA"
                        | "AWS";
                        response_format?: | null
                        | {
                            json_schema: {
                                description?: string;
                                name: string;
                                schema?: { [key: ...]: ... };
                                strict?: boolean;
                            };
                            type: "json_schema";
                        };
                        template: | {
                            messages: {
                                content: (...)
                                | (...);
                                role: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                            }[];
                            type: "chat";
                        }
                        | { template: string; type: "string" };
                        template_format: "NONE" | "MUSTACHE" | "F_STRING";
                        template_type: "STR" | "CHAT";
                        tools?:
                            | null
                            | {
                                disable_parallel_tool_calls?: boolean;
                                tool_choice?: | { type: "none" }
                                | { type: "one_or_more" }
                                | { function_name: string; type: "specific_function" }
                                | { type: "zero_or_more" };
                                tools: {
                                    function: {
                                        description?: ...;
                                        name: ...;
                                        parameters?: ...;
                                        strict?: ...;
                                    };
                                    type: "function";
                                }[];
                                type: "tools";
                            };
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            description?: null
                            | string;
                            id: string;
                            invocation_parameters:
                                | {
                                    anthropic: {
                                        max_tokens: number;
                                        stop_sequences?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        thinking?: (...) | (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "anthropic";
                                }
                                | {
                                    aws: {
                                        max_tokens?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "aws";
                                }
                                | {
                                    azure_openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "azure_openai";
                                }
                                | {
                                    deepseek: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "deepseek";
                                }
                                | {
                                    google: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_output_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        stop_sequences?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_k?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "google";
                                }
                                | {
                                    ollama: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "ollama";
                                }
                                | {
                                    openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "openai";
                                }
                                | {
                                    type: "xai";
                                    xai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                };
                            model_name: string;
                            model_provider: | "OPENAI"
                            | "AZURE_OPENAI"
                            | "ANTHROPIC"
                            | "GOOGLE"
                            | "DEEPSEEK"
                            | "XAI"
                            | "OLLAMA"
                            | "AWS";
                            response_format?: | null
                            | {
                                json_schema: {
                                    description?: (...)
                                    | (...);
                                    name: string;
                                    schema?: (...) | (...);
                                    strict?: (...) | (...) | (...);
                                };
                                type: "json_schema";
                            };
                            template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                            | { template: string; type: "string" };
                            template_format: "NONE" | "MUSTACHE" | "F_STRING";
                            template_type: "STR" | "CHAT";
                            tools?:
                                | null
                                | {
                                    disable_parallel_tool_calls?: boolean;
                                    tool_choice?: | { type: ... }
                                    | { type: ... }
                                    | { function_name: ...; type: ... }
                                    | { type: ... };
                                    tools: { function: ...; type: ... }[];
                                    type: "tools";
                                };
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Create a new prompt

    Create a new prompt and its initial version. A prompt can have multiple versions.

    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • requestBody: {
          content: {
              "application/json": {
                  prompt: {
                      description?: null | string;
                      name: string;
                      source_prompt_id?: null | string;
                  };
                  version: {
                      description?: null
                      | string;
                      invocation_parameters:
                          | {
                              anthropic: {
                                  max_tokens: number;
                                  stop_sequences?: (...)[];
                                  temperature?: number;
                                  thinking?: { type: ... } | { budget_tokens: ...; type: ... };
                                  top_p?: number;
                              };
                              type: "anthropic";
                          }
                          | {
                              aws: { max_tokens?: number; temperature?: number; top_p?: number };
                              type: "aws";
                          }
                          | {
                              azure_openai: {
                                  frequency_penalty?: number;
                                  max_completion_tokens?: number;
                                  max_tokens?: number;
                                  presence_penalty?: number;
                                  reasoning_effort?: "minimal"
                                  | "low"
                                  | "medium"
                                  | "high";
                                  seed?: number;
                                  temperature?: number;
                                  top_p?: number;
                              };
                              type: "azure_openai";
                          }
                          | {
                              deepseek: {
                                  frequency_penalty?: number;
                                  max_completion_tokens?: number;
                                  max_tokens?: number;
                                  presence_penalty?: number;
                                  reasoning_effort?: "minimal"
                                  | "low"
                                  | "medium"
                                  | "high";
                                  seed?: number;
                                  temperature?: number;
                                  top_p?: number;
                              };
                              type: "deepseek";
                          }
                          | {
                              google: {
                                  frequency_penalty?: number;
                                  max_output_tokens?: number;
                                  presence_penalty?: number;
                                  stop_sequences?: (...)[];
                                  temperature?: number;
                                  top_k?: number;
                                  top_p?: number;
                              };
                              type: "google";
                          }
                          | {
                              ollama: {
                                  frequency_penalty?: number;
                                  max_completion_tokens?: number;
                                  max_tokens?: number;
                                  presence_penalty?: number;
                                  reasoning_effort?: "minimal"
                                  | "low"
                                  | "medium"
                                  | "high";
                                  seed?: number;
                                  temperature?: number;
                                  top_p?: number;
                              };
                              type: "ollama";
                          }
                          | {
                              openai: {
                                  frequency_penalty?: number;
                                  max_completion_tokens?: number;
                                  max_tokens?: number;
                                  presence_penalty?: number;
                                  reasoning_effort?: "minimal"
                                  | "low"
                                  | "medium"
                                  | "high";
                                  seed?: number;
                                  temperature?: number;
                                  top_p?: number;
                              };
                              type: "openai";
                          }
                          | {
                              type: "xai";
                              xai: {
                                  frequency_penalty?: number;
                                  max_completion_tokens?: number;
                                  max_tokens?: number;
                                  presence_penalty?: number;
                                  reasoning_effort?: "minimal"
                                  | "low"
                                  | "medium"
                                  | "high";
                                  seed?: number;
                                  temperature?: number;
                                  top_p?: number;
                              };
                          };
                      model_name: string;
                      model_provider: | "OPENAI"
                      | "AZURE_OPENAI"
                      | "ANTHROPIC"
                      | "GOOGLE"
                      | "DEEPSEEK"
                      | "XAI"
                      | "OLLAMA"
                      | "AWS";
                      response_format?: | null
                      | {
                          json_schema: {
                              description?: string;
                              name: string;
                              schema?: { [key: ...]: ... };
                              strict?: boolean;
                          };
                          type: "json_schema";
                      };
                      template: | {
                          messages: {
                              content: (...)
                              | (...);
                              role: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                          }[];
                          type: "chat";
                      }
                      | { template: string; type: "string" };
                      template_format: "NONE" | "MUSTACHE" | "F_STRING";
                      template_type: "STR" | "CHAT";
                      tools?:
                          | null
                          | {
                              disable_parallel_tool_calls?: boolean;
                              tool_choice?: | { type: "none" }
                              | { type: "one_or_more" }
                              | { function_name: string; type: "specific_function" }
                              | { type: "zero_or_more" };
                              tools: {
                                  function: {
                                      description?: ...;
                                      name: ...;
                                      parameters?: ...;
                                      strict?: ...;
                                  };
                                  type: "function";
                              }[];
                              type: "tools";
                          };
                  };
              };
          };
      }
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          description?: null | string;
                          id: string;
                          invocation_parameters:
                              | {
                                  anthropic: {
                                      max_tokens: number;
                                      stop_sequences?: (...)
                                      | (...);
                                      temperature?: (...) | (...);
                                      thinking?: (...) | (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "anthropic";
                              }
                              | {
                                  aws: {
                                      max_tokens?: (...)
                                      | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "aws";
                              }
                              | {
                                  azure_openai: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "azure_openai";
                              }
                              | {
                                  deepseek: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "deepseek";
                              }
                              | {
                                  google: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_output_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      stop_sequences?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_k?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "google";
                              }
                              | {
                                  ollama: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "ollama";
                              }
                              | {
                                  openai: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "openai";
                              }
                              | {
                                  type: "xai";
                                  xai: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                              };
                          model_name: string;
                          model_provider: | "OPENAI"
                          | "AZURE_OPENAI"
                          | "ANTHROPIC"
                          | "GOOGLE"
                          | "DEEPSEEK"
                          | "XAI"
                          | "OLLAMA"
                          | "AWS";
                          response_format?: | null
                          | {
                              json_schema: {
                                  description?: (...)
                                  | (...);
                                  name: string;
                                  schema?: (...) | (...);
                                  strict?: (...) | (...) | (...);
                              };
                              type: "json_schema";
                          };
                          template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                          | { template: string; type: "string" };
                          template_format: "NONE" | "MUSTACHE" | "F_STRING";
                          template_type: "STR" | "CHAT";
                          tools?:
                              | null
                              | {
                                  disable_parallel_tool_calls?: boolean;
                                  tool_choice?: | { type: ... }
                                  | { type: ... }
                                  | { function_name: ...; type: ... }
                                  | { type: ... };
                                  tools: { function: ...; type: ... }[];
                                  type: "tools";
                              };
                      };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        description?: null | string;
                        id: string;
                        invocation_parameters:
                            | {
                                anthropic: {
                                    max_tokens: number;
                                    stop_sequences?: (...)
                                    | (...);
                                    temperature?: (...) | (...);
                                    thinking?: (...) | (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "anthropic";
                            }
                            | {
                                aws: {
                                    max_tokens?: (...)
                                    | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "aws";
                            }
                            | {
                                azure_openai: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "azure_openai";
                            }
                            | {
                                deepseek: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "deepseek";
                            }
                            | {
                                google: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_output_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    stop_sequences?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_k?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "google";
                            }
                            | {
                                ollama: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "ollama";
                            }
                            | {
                                openai: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "openai";
                            }
                            | {
                                type: "xai";
                                xai: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                            };
                        model_name: string;
                        model_provider: | "OPENAI"
                        | "AZURE_OPENAI"
                        | "ANTHROPIC"
                        | "GOOGLE"
                        | "DEEPSEEK"
                        | "XAI"
                        | "OLLAMA"
                        | "AWS";
                        response_format?: | null
                        | {
                            json_schema: {
                                description?: (...)
                                | (...);
                                name: string;
                                schema?: (...) | (...);
                                strict?: (...) | (...) | (...);
                            };
                            type: "json_schema";
                        };
                        template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                        | { template: string; type: "string" };
                        template_format: "NONE" | "MUSTACHE" | "F_STRING";
                        template_type: "STR" | "CHAT";
                        tools?:
                            | null
                            | {
                                disable_parallel_tool_calls?: boolean;
                                tool_choice?: | { type: ... }
                                | { type: ... }
                                | { function_name: ...; type: ... }
                                | { type: ... };
                                tools: { function: ...; type: ... }[];
                                type: "tools";
                            };
                    };
                };
            };
            headers: { [name: string]: unknown };
        }

        The newly created prompt version

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/prompts/{prompt_identifier}/latest": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { prompt_identifier: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            description?: null
                            | string;
                            id: string;
                            invocation_parameters:
                                | {
                                    anthropic: {
                                        max_tokens: number;
                                        stop_sequences?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        thinking?: (...) | (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "anthropic";
                                }
                                | {
                                    aws: {
                                        max_tokens?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "aws";
                                }
                                | {
                                    azure_openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "azure_openai";
                                }
                                | {
                                    deepseek: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "deepseek";
                                }
                                | {
                                    google: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_output_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        stop_sequences?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_k?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "google";
                                }
                                | {
                                    ollama: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "ollama";
                                }
                                | {
                                    openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "openai";
                                }
                                | {
                                    type: "xai";
                                    xai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                };
                            model_name: string;
                            model_provider: | "OPENAI"
                            | "AZURE_OPENAI"
                            | "ANTHROPIC"
                            | "GOOGLE"
                            | "DEEPSEEK"
                            | "XAI"
                            | "OLLAMA"
                            | "AWS";
                            response_format?: | null
                            | {
                                json_schema: {
                                    description?: (...)
                                    | (...);
                                    name: string;
                                    schema?: (...) | (...);
                                    strict?: (...) | (...) | (...);
                                };
                                type: "json_schema";
                            };
                            template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                            | { template: string; type: "string" };
                            template_format: "NONE" | "MUSTACHE" | "F_STRING";
                            template_type: "STR" | "CHAT";
                            tools?:
                                | null
                                | {
                                    disable_parallel_tool_calls?: boolean;
                                    tool_choice?: | { type: ... }
                                    | { type: ... }
                                    | { function_name: ...; type: ... }
                                    | { type: ... };
                                    tools: { function: ...; type: ... }[];
                                    type: "tools";
                                };
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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: { prompt_identifier: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            description?: null
                            | string;
                            id: string;
                            invocation_parameters:
                                | {
                                    anthropic: {
                                        max_tokens: number;
                                        stop_sequences?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        thinking?: (...) | (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "anthropic";
                                }
                                | {
                                    aws: {
                                        max_tokens?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "aws";
                                }
                                | {
                                    azure_openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "azure_openai";
                                }
                                | {
                                    deepseek: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "deepseek";
                                }
                                | {
                                    google: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_output_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        stop_sequences?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_k?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "google";
                                }
                                | {
                                    ollama: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "ollama";
                                }
                                | {
                                    openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "openai";
                                }
                                | {
                                    type: "xai";
                                    xai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                };
                            model_name: string;
                            model_provider: | "OPENAI"
                            | "AZURE_OPENAI"
                            | "ANTHROPIC"
                            | "GOOGLE"
                            | "DEEPSEEK"
                            | "XAI"
                            | "OLLAMA"
                            | "AWS";
                            response_format?: | null
                            | {
                                json_schema: {
                                    description?: (...)
                                    | (...);
                                    name: string;
                                    schema?: (...) | (...);
                                    strict?: (...) | (...) | (...);
                                };
                                type: "json_schema";
                            };
                            template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                            | { template: string; type: "string" };
                            template_format: "NONE" | "MUSTACHE" | "F_STRING";
                            template_type: "STR" | "CHAT";
                            tools?:
                                | null
                                | {
                                    disable_parallel_tool_calls?: boolean;
                                    tool_choice?: | { type: ... }
                                    | { type: ... }
                                    | { function_name: ...; type: ... }
                                    | { type: ... };
                                    tools: { function: ...; type: ... }[];
                                    type: "tools";
                                };
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get latest prompt version

    Retrieve the most recent version of a specific prompt.

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

          The identifier of the prompt, i.e. name or ID.

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          description?: null | string;
                          id: string;
                          invocation_parameters:
                              | {
                                  anthropic: {
                                      max_tokens: number;
                                      stop_sequences?: (...)
                                      | (...);
                                      temperature?: (...) | (...);
                                      thinking?: (...) | (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "anthropic";
                              }
                              | {
                                  aws: {
                                      max_tokens?: (...)
                                      | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "aws";
                              }
                              | {
                                  azure_openai: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "azure_openai";
                              }
                              | {
                                  deepseek: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "deepseek";
                              }
                              | {
                                  google: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_output_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      stop_sequences?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_k?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "google";
                              }
                              | {
                                  ollama: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "ollama";
                              }
                              | {
                                  openai: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "openai";
                              }
                              | {
                                  type: "xai";
                                  xai: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                              };
                          model_name: string;
                          model_provider: | "OPENAI"
                          | "AZURE_OPENAI"
                          | "ANTHROPIC"
                          | "GOOGLE"
                          | "DEEPSEEK"
                          | "XAI"
                          | "OLLAMA"
                          | "AWS";
                          response_format?: | null
                          | {
                              json_schema: {
                                  description?: (...)
                                  | (...);
                                  name: string;
                                  schema?: (...) | (...);
                                  strict?: (...) | (...) | (...);
                              };
                              type: "json_schema";
                          };
                          template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                          | { template: string; type: "string" };
                          template_format: "NONE" | "MUSTACHE" | "F_STRING";
                          template_type: "STR" | "CHAT";
                          tools?:
                              | null
                              | {
                                  disable_parallel_tool_calls?: boolean;
                                  tool_choice?: | { type: ... }
                                  | { type: ... }
                                  | { function_name: ...; type: ... }
                                  | { type: ... };
                                  tools: { function: ...; type: ... }[];
                                  type: "tools";
                              };
                      };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        description?: null | string;
                        id: string;
                        invocation_parameters:
                            | {
                                anthropic: {
                                    max_tokens: number;
                                    stop_sequences?: (...)
                                    | (...);
                                    temperature?: (...) | (...);
                                    thinking?: (...) | (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "anthropic";
                            }
                            | {
                                aws: {
                                    max_tokens?: (...)
                                    | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "aws";
                            }
                            | {
                                azure_openai: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "azure_openai";
                            }
                            | {
                                deepseek: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "deepseek";
                            }
                            | {
                                google: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_output_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    stop_sequences?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_k?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "google";
                            }
                            | {
                                ollama: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "ollama";
                            }
                            | {
                                openai: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "openai";
                            }
                            | {
                                type: "xai";
                                xai: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                            };
                        model_name: string;
                        model_provider: | "OPENAI"
                        | "AZURE_OPENAI"
                        | "ANTHROPIC"
                        | "GOOGLE"
                        | "DEEPSEEK"
                        | "XAI"
                        | "OLLAMA"
                        | "AWS";
                        response_format?: | null
                        | {
                            json_schema: {
                                description?: (...)
                                | (...);
                                name: string;
                                schema?: (...) | (...);
                                strict?: (...) | (...) | (...);
                            };
                            type: "json_schema";
                        };
                        template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                        | { template: string; type: "string" };
                        template_format: "NONE" | "MUSTACHE" | "F_STRING";
                        template_type: "STR" | "CHAT";
                        tools?:
                            | null
                            | {
                                disable_parallel_tool_calls?: boolean;
                                tool_choice?: | { type: ... }
                                | { type: ... }
                                | { function_name: ...; type: ... }
                                | { type: ... };
                                tools: { function: ...; type: ... }[];
                                type: "tools";
                            };
                    };
                };
            };
            headers: { [name: string]: unknown };
        }

        The latest version of the specified prompt

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/prompts/{prompt_identifier}/tags/{tag_name}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { prompt_identifier: string; tag_name: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            description?: null
                            | string;
                            id: string;
                            invocation_parameters:
                                | {
                                    anthropic: {
                                        max_tokens: number;
                                        stop_sequences?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        thinking?: (...) | (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "anthropic";
                                }
                                | {
                                    aws: {
                                        max_tokens?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "aws";
                                }
                                | {
                                    azure_openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "azure_openai";
                                }
                                | {
                                    deepseek: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "deepseek";
                                }
                                | {
                                    google: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_output_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        stop_sequences?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_k?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "google";
                                }
                                | {
                                    ollama: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "ollama";
                                }
                                | {
                                    openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "openai";
                                }
                                | {
                                    type: "xai";
                                    xai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                };
                            model_name: string;
                            model_provider: | "OPENAI"
                            | "AZURE_OPENAI"
                            | "ANTHROPIC"
                            | "GOOGLE"
                            | "DEEPSEEK"
                            | "XAI"
                            | "OLLAMA"
                            | "AWS";
                            response_format?: | null
                            | {
                                json_schema: {
                                    description?: (...)
                                    | (...);
                                    name: string;
                                    schema?: (...) | (...);
                                    strict?: (...) | (...) | (...);
                                };
                                type: "json_schema";
                            };
                            template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                            | { template: string; type: "string" };
                            template_format: "NONE" | "MUSTACHE" | "F_STRING";
                            template_type: "STR" | "CHAT";
                            tools?:
                                | null
                                | {
                                    disable_parallel_tool_calls?: boolean;
                                    tool_choice?: | { type: ... }
                                    | { type: ... }
                                    | { function_name: ...; type: ... }
                                    | { type: ... };
                                    tools: { function: ...; type: ... }[];
                                    type: "tools";
                                };
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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: { prompt_identifier: string; tag_name: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            description?: null
                            | string;
                            id: string;
                            invocation_parameters:
                                | {
                                    anthropic: {
                                        max_tokens: number;
                                        stop_sequences?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        thinking?: (...) | (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "anthropic";
                                }
                                | {
                                    aws: {
                                        max_tokens?: (...)
                                        | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "aws";
                                }
                                | {
                                    azure_openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "azure_openai";
                                }
                                | {
                                    deepseek: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "deepseek";
                                }
                                | {
                                    google: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_output_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        stop_sequences?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_k?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "google";
                                }
                                | {
                                    ollama: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "ollama";
                                }
                                | {
                                    openai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                    type: "openai";
                                }
                                | {
                                    type: "xai";
                                    xai: {
                                        frequency_penalty?: (...)
                                        | (...);
                                        max_completion_tokens?: (...) | (...);
                                        max_tokens?: (...) | (...);
                                        presence_penalty?: (...) | (...);
                                        reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                        seed?: (...) | (...);
                                        temperature?: (...) | (...);
                                        top_p?: (...) | (...);
                                    };
                                };
                            model_name: string;
                            model_provider: | "OPENAI"
                            | "AZURE_OPENAI"
                            | "ANTHROPIC"
                            | "GOOGLE"
                            | "DEEPSEEK"
                            | "XAI"
                            | "OLLAMA"
                            | "AWS";
                            response_format?: | null
                            | {
                                json_schema: {
                                    description?: (...)
                                    | (...);
                                    name: string;
                                    schema?: (...) | (...);
                                    strict?: (...) | (...) | (...);
                                };
                                type: "json_schema";
                            };
                            template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                            | { template: string; type: "string" };
                            template_format: "NONE" | "MUSTACHE" | "F_STRING";
                            template_type: "STR" | "CHAT";
                            tools?:
                                | null
                                | {
                                    disable_parallel_tool_calls?: boolean;
                                    tool_choice?: | { type: ... }
                                    | { type: ... }
                                    | { function_name: ...; type: ... }
                                    | { type: ... };
                                    tools: { function: ...; type: ... }[];
                                    type: "tools";
                                };
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get prompt version by tag

    Retrieve a specific prompt version using its tag name. Tags are used to identify specific versions of a prompt.

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

          The identifier of the prompt, i.e. name or ID.

        • tag_name: string

          The tag of the prompt version

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          description?: null | string;
                          id: string;
                          invocation_parameters:
                              | {
                                  anthropic: {
                                      max_tokens: number;
                                      stop_sequences?: (...)
                                      | (...);
                                      temperature?: (...) | (...);
                                      thinking?: (...) | (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "anthropic";
                              }
                              | {
                                  aws: {
                                      max_tokens?: (...)
                                      | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "aws";
                              }
                              | {
                                  azure_openai: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "azure_openai";
                              }
                              | {
                                  deepseek: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "deepseek";
                              }
                              | {
                                  google: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_output_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      stop_sequences?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_k?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "google";
                              }
                              | {
                                  ollama: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "ollama";
                              }
                              | {
                                  openai: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                                  type: "openai";
                              }
                              | {
                                  type: "xai";
                                  xai: {
                                      frequency_penalty?: (...)
                                      | (...);
                                      max_completion_tokens?: (...) | (...);
                                      max_tokens?: (...) | (...);
                                      presence_penalty?: (...) | (...);
                                      reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                      seed?: (...) | (...);
                                      temperature?: (...) | (...);
                                      top_p?: (...) | (...);
                                  };
                              };
                          model_name: string;
                          model_provider: | "OPENAI"
                          | "AZURE_OPENAI"
                          | "ANTHROPIC"
                          | "GOOGLE"
                          | "DEEPSEEK"
                          | "XAI"
                          | "OLLAMA"
                          | "AWS";
                          response_format?: | null
                          | {
                              json_schema: {
                                  description?: (...)
                                  | (...);
                                  name: string;
                                  schema?: (...) | (...);
                                  strict?: (...) | (...) | (...);
                              };
                              type: "json_schema";
                          };
                          template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                          | { template: string; type: "string" };
                          template_format: "NONE" | "MUSTACHE" | "F_STRING";
                          template_type: "STR" | "CHAT";
                          tools?:
                              | null
                              | {
                                  disable_parallel_tool_calls?: boolean;
                                  tool_choice?: | { type: ... }
                                  | { type: ... }
                                  | { function_name: ...; type: ... }
                                  | { type: ... };
                                  tools: { function: ...; type: ... }[];
                                  type: "tools";
                              };
                      };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        description?: null | string;
                        id: string;
                        invocation_parameters:
                            | {
                                anthropic: {
                                    max_tokens: number;
                                    stop_sequences?: (...)
                                    | (...);
                                    temperature?: (...) | (...);
                                    thinking?: (...) | (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "anthropic";
                            }
                            | {
                                aws: {
                                    max_tokens?: (...)
                                    | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "aws";
                            }
                            | {
                                azure_openai: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "azure_openai";
                            }
                            | {
                                deepseek: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "deepseek";
                            }
                            | {
                                google: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_output_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    stop_sequences?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_k?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "google";
                            }
                            | {
                                ollama: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "ollama";
                            }
                            | {
                                openai: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                                type: "openai";
                            }
                            | {
                                type: "xai";
                                xai: {
                                    frequency_penalty?: (...)
                                    | (...);
                                    max_completion_tokens?: (...) | (...);
                                    max_tokens?: (...) | (...);
                                    presence_penalty?: (...) | (...);
                                    reasoning_effort?: (...) | (...) | (...) | (...) | (...);
                                    seed?: (...) | (...);
                                    temperature?: (...) | (...);
                                    top_p?: (...) | (...);
                                };
                            };
                        model_name: string;
                        model_provider: | "OPENAI"
                        | "AZURE_OPENAI"
                        | "ANTHROPIC"
                        | "GOOGLE"
                        | "DEEPSEEK"
                        | "XAI"
                        | "OLLAMA"
                        | "AWS";
                        response_format?: | null
                        | {
                            json_schema: {
                                description?: (...)
                                | (...);
                                name: string;
                                schema?: (...) | (...);
                                strict?: (...) | (...) | (...);
                            };
                            type: "json_schema";
                        };
                        template: | { messages: { content: ...; role: ... }[]; type: "chat" }
                        | { template: string; type: "string" };
                        template_format: "NONE" | "MUSTACHE" | "F_STRING";
                        template_type: "STR" | "CHAT";
                        tools?:
                            | null
                            | {
                                disable_parallel_tool_calls?: boolean;
                                tool_choice?: | { type: ... }
                                | { type: ... }
                                | { function_name: ...; type: ... }
                                | { type: ... };
                                tools: { function: ...; type: ... }[];
                                type: "tools";
                            };
                    };
                };
            };
            headers: { [name: string]: unknown };
        }

        The prompt version with the specified tag

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/prompts/{prompt_identifier}/versions": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { prompt_identifier: string };
            query?: { cursor?: null | string; limit?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            description?: null
                            | string;
                            id: string;
                            invocation_parameters:
                                | {
                                    anthropic: {
                                        max_tokens: ...;
                                        stop_sequences?: ...;
                                        temperature?: ...;
                                        thinking?: ...;
                                        top_p?: ...;
                                    };
                                    type: "anthropic";
                                }
                                | {
                                    aws: { max_tokens?: ...; temperature?: ...; top_p?: ... };
                                    type: "aws";
                                }
                                | {
                                    azure_openai: {
                                        frequency_penalty?: ...;
                                        max_completion_tokens?: ...;
                                        max_tokens?: ...;
                                        presence_penalty?: ...;
                                        reasoning_effort?: ...;
                                        seed?: ...;
                                        temperature?: ...;
                                        top_p?: ...;
                                    };
                                    type: "azure_openai";
                                }
                                | {
                                    deepseek: {
                                        frequency_penalty?: ...;
                                        max_completion_tokens?: ...;
                                        max_tokens?: ...;
                                        presence_penalty?: ...;
                                        reasoning_effort?: ...;
                                        seed?: ...;
                                        temperature?: ...;
                                        top_p?: ...;
                                    };
                                    type: "deepseek";
                                }
                                | {
                                    google: {
                                        frequency_penalty?: ...;
                                        max_output_tokens?: ...;
                                        presence_penalty?: ...;
                                        stop_sequences?: ...;
                                        temperature?: ...;
                                        top_k?: ...;
                                        top_p?: ...;
                                    };
                                    type: "google";
                                }
                                | {
                                    ollama: {
                                        frequency_penalty?: ...;
                                        max_completion_tokens?: ...;
                                        max_tokens?: ...;
                                        presence_penalty?: ...;
                                        reasoning_effort?: ...;
                                        seed?: ...;
                                        temperature?: ...;
                                        top_p?: ...;
                                    };
                                    type: "ollama";
                                }
                                | {
                                    openai: {
                                        frequency_penalty?: ...;
                                        max_completion_tokens?: ...;
                                        max_tokens?: ...;
                                        presence_penalty?: ...;
                                        reasoning_effort?: ...;
                                        seed?: ...;
                                        temperature?: ...;
                                        top_p?: ...;
                                    };
                                    type: "openai";
                                }
                                | {
                                    type: "xai";
                                    xai: {
                                        frequency_penalty?: ...;
                                        max_completion_tokens?: ...;
                                        max_tokens?: ...;
                                        presence_penalty?: ...;
                                        reasoning_effort?: ...;
                                        seed?: ...;
                                        temperature?: ...;
                                        top_p?: ...;
                                    };
                                };
                            model_name: string;
                            model_provider: | "OPENAI"
                            | "AZURE_OPENAI"
                            | "ANTHROPIC"
                            | "GOOGLE"
                            | "DEEPSEEK"
                            | "XAI"
                            | "OLLAMA"
                            | "AWS";
                            response_format?: | null
                            | {
                                json_schema: {
                                    description?: ...;
                                    name: ...;
                                    schema?: ...;
                                    strict?: ...;
                                };
                                type: "json_schema";
                            };
                            template: | { messages: (...)[]; type: "chat" }
                            | { template: string; type: "string" };
                            template_format: "NONE" | "MUSTACHE" | "F_STRING";
                            template_type: "STR" | "CHAT";
                            tools?:
                                | null
                                | {
                                    disable_parallel_tool_calls?: (...)
                                    | (...)
                                    | (...);
                                    tool_choice?: (...) | (...) | (...) | (...) | (...);
                                    tools: (...)[];
                                    type: "tools";
                                };
                        }[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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: { prompt_identifier: string };
            query?: { cursor?: null | string; limit?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            description?: null
                            | string;
                            id: string;
                            invocation_parameters:
                                | {
                                    anthropic: {
                                        max_tokens: ...;
                                        stop_sequences?: ...;
                                        temperature?: ...;
                                        thinking?: ...;
                                        top_p?: ...;
                                    };
                                    type: "anthropic";
                                }
                                | {
                                    aws: { max_tokens?: ...; temperature?: ...; top_p?: ... };
                                    type: "aws";
                                }
                                | {
                                    azure_openai: {
                                        frequency_penalty?: ...;
                                        max_completion_tokens?: ...;
                                        max_tokens?: ...;
                                        presence_penalty?: ...;
                                        reasoning_effort?: ...;
                                        seed?: ...;
                                        temperature?: ...;
                                        top_p?: ...;
                                    };
                                    type: "azure_openai";
                                }
                                | {
                                    deepseek: {
                                        frequency_penalty?: ...;
                                        max_completion_tokens?: ...;
                                        max_tokens?: ...;
                                        presence_penalty?: ...;
                                        reasoning_effort?: ...;
                                        seed?: ...;
                                        temperature?: ...;
                                        top_p?: ...;
                                    };
                                    type: "deepseek";
                                }
                                | {
                                    google: {
                                        frequency_penalty?: ...;
                                        max_output_tokens?: ...;
                                        presence_penalty?: ...;
                                        stop_sequences?: ...;
                                        temperature?: ...;
                                        top_k?: ...;
                                        top_p?: ...;
                                    };
                                    type: "google";
                                }
                                | {
                                    ollama: {
                                        frequency_penalty?: ...;
                                        max_completion_tokens?: ...;
                                        max_tokens?: ...;
                                        presence_penalty?: ...;
                                        reasoning_effort?: ...;
                                        seed?: ...;
                                        temperature?: ...;
                                        top_p?: ...;
                                    };
                                    type: "ollama";
                                }
                                | {
                                    openai: {
                                        frequency_penalty?: ...;
                                        max_completion_tokens?: ...;
                                        max_tokens?: ...;
                                        presence_penalty?: ...;
                                        reasoning_effort?: ...;
                                        seed?: ...;
                                        temperature?: ...;
                                        top_p?: ...;
                                    };
                                    type: "openai";
                                }
                                | {
                                    type: "xai";
                                    xai: {
                                        frequency_penalty?: ...;
                                        max_completion_tokens?: ...;
                                        max_tokens?: ...;
                                        presence_penalty?: ...;
                                        reasoning_effort?: ...;
                                        seed?: ...;
                                        temperature?: ...;
                                        top_p?: ...;
                                    };
                                };
                            model_name: string;
                            model_provider: | "OPENAI"
                            | "AZURE_OPENAI"
                            | "ANTHROPIC"
                            | "GOOGLE"
                            | "DEEPSEEK"
                            | "XAI"
                            | "OLLAMA"
                            | "AWS";
                            response_format?: | null
                            | {
                                json_schema: {
                                    description?: ...;
                                    name: ...;
                                    schema?: ...;
                                    strict?: ...;
                                };
                                type: "json_schema";
                            };
                            template: | { messages: (...)[]; type: "chat" }
                            | { template: string; type: "string" };
                            template_format: "NONE" | "MUSTACHE" | "F_STRING";
                            template_type: "STR" | "CHAT";
                            tools?:
                                | null
                                | {
                                    disable_parallel_tool_calls?: (...)
                                    | (...)
                                    | (...);
                                    tool_choice?: (...) | (...) | (...) | (...) | (...);
                                    tools: (...)[];
                                    type: "tools";
                                };
                        }[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    List prompt versions

    Retrieve all versions of a specific prompt with pagination support. Each prompt can have multiple versions with different configurations.

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { prompt_identifier: string };
          query?: { cursor?: null | string; limit?: number };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { prompt_identifier: string }
        • prompt_identifier: string

          The identifier of the prompt, i.e. name or ID.

      • Optionalquery?: { cursor?: null | string; limit?: number }
        • Optionalcursor?: null | string

          Cursor for pagination (base64-encoded promptVersion ID)

        • Optionallimit?: number

          The max number of prompt versions to return at a time.

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: {
                          description?: null | string;
                          id: string;
                          invocation_parameters:
                              | {
                                  anthropic: {
                                      max_tokens: ...;
                                      stop_sequences?: ...;
                                      temperature?: ...;
                                      thinking?: ...;
                                      top_p?: ...;
                                  };
                                  type: "anthropic";
                              }
                              | {
                                  aws: { max_tokens?: ...; temperature?: ...; top_p?: ... };
                                  type: "aws";
                              }
                              | {
                                  azure_openai: {
                                      frequency_penalty?: ...;
                                      max_completion_tokens?: ...;
                                      max_tokens?: ...;
                                      presence_penalty?: ...;
                                      reasoning_effort?: ...;
                                      seed?: ...;
                                      temperature?: ...;
                                      top_p?: ...;
                                  };
                                  type: "azure_openai";
                              }
                              | {
                                  deepseek: {
                                      frequency_penalty?: ...;
                                      max_completion_tokens?: ...;
                                      max_tokens?: ...;
                                      presence_penalty?: ...;
                                      reasoning_effort?: ...;
                                      seed?: ...;
                                      temperature?: ...;
                                      top_p?: ...;
                                  };
                                  type: "deepseek";
                              }
                              | {
                                  google: {
                                      frequency_penalty?: ...;
                                      max_output_tokens?: ...;
                                      presence_penalty?: ...;
                                      stop_sequences?: ...;
                                      temperature?: ...;
                                      top_k?: ...;
                                      top_p?: ...;
                                  };
                                  type: "google";
                              }
                              | {
                                  ollama: {
                                      frequency_penalty?: ...;
                                      max_completion_tokens?: ...;
                                      max_tokens?: ...;
                                      presence_penalty?: ...;
                                      reasoning_effort?: ...;
                                      seed?: ...;
                                      temperature?: ...;
                                      top_p?: ...;
                                  };
                                  type: "ollama";
                              }
                              | {
                                  openai: {
                                      frequency_penalty?: ...;
                                      max_completion_tokens?: ...;
                                      max_tokens?: ...;
                                      presence_penalty?: ...;
                                      reasoning_effort?: ...;
                                      seed?: ...;
                                      temperature?: ...;
                                      top_p?: ...;
                                  };
                                  type: "openai";
                              }
                              | {
                                  type: "xai";
                                  xai: {
                                      frequency_penalty?: ...;
                                      max_completion_tokens?: ...;
                                      max_tokens?: ...;
                                      presence_penalty?: ...;
                                      reasoning_effort?: ...;
                                      seed?: ...;
                                      temperature?: ...;
                                      top_p?: ...;
                                  };
                              };
                          model_name: string;
                          model_provider: | "OPENAI"
                          | "AZURE_OPENAI"
                          | "ANTHROPIC"
                          | "GOOGLE"
                          | "DEEPSEEK"
                          | "XAI"
                          | "OLLAMA"
                          | "AWS";
                          response_format?: | null
                          | {
                              json_schema: {
                                  description?: ...;
                                  name: ...;
                                  schema?: ...;
                                  strict?: ...;
                              };
                              type: "json_schema";
                          };
                          template: | { messages: (...)[]; type: "chat" }
                          | { template: string; type: "string" };
                          template_format: "NONE" | "MUSTACHE" | "F_STRING";
                          template_type: "STR" | "CHAT";
                          tools?:
                              | null
                              | {
                                  disable_parallel_tool_calls?: (...)
                                  | (...)
                                  | (...);
                                  tool_choice?: (...) | (...) | (...) | (...) | (...);
                                  tools: (...)[];
                                  type: "tools";
                              };
                      }[];
                      next_cursor: null
                      | string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: {
                        description?: null | string;
                        id: string;
                        invocation_parameters:
                            | {
                                anthropic: {
                                    max_tokens: ...;
                                    stop_sequences?: ...;
                                    temperature?: ...;
                                    thinking?: ...;
                                    top_p?: ...;
                                };
                                type: "anthropic";
                            }
                            | {
                                aws: { max_tokens?: ...; temperature?: ...; top_p?: ... };
                                type: "aws";
                            }
                            | {
                                azure_openai: {
                                    frequency_penalty?: ...;
                                    max_completion_tokens?: ...;
                                    max_tokens?: ...;
                                    presence_penalty?: ...;
                                    reasoning_effort?: ...;
                                    seed?: ...;
                                    temperature?: ...;
                                    top_p?: ...;
                                };
                                type: "azure_openai";
                            }
                            | {
                                deepseek: {
                                    frequency_penalty?: ...;
                                    max_completion_tokens?: ...;
                                    max_tokens?: ...;
                                    presence_penalty?: ...;
                                    reasoning_effort?: ...;
                                    seed?: ...;
                                    temperature?: ...;
                                    top_p?: ...;
                                };
                                type: "deepseek";
                            }
                            | {
                                google: {
                                    frequency_penalty?: ...;
                                    max_output_tokens?: ...;
                                    presence_penalty?: ...;
                                    stop_sequences?: ...;
                                    temperature?: ...;
                                    top_k?: ...;
                                    top_p?: ...;
                                };
                                type: "google";
                            }
                            | {
                                ollama: {
                                    frequency_penalty?: ...;
                                    max_completion_tokens?: ...;
                                    max_tokens?: ...;
                                    presence_penalty?: ...;
                                    reasoning_effort?: ...;
                                    seed?: ...;
                                    temperature?: ...;
                                    top_p?: ...;
                                };
                                type: "ollama";
                            }
                            | {
                                openai: {
                                    frequency_penalty?: ...;
                                    max_completion_tokens?: ...;
                                    max_tokens?: ...;
                                    presence_penalty?: ...;
                                    reasoning_effort?: ...;
                                    seed?: ...;
                                    temperature?: ...;
                                    top_p?: ...;
                                };
                                type: "openai";
                            }
                            | {
                                type: "xai";
                                xai: {
                                    frequency_penalty?: ...;
                                    max_completion_tokens?: ...;
                                    max_tokens?: ...;
                                    presence_penalty?: ...;
                                    reasoning_effort?: ...;
                                    seed?: ...;
                                    temperature?: ...;
                                    top_p?: ...;
                                };
                            };
                        model_name: string;
                        model_provider: | "OPENAI"
                        | "AZURE_OPENAI"
                        | "ANTHROPIC"
                        | "GOOGLE"
                        | "DEEPSEEK"
                        | "XAI"
                        | "OLLAMA"
                        | "AWS";
                        response_format?: | null
                        | {
                            json_schema: {
                                description?: ...;
                                name: ...;
                                schema?: ...;
                                strict?: ...;
                            };
                            type: "json_schema";
                        };
                        template: | { messages: (...)[]; type: "chat" }
                        | { template: string; type: "string" };
                        template_format: "NONE" | "MUSTACHE" | "F_STRING";
                        template_type: "STR" | "CHAT";
                        tools?:
                            | null
                            | {
                                disable_parallel_tool_calls?: (...)
                                | (...)
                                | (...);
                                tool_choice?: (...) | (...) | (...) | (...) | (...);
                                tools: (...)[];
                                type: "tools";
                            };
                    }[];
                    next_cursor: null
                    | string;
                };
            };
            headers: { [name: string]: unknown };
        }

        A list of prompt versions with pagination information

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/span_annotations": {
    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?: { sync?: boolean };
        };
        requestBody: {
            content: {
                "application/json": {
                    data: {
                        annotator_kind: "LLM"
                        | "CODE"
                        | "HUMAN";
                        identifier?: string;
                        metadata?: null | { [key: string]: unknown };
                        name: string;
                        result?:
                            | null
                            | {
                                explanation?: null
                                | string;
                                label?: null | string;
                                score?: null | number;
                            };
                        span_id: string;
                    }[];
                };
            };
        };
        responses: {
            "200": {
                content: { "application/json": { data: { id: string }[] } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                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 }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { sync?: boolean };
        };
        requestBody: {
            content: {
                "application/json": {
                    data: {
                        annotator_kind: "LLM"
                        | "CODE"
                        | "HUMAN";
                        identifier?: string;
                        metadata?: null | { [key: string]: unknown };
                        name: string;
                        result?:
                            | null
                            | {
                                explanation?: null
                                | string;
                                label?: null | string;
                                score?: null | number;
                            };
                        span_id: string;
                    }[];
                };
            };
        };
        responses: {
            "200": {
                content: { "application/json": { data: { id: string }[] } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Create span annotations

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: { sync?: boolean };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: { sync?: boolean }
        • Optionalsync?: boolean

          If true, fulfill request synchronously.

    • requestBody: {
          content: {
              "application/json": {
                  data: {
                      annotator_kind: "LLM" | "CODE" | "HUMAN";
                      identifier?: string;
                      metadata?: null | { [key: string]: unknown };
                      name: string;
                      result?:
                          | null
                          | {
                              explanation?: null
                              | string;
                              label?: null | string;
                              score?: null | number;
                          };
                      span_id: string;
                  }[];
              };
          };
      }
    • responses: {
          "200": {
              content: { "application/json": { data: { id: string }[] } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: { "application/json": { data: { id: string }[] } };
            headers: { [name: string]: unknown };
        }

        Span annotations inserted successfully

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Span not found

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/spans/{span_identifier}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { span_identifier: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    get?: undefined;
    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: { span_identifier: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Delete a span by span_identifier

    Delete a single span by identifier.

            **Important**: This operation deletes ONLY the specified span itself and does NOT
            delete its descendants/children. All child spans will remain in the trace and
            become orphaned (their parent_id will point to a non-existent span).
    
            Behavior:
            - Deletes only the target span (preserves all descendant spans)
            - If this was the last span in the trace, the trace record is also deleted
            - If the deleted span had a parent, its cumulative metrics (error count, token counts)
              are subtracted from all ancestor spans in the chain
    
            **Note**: This operation is irreversible and may create orphaned spans.
    
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { span_identifier: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { span_identifier: string }
        • span_identifier: string

          The span identifier: either a relay GlobalID or OpenTelemetry span_id

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "204": { content?: undefined; headers: { [name: string]: unknown } };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 204: { content?: undefined; headers: { [name: string]: unknown } }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/traces/{trace_identifier}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { trace_identifier: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    get?: undefined;
    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: { trace_identifier: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Delete a trace by identifier

    Delete an entire trace by its identifier. The identifier can be either: 1. A Relay node ID (base64-encoded) 2. An OpenTelemetry trace_id (hex string)

    This will permanently remove all spans in the trace and their associated data.
    
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { trace_identifier: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { trace_identifier: string }
        • trace_identifier: string

          The trace identifier: either a relay GlobalID or OpenTelemetry trace_id

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "204": { content?: undefined; headers: { [name: string]: unknown } };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 204: { content?: undefined; headers: { [name: string]: unknown } }

        Successful Response

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Not Found

      • 422: {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        Validation Error

  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/users": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { cursor?: string; limit?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: (
                            | {
                                auth_method: "LOCAL";
                                created_at: string;
                                email: string;
                                id: string;
                                password?: string;
                                password_needs_reset: boolean;
                                role: "SYSTEM"
                                | "ADMIN"
                                | "MEMBER";
                                updated_at: string;
                                username: string;
                            }
                            | {
                                auth_method: "OAUTH2";
                                created_at: string;
                                email: string;
                                id: string;
                                oauth2_client_id?: string;
                                oauth2_user_id?: string;
                                profile_picture_url?: string;
                                role: "SYSTEM"
                                | "ADMIN"
                                | "MEMBER";
                                updated_at: string;
                                username: string;
                            }
                        )[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                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": {
                    send_welcome_email?: boolean;
                    user: | {
                        auth_method: "LOCAL";
                        email: string;
                        password?: string;
                        role: "SYSTEM"
                        | "ADMIN"
                        | "MEMBER";
                        username: string;
                    }
                    | {
                        auth_method: "OAUTH2";
                        email: string;
                        oauth2_client_id?: string;
                        oauth2_user_id?: string;
                        role: "SYSTEM"
                        | "ADMIN"
                        | "MEMBER";
                        username: string;
                    };
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        data: | {
                            auth_method: "LOCAL";
                            created_at: string;
                            email: string;
                            id: string;
                            password?: string;
                            password_needs_reset: boolean;
                            role: "SYSTEM"
                            | "ADMIN"
                            | "MEMBER";
                            updated_at: string;
                            username: string;
                        }
                        | {
                            auth_method: "OAUTH2";
                            created_at: string;
                            email: string;
                            id: string;
                            oauth2_client_id?: string;
                            oauth2_user_id?: string;
                            profile_picture_url?: string;
                            role: "SYSTEM"
                            | "ADMIN"
                            | "MEMBER";
                            updated_at: string;
                            username: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "409": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { cursor?: string; limit?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        data: (
                            | {
                                auth_method: "LOCAL";
                                created_at: string;
                                email: string;
                                id: string;
                                password?: string;
                                password_needs_reset: boolean;
                                role: "SYSTEM"
                                | "ADMIN"
                                | "MEMBER";
                                updated_at: string;
                                username: string;
                            }
                            | {
                                auth_method: "OAUTH2";
                                created_at: string;
                                email: string;
                                id: string;
                                oauth2_client_id?: string;
                                oauth2_user_id?: string;
                                profile_picture_url?: string;
                                role: "SYSTEM"
                                | "ADMIN"
                                | "MEMBER";
                                updated_at: string;
                                username: string;
                            }
                        )[];
                        next_cursor: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    List all users

    Retrieve a paginated list of all users in the system.

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: { cursor?: string; limit?: number };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: { cursor?: string; limit?: number }
        • Optionalcursor?: string

          Cursor for pagination (base64-encoded user ID)

        • Optionallimit?: number

          The max number of users to return at a time.

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      data: (
                          | {
                              auth_method: "LOCAL";
                              created_at: string;
                              email: string;
                              id: string;
                              password?: string;
                              password_needs_reset: boolean;
                              role: "SYSTEM"
                              | "ADMIN"
                              | "MEMBER";
                              updated_at: string;
                              username: string;
                          }
                          | {
                              auth_method: "OAUTH2";
                              created_at: string;
                              email: string;
                              id: string;
                              oauth2_client_id?: string;
                              oauth2_user_id?: string;
                              profile_picture_url?: string;
                              role: "SYSTEM"
                              | "ADMIN"
                              | "MEMBER";
                              updated_at: string;
                              username: string;
                          }
                      )[];
                      next_cursor: null
                      | string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    data: (
                        | {
                            auth_method: "LOCAL";
                            created_at: string;
                            email: string;
                            id: string;
                            password?: string;
                            password_needs_reset: boolean;
                            role: "SYSTEM"
                            | "ADMIN"
                            | "MEMBER";
                            updated_at: string;
                            username: string;
                        }
                        | {
                            auth_method: "OAUTH2";
                            created_at: string;
                            email: string;
                            id: string;
                            oauth2_client_id?: string;
                            oauth2_user_id?: string;
                            profile_picture_url?: string;
                            role: "SYSTEM"
                            | "ADMIN"
                            | "MEMBER";
                            updated_at: string;
                            username: string;
                        }
                    )[];
                    next_cursor: null
                    | string;
                };
            };
            headers: { [name: string]: unknown };
        }

        A list of users.

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    send_welcome_email?: boolean;
                    user: | {
                        auth_method: "LOCAL";
                        email: string;
                        password?: string;
                        role: "SYSTEM"
                        | "ADMIN"
                        | "MEMBER";
                        username: string;
                    }
                    | {
                        auth_method: "OAUTH2";
                        email: string;
                        oauth2_client_id?: string;
                        oauth2_user_id?: string;
                        role: "SYSTEM"
                        | "ADMIN"
                        | "MEMBER";
                        username: string;
                    };
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        data: | {
                            auth_method: "LOCAL";
                            created_at: string;
                            email: string;
                            id: string;
                            password?: string;
                            password_needs_reset: boolean;
                            role: "SYSTEM"
                            | "ADMIN"
                            | "MEMBER";
                            updated_at: string;
                            username: string;
                        }
                        | {
                            auth_method: "OAUTH2";
                            created_at: string;
                            email: string;
                            id: string;
                            oauth2_client_id?: string;
                            oauth2_user_id?: string;
                            profile_picture_url?: string;
                            role: "SYSTEM"
                            | "ADMIN"
                            | "MEMBER";
                            updated_at: string;
                            username: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "409": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Create a new user

    Create a new user with the specified configuration.

    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • requestBody: {
          content: {
              "application/json": {
                  send_welcome_email?: boolean;
                  user:
                      | {
                          auth_method: "LOCAL";
                          email: string;
                          password?: string;
                          role: "SYSTEM"
                          | "ADMIN"
                          | "MEMBER";
                          username: string;
                      }
                      | {
                          auth_method: "OAUTH2";
                          email: string;
                          oauth2_client_id?: string;
                          oauth2_user_id?: string;
                          role: "SYSTEM"
                          | "ADMIN"
                          | "MEMBER";
                          username: string;
                      };
              };
          };
      }
    • responses: {
          "201": {
              content: {
                  "application/json": {
                      data:
                          | {
                              auth_method: "LOCAL";
                              created_at: string;
                              email: string;
                              id: string;
                              password?: string;
                              password_needs_reset: boolean;
                              role: "SYSTEM"
                              | "ADMIN"
                              | "MEMBER";
                              updated_at: string;
                              username: string;
                          }
                          | {
                              auth_method: "OAUTH2";
                              created_at: string;
                              email: string;
                              id: string;
                              oauth2_client_id?: string;
                              oauth2_user_id?: string;
                              profile_picture_url?: string;
                              role: "SYSTEM"
                              | "ADMIN"
                              | "MEMBER";
                              updated_at: string;
                              username: string;
                          };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "409": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 201: {
            content: {
                "application/json": {
                    data:
                        | {
                            auth_method: "LOCAL";
                            created_at: string;
                            email: string;
                            id: string;
                            password?: string;
                            password_needs_reset: boolean;
                            role: "SYSTEM"
                            | "ADMIN"
                            | "MEMBER";
                            updated_at: string;
                            username: string;
                        }
                        | {
                            auth_method: "OAUTH2";
                            created_at: string;
                            email: string;
                            id: string;
                            oauth2_client_id?: string;
                            oauth2_user_id?: string;
                            profile_picture_url?: string;
                            role: "SYSTEM"
                            | "ADMIN"
                            | "MEMBER";
                            updated_at: string;
                            username: string;
                        };
                };
            };
            headers: { [name: string]: unknown };
        }

        The newly created user.

      • 400: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Role not found.

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Forbidden

      • 409: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Username or email already exists.

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/v1/users/{user_id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { user_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    };
    get?: undefined;
    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: { user_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "403": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "text/plain": string };
                headers: { [name: string]: unknown };
            };
        };
    }

    Delete a user by ID

    Delete an existing user by their unique GlobalID.

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

          The GlobalID of the user (e.g. 'VXNlcjox').

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "204": { content?: undefined; headers: { [name: string]: unknown } };
          "403": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
          "422": {
              content: { "text/plain": string };
              headers: { [name: string]: unknown };
          };
      }
      • 204: { content?: undefined; headers: { [name: string]: unknown } }

        No content returned on successful deletion.

      • 403: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Cannot delete the default admin or system user

      • 404: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        User not found.

      • 422: { content: { "text/plain": string }; headers: { [name: string]: unknown } }

        Unprocessable Entity

  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined