Class LangfusePublicApi<SecurityDataType>

Title

langfuse

Authentication

Authenticate with the API using Basic Auth, get API keys in the project settings:

username: Langfuse Public Key
password: Langfuse Secret Key

Exports

OpenAPI spec: https://cloud.langfuse.com/generated/api/openapi.yml
Postman collection: https://cloud.langfuse.com/generated/postman/collection.json

Type Parameters

SecurityDataType extends unknown

Hierarchy (view full)

HttpClient<SecurityDataType>
- LangfusePublicApi

Index

Constructors

constructor

new LangfusePublicApi<SecurityDataType>(apiConfig?): LangfusePublicApi<SecurityDataType>
Type Parameters
- SecurityDataType extends unknown
Parameters
- apiConfig: ApiConfig<SecurityDataType> = {}
Returns LangfusePublicApi<SecurityDataType>
Inherited from HttpClient.constructor
- Defined in langfuse/src/publicApi.ts:1538

Properties

api

api: {
    commentsCreate: ((data: ApiCreateCommentRequest, params?: RequestParams) => Promise<ApiCreateCommentResponse>);
    commentsGet: ((query: ApiCommentsGetParams, params?: RequestParams) => Promise<ApiGetCommentsResponse>);
    commentsGetById: ((commentId: string, params?: RequestParams) => Promise<ApiComment>);
    datasetItemsCreate: ((data: ApiCreateDatasetItemRequest, params?: RequestParams) => Promise<ApiDatasetItem>);
    datasetItemsGet: ((id: string, params?: RequestParams) => Promise<ApiDatasetItem>);
    datasetItemsList: ((query: ApiDatasetItemsListParams, params?: RequestParams) => Promise<ApiPaginatedDatasetItems>);
    datasetRunItemsCreate: ((data: ApiCreateDatasetRunItemRequest, params?: RequestParams) => Promise<ApiDatasetRunItem>);
    datasetsCreate: ((data: ApiCreateDatasetRequest, params?: RequestParams) => Promise<ApiDataset>);
    datasetsGet: ((datasetName: string, params?: RequestParams) => Promise<ApiDataset>);
    datasetsGetRun: ((datasetName: string, runName: string, params?: RequestParams) => Promise<ApiDatasetRunWithItems>);
    datasetsGetRuns: ((__namedParameters: ApiDatasetsGetRunsParams, params?: RequestParams) => Promise<ApiPaginatedDatasetRuns>);
    datasetsList: ((query: ApiDatasetsListParams, params?: RequestParams) => Promise<ApiPaginatedDatasets>);
    healthHealth: ((params?: RequestParams) => Promise<ApiHealthResponse>);
    ingestionBatch: ((data: ApiIngestionBatchPayload, params?: RequestParams) => Promise<ApiIngestionResponse>);
    mediaGet: ((mediaId: string, params?: RequestParams) => Promise<ApiGetMediaResponse>);
    mediaGetUploadUrl: ((data: ApiGetMediaUploadUrlRequest, params?: RequestParams) => Promise<ApiGetMediaUploadUrlResponse>);
    mediaPatch: ((mediaId: string, data: ApiPatchMediaBody, params?: RequestParams) => Promise<void>);
    metricsDaily: ((query: ApiMetricsDailyParams, params?: RequestParams) => Promise<ApiDailyMetrics>);
    modelsCreate: ((data: ApiCreateModelRequest, params?: RequestParams) => Promise<ApiModel>);
    modelsDelete: ((id: string, params?: RequestParams) => Promise<void>);
    modelsGet: ((id: string, params?: RequestParams) => Promise<ApiModel>);
    modelsList: ((query: ApiModelsListParams, params?: RequestParams) => Promise<ApiPaginatedModels>);
    observationsGet: ((observationId: string, params?: RequestParams) => Promise<ApiObservationsView>);
    observationsGetMany: ((query: ApiObservationsGetManyParams, params?: RequestParams) => Promise<ApiObservationsViews>);
    projectsGet: ((params?: RequestParams) => Promise<ApiProjects>);
    promptsCreate: ((data: ApiCreatePromptRequest, params?: RequestParams) => Promise<ApiPrompt>);
    promptsGet: ((__namedParameters: ApiPromptsGetParams, params?: RequestParams) => Promise<ApiPrompt>);
    promptsList: ((query: ApiPromptsListParams, params?: RequestParams) => Promise<ApiPromptMetaListResponse>);
    promptVersionUpdate: ((name: string, version: number, data: ApiPromptVersionUpdatePayload, params?: RequestParams) => Promise<ApiPrompt>);
    scoreConfigsCreate: ((data: ApiCreateScoreConfigRequest, params?: RequestParams) => Promise<ApiScoreConfig>);
    scoreConfigsGet: ((query: ApiScoreConfigsGetParams, params?: RequestParams) => Promise<ApiScoreConfigs>);
    scoreConfigsGetById: ((configId: string, params?: RequestParams) => Promise<ApiScoreConfig>);
    scoreCreate: ((data: ApiCreateScoreRequest, params?: RequestParams) => Promise<ApiCreateScoreResponse>);
    scoreDelete: ((scoreId: string, params?: RequestParams) => Promise<void>);
    scoreGet: ((query: ApiScoreGetParams, params?: RequestParams) => Promise<ApiGetScoresResponse>);
    scoreGetById: ((scoreId: string, params?: RequestParams) => Promise<ApiScore>);
    sessionsGet: ((sessionId: string, params?: RequestParams) => Promise<ApiSessionWithTraces>);
    sessionsList: ((query: ApiSessionsListParams, params?: RequestParams) => Promise<ApiPaginatedSessions>);
    traceGet: ((traceId: string, params?: RequestParams) => Promise<ApiTraceWithFullDetails>);
    traceList: ((query: ApiTraceListParams, params?: RequestParams) => Promise<ApiTraces>);
} = ...

