Skip to main content

langfuse_client_base/models/
api_key_response.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/// ApiKeyResponse : Response for API key creation
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
16pub struct ApiKeyResponse {
17    #[serde(rename = "id")]
18    pub id: String,
19    #[serde(rename = "createdAt")]
20    pub created_at: chrono::DateTime<chrono::FixedOffset>,
21    /// Expiration timestamp. Null if the key does not expire.
22    #[serde(
23        rename = "expiresAt",
24        default,
25        with = "::serde_with::rust::double_option",
26        skip_serializing_if = "Option::is_none"
27    )]
28    pub expires_at: Option<Option<chrono::DateTime<chrono::FixedOffset>>>,
29    #[serde(rename = "publicKey")]
30    pub public_key: String,
31    #[serde(rename = "secretKey")]
32    pub secret_key: String,
33    #[serde(rename = "displaySecretKey")]
34    pub display_secret_key: String,
35    /// Name of the API key. Contains the same value as note; null if no name was provided.
36    #[serde(
37        rename = "name",
38        default,
39        with = "::serde_with::rust::double_option",
40        skip_serializing_if = "Option::is_none"
41    )]
42    pub name: Option<Option<String>>,
43    /// Deprecated alias for name. Contains the same value as name.
44    #[serde(
45        rename = "note",
46        default,
47        with = "::serde_with::rust::double_option",
48        skip_serializing_if = "Option::is_none"
49    )]
50    pub note: Option<Option<String>>,
51}
52
53impl ApiKeyResponse {
54    /// Response for API key creation
55    pub fn new(
56        id: String,
57        created_at: chrono::DateTime<chrono::FixedOffset>,
58        public_key: String,
59        secret_key: String,
60        display_secret_key: String,
61    ) -> ApiKeyResponse {
62        ApiKeyResponse {
63            id,
64            created_at,
65            expires_at: None,
66            public_key,
67            secret_key,
68            display_secret_key,
69            name: None,
70            note: None,
71        }
72    }
73}