langfuse-client 0.1.21

## Authentication Authenticate with the API using [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication), 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
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

# \TraceApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**trace_delete**](TraceApi.md#trace_delete) | **DELETE** /api/public/traces/{traceId} | 
[**trace_delete_multiple**](TraceApi.md#trace_delete_multiple) | **DELETE** /api/public/traces | 
[**trace_get**](TraceApi.md#trace_get) | **GET** /api/public/traces/{traceId} | 
[**trace_list**](TraceApi.md#trace_list) | **GET** /api/public/traces | 



## trace_delete

> models::DeleteTraceResponse trace_delete(trace_id)


Delete a specific trace

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**trace_id** | **String** | The unique langfuse identifier of the trace to delete | [required] |

### Return type

[**models::DeleteTraceResponse**](DeleteTraceResponse.md)

### Authorization

[BasicAuth](../README.md#BasicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## trace_delete_multiple

> models::DeleteTraceResponse trace_delete_multiple(trace_delete_multiple_request)


Delete multiple traces

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**trace_delete_multiple_request** | [**TraceDeleteMultipleRequest**](TraceDeleteMultipleRequest.md) |  | [required] |

### Return type

[**models::DeleteTraceResponse**](DeleteTraceResponse.md)

### Authorization

[BasicAuth](../README.md#BasicAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## trace_get

> models::TraceWithFullDetails trace_get(trace_id)


Get a specific trace

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**trace_id** | **String** | The unique langfuse identifier of a trace | [required] |

### Return type

[**models::TraceWithFullDetails**](TraceWithFullDetails.md)

### Authorization

[BasicAuth](../README.md#BasicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## trace_list

> models::Traces trace_list(page, limit, user_id, name, session_id, from_timestamp, to_timestamp, order_by, tags, version, release, environment)


Get list of traces

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> | Page number, starts at 1 |  |
**limit** | Option<**i32**> | Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit. |  |
**user_id** | Option<**String**> |  |  |
**name** | Option<**String**> |  |  |
**session_id** | Option<**String**> |  |  |
**from_timestamp** | Option<**String**> | Optional filter to only include traces with a trace.timestamp on or after a certain datetime (ISO 8601) |  |
**to_timestamp** | Option<**String**> | Optional filter to only include traces with a trace.timestamp before a certain datetime (ISO 8601) |  |
**order_by** | Option<**String**> | Format of the string [field].[asc/desc]. Fields: id, timestamp, name, userId, release, version, public, bookmarked, sessionId. Example: timestamp.asc |  |
**tags** | Option<[**Vec<String>**](String.md)> | Only traces that include all of these tags will be returned. |  |
**version** | Option<**String**> | Optional filter to only include traces with a certain version. |  |
**release** | Option<**String**> | Optional filter to only include traces with a certain release. |  |
**environment** | Option<[**Vec<String>**](String.md)> | Optional filter for traces where the environment is one of the provided values. |  |

### Return type

[**models::Traces**](Traces.md)

### Authorization

[BasicAuth](../README.md#BasicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)