Type declaration

commentsCreate: ((data: ApiCreateCommentRequest, params?: RequestParams) => Promise<ApiCreateCommentResponse>)
Description
Create a comment. Comments may be attached to different object types (trace, observation, session, prompt).

Tags
Comments

Name
CommentsCreate

Request
POST:/api/public/comments

Secure
- - (data, params?): Promise<ApiCreateCommentResponse>
  - Parameters
    - data: ApiCreateCommentRequest
    - params: RequestParams = {}
    Returns Promise<ApiCreateCommentResponse>
commentsGet: ((query: ApiCommentsGetParams, params?: RequestParams) => Promise<ApiGetCommentsResponse>)
Description
Get all comments

Tags
Comments

Name
CommentsGet

Request
GET:/api/public/comments

Secure
- - (query, params?): Promise<ApiGetCommentsResponse>
  - Parameters
    - query: ApiCommentsGetParams
    - params: RequestParams = {}
    Returns Promise<ApiGetCommentsResponse>
commentsGetById: ((commentId: string, params?: RequestParams) => Promise<ApiComment>)
Description
Get a comment by id

Tags
Comments

Name
CommentsGetById

Request
GET:/api/public/comments/{commentId}

Secure
- - (commentId, params?): Promise<ApiComment>
  - Parameters
    - commentId: string
    - params: RequestParams = {}
    Returns Promise<ApiComment>
datasetItemsCreate: ((data: ApiCreateDatasetItemRequest, params?: RequestParams) => Promise<ApiDatasetItem>)
Description
Create a dataset item

Tags
DatasetItems

Name
DatasetItemsCreate

Request
POST:/api/public/dataset-items

Secure
- - (data, params?): Promise<ApiDatasetItem>
  - Parameters
    - data: ApiCreateDatasetItemRequest
    - params: RequestParams = {}
    Returns Promise<ApiDatasetItem>
datasetItemsGet: ((id: string, params?: RequestParams) => Promise<ApiDatasetItem>)
Description
Get a dataset item

Tags
DatasetItems

Name
DatasetItemsGet

Request
GET:/api/public/dataset-items/{id}

Secure
- - (id, params?): Promise<ApiDatasetItem>
  - Parameters
    - id: string
    - params: RequestParams = {}
    Returns Promise<ApiDatasetItem>
datasetItemsList: ((query: ApiDatasetItemsListParams, params?: RequestParams) => Promise<ApiPaginatedDatasetItems>)
Description
Get dataset items

