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    #[serde(rename = "publicKey")]
22    pub public_key: String,
23    #[serde(rename = "secretKey")]
24    pub secret_key: String,
25    #[serde(rename = "displaySecretKey")]
26    pub display_secret_key: String,
27    #[serde(
28        rename = "note",
29        default,
30        with = "::serde_with::rust::double_option",
31        skip_serializing_if = "Option::is_none"
32    )]
33    pub note: Option<Option<String>>,
34}
35
36impl ApiKeyResponse {
37    /// Response for API key creation
38    pub fn new(
39        id: String,
40        created_at: chrono::DateTime<chrono::FixedOffset>,
41        public_key: String,
42        secret_key: String,
43        display_secret_key: String,
44    ) -> ApiKeyResponse {
45        ApiKeyResponse {
46            id,
47            created_at,
48            public_key,
49            secret_key,
50            display_secret_key,
51            note: None,
52        }
53    }
54}