langfuse_client_base/models/api_key_summary.rs
1/*
2 * server
3 *
4 * ## Real-time data The only real-time path to get tracing data is to ingest via OpenTelemetry (`POST /api/public/otel/v1/traces`) and retrieve via Observations API v2 (`GET /api/public/v2/observations`) and Metrics API v2 (`GET /api/public/v2/metrics`). Other public API write and read endpoints can delay data by about 10 minutes. Direct OpenTelemetry exporters must send the `x-langfuse-ingestion-version: 4` header; current Python and JS SDKs already do. See the [Public API docs](https://langfuse.com/docs/api-and-data-platform/features/public-api) and [real-time ingestion](https://langfuse.com/integrations/native/opentelemetry.md#real-time-ingestion). ## 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 - Self-hosted deployments: interactive API reference at `/api/docs` and OpenAPI spec at `/api/openapi.yaml`
5 *
6 * The version of the OpenAPI document:
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// ApiKeySummary : Summary of an API key
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
16pub struct ApiKeySummary {
17 #[serde(rename = "id")]
18 pub id: String,
19 #[serde(rename = "createdAt")]
20 pub created_at: chrono::DateTime<chrono::FixedOffset>,
21 #[serde(
22 rename = "expiresAt",
23 default,
24 with = "::serde_with::rust::double_option",
25 skip_serializing_if = "Option::is_none"
26 )]
27 pub expires_at: Option<Option<chrono::DateTime<chrono::FixedOffset>>>,
28 #[serde(
29 rename = "lastUsedAt",
30 default,
31 with = "::serde_with::rust::double_option",
32 skip_serializing_if = "Option::is_none"
33 )]
34 pub last_used_at: Option<Option<chrono::DateTime<chrono::FixedOffset>>>,
35 #[serde(
36 rename = "note",
37 default,
38 with = "::serde_with::rust::double_option",
39 skip_serializing_if = "Option::is_none"
40 )]
41 pub note: Option<Option<String>>,
42 #[serde(rename = "publicKey")]
43 pub public_key: String,
44 #[serde(rename = "displaySecretKey")]
45 pub display_secret_key: String,
46}
47
48impl ApiKeySummary {
49 /// Summary of an API key
50 pub fn new(
51 id: String,
52 created_at: chrono::DateTime<chrono::FixedOffset>,
53 public_key: String,
54 display_secret_key: String,
55 ) -> ApiKeySummary {
56 ApiKeySummary {
57 id,
58 created_at,
59 expires_at: None,
60 last_used_at: None,
61 note: None,
62 public_key,
63 display_secret_key,
64 }
65 }
66}