Tags
DatasetItems

Name
DatasetItemsList

Request
GET:/api/public/dataset-items

Secure
- - (query, params?): Promise<ApiPaginatedDatasetItems>
  - Parameters
    - query: ApiDatasetItemsListParams
    - params: RequestParams = {}
    Returns Promise<ApiPaginatedDatasetItems>
datasetRunItemsCreate: ((data: ApiCreateDatasetRunItemRequest, params?: RequestParams) => Promise<ApiDatasetRunItem>)
Description
Create a dataset run item

Tags
DatasetRunItems

Name
DatasetRunItemsCreate

Request
POST:/api/public/dataset-run-items

Secure
- - (data, params?): Promise<ApiDatasetRunItem>
  - Parameters
    - data: ApiCreateDatasetRunItemRequest
    - params: RequestParams = {}
    Returns Promise<ApiDatasetRunItem>
datasetsCreate: ((data: ApiCreateDatasetRequest, params?: RequestParams) => Promise<ApiDataset>)
Description
Create a dataset

Tags
Datasets

Name
DatasetsCreate

Request
POST:/api/public/v2/datasets

Secure
- - (data, params?): Promise<ApiDataset>
  - Parameters
    - data: ApiCreateDatasetRequest
    - params: RequestParams = {}
    Returns Promise<ApiDataset>
datasetsGet: ((datasetName: string, params?: RequestParams) => Promise<ApiDataset>)
Description
Get a dataset

Tags
Datasets

Name
DatasetsGet

Request
GET:/api/public/v2/datasets/{datasetName}

Secure
- - (datasetName, params?): Promise<ApiDataset>
  - Parameters
    - datasetName: string
    - params: RequestParams = {}
    Returns Promise<ApiDataset>
datasetsGetRun: ((datasetName: string, runName: string, params?: RequestParams) => Promise<ApiDatasetRunWithItems>)
Description
Get a dataset run and its items

Tags
Datasets

Name
DatasetsGetRun

Request
GET:/api/public/datasets/{datasetName}/runs/{runName}

Secure
- - (datasetName, runName, params?): Promise<ApiDatasetRunWithItems>
  - Parameters
    - datasetName: string
    - runName: string
    - params: RequestParams = {}
    Returns Promise<ApiDatasetRunWithItems>
datasetsGetRuns: ((__namedParameters: ApiDatasetsGetRunsParams, params?: RequestParams) => Promise<ApiPaginatedDatasetRuns>)
Description
Get dataset runs

Tags
Datasets

Name
DatasetsGetRuns

Request
GET:/api/public/datasets/{datasetName}/runs

Secure
- - (__namedParameters, params?): Promise<ApiPaginatedDatasetRuns>
  - Parameters
    - __namedParameters: ApiDatasetsGetRunsParams
    - params: RequestParams = {}
    Returns Promise<ApiPaginatedDatasetRuns>
datasetsList: ((query: ApiDatasetsListParams, params?: RequestParams) => Promise<ApiPaginatedDatasets>)
Description
Get all datasets

Tags
Datasets

Name
DatasetsList

Request
GET:/api/public/v2/datasets

Secure
- - (query, params?): Promise<ApiPaginatedDatasets>
  - Parameters
    - query: ApiDatasetsListParams
    - params: RequestParams = {}
    Returns Promise<ApiPaginatedDatasets>
healthHealth: ((params?: RequestParams) => Promise<ApiHealthResponse>)
Description
Check health of API and database

Tags
Health

Name
HealthHealth

Request
GET:/api/public/health
- - (params?): Promise<ApiHealthResponse>
  - Parameters
    - params: RequestParams = {}
    Returns Promise<ApiHealthResponse>
ingestionBatch: ((data: ApiIngestionBatchPayload, params?: RequestParams) => Promise<ApiIngestionResponse>)
Description
Batched ingestion for Langfuse Tracing. If you want to use tracing via the API, such as to build your own Langfuse client implementation, this is the only API route you need to implement. Notes: - Introduction to data model: https://langfuse.com/docs/tracing-data-model - Batch sizes are limited to 3.5 MB in total. You need to adjust the number of events per batch accordingly. - The API does not return a 4xx status code for input errors. Instead, it responds with a 207 status code, which includes a list of the encountered errors.

Tags
Ingestion

Name
IngestionBatch

Request
POST:/api/public/ingestion

Secure
- - (data, params?): Promise<ApiIngestionResponse>
  - Parameters
    - data: ApiIngestionBatchPayload
    - params: RequestParams = {}
    Returns Promise<ApiIngestionResponse>
mediaGet: ((mediaId: string, params?: RequestParams) => Promise<ApiGetMediaResponse>)
Description
Get a media record

Tags
Media

Name
MediaGet

Request
GET:/api/public/media/{mediaId}

Secure
- - (mediaId, params?): Promise<ApiGetMediaResponse>
  - Parameters
    - mediaId: string
    - params: RequestParams = {}
    Returns Promise<ApiGetMediaResponse>
mediaGetUploadUrl: ((data: ApiGetMediaUploadUrlRequest, params?: RequestParams) => Promise<ApiGetMediaUploadUrlResponse>)
Description
Get a presigned upload URL for a media record

Tags
Media

Name
MediaGetUploadUrl

Request
POST:/api/public/media

Secure
- - (data, params?): Promise<ApiGetMediaUploadUrlResponse>
  - Parameters
    - data: ApiGetMediaUploadUrlRequest
    - params: RequestParams = {}
    Returns Promise<ApiGetMediaUploadUrlResponse>
mediaPatch: ((mediaId: string, data: ApiPatchMediaBody, params?: RequestParams) => Promise<void>)
Description
Patch a media record

Tags
Media

Name
MediaPatch

Request
PATCH:/api/public/media/{mediaId}

Secure
- - (mediaId, data, params?): Promise<void>
  - Parameters
    - mediaId: string
    - data: ApiPatchMediaBody
    - params: RequestParams = {}
    Returns Promise<void>
metricsDaily: ((query: ApiMetricsDailyParams, params?: RequestParams) => Promise<ApiDailyMetrics>)
Description
Get daily metrics of the Langfuse project

Tags
Metrics

Name
MetricsDaily

Request
GET:/api/public/metrics/daily

Secure
- - (query, params?): Promise<ApiDailyMetrics>
  - Parameters
    - query: ApiMetricsDailyParams
    - params: RequestParams = {}
    Returns Promise<ApiDailyMetrics>
modelsCreate: ((data: ApiCreateModelRequest, params?: RequestParams) => Promise<ApiModel>)
Description
Create a model

Tags
Models

Name
ModelsCreate

Request
POST:/api/public/models

Secure
- - (data, params?): Promise<ApiModel>
  - Parameters
    - data: ApiCreateModelRequest
    - params: RequestParams = {}
    Returns Promise<ApiModel>
modelsDelete: ((id: string, params?: RequestParams) => Promise<void>)
Description
Delete a model. Cannot delete models managed by Langfuse. You can create your own definition with the same modelName to override the definition though.

Tags
Models

Name
ModelsDelete

Request
DELETE:/api/public/models/{id}

Secure
- - (id, params?): Promise<void>
  - Parameters
    - id: string
    - params: RequestParams = {}
    Returns Promise<void>
modelsGet: ((id: string, params?: RequestParams) => Promise<ApiModel>)
Description
Get a model

Tags
Models

Name
ModelsGet

Request
GET:/api/public/models/{id}

Secure
- - (id, params?): Promise<ApiModel>
  - Parameters
    - id: string
    - params: RequestParams = {}
    Returns Promise<ApiModel>
modelsList: ((query: ApiModelsListParams, params?: RequestParams) => Promise<ApiPaginatedModels>)
Description
Get all models

Tags
Models

Name
ModelsList

Request
GET:/api/public/models

Secure
- - (query, params?): Promise<ApiPaginatedModels>
  - Parameters
    - query: ApiModelsListParams
    - params: RequestParams = {}
    Returns Promise<ApiPaginatedModels>
observationsGet: ((observationId: string, params?: RequestParams) => Promise<ApiObservationsView>)
Description
Get a observation

Tags
Observations

Name
ObservationsGet

Request
GET:/api/public/observations/{observationId}

Secure
- - (observationId, params?): Promise<ApiObservationsView>
  - Parameters
    - observationId: string
    - params: RequestParams = {}
    Returns Promise<ApiObservationsView>
observationsGetMany: ((query: ApiObservationsGetManyParams, params?: RequestParams) => Promise<ApiObservationsViews>)
Description
Get a list of observations

Tags
Observations

Name
ObservationsGetMany

Request
GET:/api/public/observations

Secure
- - (query, params?): Promise<ApiObservationsViews>
  - Parameters
    - query: ApiObservationsGetManyParams
    - params: RequestParams = {}
    Returns Promise<ApiObservationsViews>
projectsGet: ((params?: RequestParams) => Promise<ApiProjects>)
Description
Get Project associated with API key

Tags
Projects

Name
ProjectsGet

Request
GET:/api/public/projects

Secure
- - (params?): Promise<ApiProjects>
  - Parameters
    - params: RequestParams = {}
    Returns Promise<ApiProjects>
promptsCreate: ((data: ApiCreatePromptRequest, params?: RequestParams) => Promise<ApiPrompt>)
Description
Create a new version for the prompt with the given name

Tags
Prompts

Name
PromptsCreate

Request
POST:/api/public/v2/prompts

Secure
- - (data, params?): Promise<ApiPrompt>
  - Parameters
    - data: ApiCreatePromptRequest
    - params: RequestParams = {}
    Returns Promise<ApiPrompt>
promptsGet: ((__namedParameters: ApiPromptsGetParams, params?: RequestParams) => Promise<ApiPrompt>)
Description
Get a prompt

Tags
Prompts

Name
PromptsGet

Request
GET:/api/public/v2/prompts/{promptName}

Secure
- - (__namedParameters, params?): Promise<ApiPrompt>
  - Parameters
    - __namedParameters: ApiPromptsGetParams
    - params: RequestParams = {}
    Returns Promise<ApiPrompt>
promptsList: ((query: ApiPromptsListParams, params?: RequestParams) => Promise<ApiPromptMetaListResponse>)
Description
Get a list of prompt names with versions and labels

Tags
Prompts

Name
PromptsList

Request
GET:/api/public/v2/prompts

Secure
- - (query, params?): Promise<ApiPromptMetaListResponse>
  - Parameters
    - query: ApiPromptsListParams
    - params: RequestParams = {}
    Returns Promise<ApiPromptMetaListResponse>
promptVersionUpdate: ((name: string, version: number, data: ApiPromptVersionUpdatePayload, params?: RequestParams) => Promise<ApiPrompt>)
Description
Update labels for a specific prompt version

Tags
PromptVersion

Name
PromptVersionUpdate

Request
PATCH:/api/public/v2/prompts/{name}/versions/{version}

Secure
- - (name, version, data, params?): Promise<ApiPrompt>
  - Parameters
    - name: string
    - version: number
    - data: ApiPromptVersionUpdatePayload
    - params: RequestParams = {}
    Returns Promise<ApiPrompt>
scoreConfigsCreate: ((data: ApiCreateScoreConfigRequest, params?: RequestParams) => Promise<ApiScoreConfig>)
Description
Create a score configuration (config). Score configs are used to define the structure of scores

Tags
ScoreConfigs

Name
ScoreConfigsCreate

Request
POST:/api/public/score-configs

Secure
- - (data, params?): Promise<ApiScoreConfig>
  - Parameters
    - data: ApiCreateScoreConfigRequest
    - params: RequestParams = {}
    Returns Promise<ApiScoreConfig>
scoreConfigsGet: ((query: ApiScoreConfigsGetParams, params?: RequestParams) => Promise<ApiScoreConfigs>)
Description
Get all score configs

Tags
ScoreConfigs

Name
ScoreConfigsGet

Request
GET:/api/public/score-configs

Secure
- - (query, params?): Promise<ApiScoreConfigs>
  - Parameters
    - query: ApiScoreConfigsGetParams
    - params: RequestParams = {}
    Returns Promise<ApiScoreConfigs>
scoreConfigsGetById: ((configId: string, params?: RequestParams) => Promise<ApiScoreConfig>)
Description
Get a score config

Tags
ScoreConfigs

Name
ScoreConfigsGetById

Request
GET:/api/public/score-configs/{configId}

Secure
- - (configId, params?): Promise<ApiScoreConfig>
  - Parameters
    - configId: string
    - params: RequestParams = {}
    Returns Promise<ApiScoreConfig>
scoreCreate: ((data: ApiCreateScoreRequest, params?: RequestParams) => Promise<ApiCreateScoreResponse>)
Description
Create a score

Tags
Score

Name
ScoreCreate

Request
POST:/api/public/scores

Secure
- - (data, params?): Promise<ApiCreateScoreResponse>
  - Parameters
    - data: ApiCreateScoreRequest
    - params: RequestParams = {}
    Returns Promise<ApiCreateScoreResponse>
scoreDelete: ((scoreId: string, params?: RequestParams) => Promise<void>)
Description
Delete a score

Tags
Score

Name
ScoreDelete

Request
DELETE:/api/public/scores/{scoreId}

Secure
- - (scoreId, params?): Promise<void>
  - Parameters
    - scoreId: string
    - params: RequestParams = {}
    Returns Promise<void>
scoreGet: ((query: ApiScoreGetParams, params?: RequestParams) => Promise<ApiGetScoresResponse>)
Description
Get a list of scores

Tags
Score

Name
ScoreGet

Request
GET:/api/public/scores

Secure
- - (query, params?): Promise<ApiGetScoresResponse>
  - Parameters
    - query: ApiScoreGetParams
    - params: RequestParams = {}
    Returns Promise<ApiGetScoresResponse>
scoreGetById: ((scoreId: string, params?: RequestParams) => Promise<ApiScore>)
Description
Get a score

Tags
Score

Name
ScoreGetById

Request
GET:/api/public/scores/{scoreId}

Secure
- - (scoreId, params?): Promise<ApiScore>
  - Parameters
    - scoreId: string
    - params: RequestParams = {}
    Returns Promise<ApiScore>
sessionsGet: ((sessionId: string, params?: RequestParams) => Promise<ApiSessionWithTraces>)
Description
Get a session. Please note that traces on this endpoint are not paginated, if you plan to fetch large sessions, consider GET /api/public/traces?sessionId=<sessionId>

Tags
Sessions

Name
SessionsGet

Request
GET:/api/public/sessions/{sessionId}

Secure
- - (sessionId, params?): Promise<ApiSessionWithTraces>
  - Parameters
    - sessionId: string
    - params: RequestParams = {}
    Returns Promise<ApiSessionWithTraces>
sessionsList: ((query: ApiSessionsListParams, params?: RequestParams) => Promise<ApiPaginatedSessions>)
Description
Get sessions

Tags
Sessions

Name
SessionsList

Request
GET:/api/public/sessions

Secure
- - (query, params?): Promise<ApiPaginatedSessions>
  - Parameters
    - query: ApiSessionsListParams
    - params: RequestParams = {}
    Returns Promise<ApiPaginatedSessions>
traceGet: ((traceId: string, params?: RequestParams) => Promise<ApiTraceWithFullDetails>)
Description
Get a specific trace

Tags
Trace

Name
TraceGet

Request
GET:/api/public/traces/{traceId}

Secure
- - (traceId, params?): Promise<ApiTraceWithFullDetails>
  - Parameters
    - traceId: string
    - params: RequestParams = {}
    Returns Promise<ApiTraceWithFullDetails>
traceList: ((query: ApiTraceListParams, params?: RequestParams) => Promise<ApiTraces>)
Description
Get list of traces

Tags
Trace

Name
TraceList

Request
GET:/api/public/traces

Secure
- - (query, params?): Promise<ApiTraces>
  - Parameters
    - query: ApiTraceListParams
    - params: RequestParams = {}
    Returns Promise<ApiTraces>

baseUrl

baseUrl: string = ""

Methods

abortRequest

abortRequest(cancelToken): void
Parameters
- cancelToken: CancelToken
Returns void
Inherited from HttpClient.abortRequest
- Defined in langfuse/src/publicApi.ts:1620

`Protected`addArrayQueryParam

addArrayQueryParam(query, key): any
Parameters
- query: QueryParamsType
- key: string
Returns any
Inherited from HttpClient.addArrayQueryParam
- Defined in langfuse/src/publicApi.ts:1555

`Protected`addQueryParam

addQueryParam(query, key): string
Parameters
- query: QueryParamsType
- key: string
Returns string
Inherited from HttpClient.addQueryParam
- Defined in langfuse/src/publicApi.ts:1551

`Protected`addQueryParams

addQueryParams(rawQuery?): string
Parameters
- OptionalrawQuery: QueryParamsType
Returns string
Inherited from HttpClient.addQueryParams
- Defined in langfuse/src/publicApi.ts:1568

`Protected`createAbortSignal

createAbortSignal(cancelToken): undefined | AbortSignal
Parameters
- cancelToken: CancelToken
Returns undefined | AbortSignal
Inherited from HttpClient.createAbortSignal
- Defined in langfuse/src/publicApi.ts:1606

`Protected`encodeQueryParam

encodeQueryParam(key, value): string
Parameters
- key: string
- value: any
Returns string
Inherited from HttpClient.encodeQueryParam
- Defined in langfuse/src/publicApi.ts:1546

`Protected`mergeRequestParams

mergeRequestParams(params1, params2?): RequestParams
Parameters
- params1: RequestParams
- Optionalparams2: RequestParams
Returns RequestParams
Inherited from HttpClient.mergeRequestParams
- Defined in langfuse/src/publicApi.ts:1593

request

request<T, E>(__namedParameters): Promise<T>
Type Parameters
- T = any
- E = any
Parameters
- __namedParameters: FullRequestParams
Returns Promise<T>
Inherited from HttpClient.request
- Defined in langfuse/src/publicApi.ts:1629

setSecurityData

setSecurityData(data): void
Parameters
- data: null | SecurityDataType
Returns void
Inherited from HttpClient.setSecurityData
- Defined in langfuse/src/publicApi.ts:1542

`Protected`toQueryString

toQueryString(rawQuery?): string
Parameters
- OptionalrawQuery: QueryParamsType
Returns string
Inherited from HttpClient.toQueryString
- Defined in langfuse/src/publicApi.ts:1560

Class LangfusePublicApi<SecurityDataType>

Title

Authentication

Exports

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns LangfusePublicApi<SecurityDataType>

Properties

api

Type declaration

commentsCreate: ((data: ApiCreateCommentRequest, params?: RequestParams) => Promise<ApiCreateCommentResponse>)

Description

Tags

Name

Request

Secure

Parameters

Returns Promise<ApiCreateCommentResponse>

commentsGet: ((query: ApiCommentsGetParams, params?: RequestParams) => Promise<ApiGetCommentsResponse>)

Description

Tags

Name

Request

Secure

Parameters

Returns Promise<ApiGetCommentsResponse>

commentsGetById: ((commentId: string, params?: RequestParams) => Promise<ApiComment>)

Description

Tags

Name

Request

Secure

Parameters

Returns Promise<ApiComment>

datasetItemsCreate: ((data: ApiCreateDatasetItemRequest, params?: RequestParams) => Promise<ApiDatasetItem>)

Description

Tags

Name

Request

Secure

Parameters

Returns Promise<ApiDatasetItem>

datasetItemsGet: ((id: string, params?: RequestParams) => Promise<ApiDatasetItem>)

Description

Tags

Name

Request

Secure

Parameters

Returns Promise<ApiDatasetItem>

datasetItemsList: ((query: ApiDatasetItemsListParams, params?: RequestParams) => Promise<ApiPaginatedDatasetItems>)

Description

Tags

Name

Request

Secure

Parameters

Returns Promise<ApiPaginatedDatasetItems>

datasetRunItemsCreate: ((data: ApiCreateDatasetRunItemRequest, params?: RequestParams) => Promise<ApiDatasetRunItem>)

Description

Tags

Name

Request

Secure

Parameters

Returns Promise<ApiDatasetRunItem>

datasetsCreate: ((data: ApiCreateDatasetRequest, params?: RequestParams) => Promise<ApiDataset>)

Description

Tags

Name

Request

Secure