Skip to main content

langfuse_client_base/models/
projects_create_api_key_request.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#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
15pub struct ProjectsCreateApiKeyRequest {
16    /// Optional name for the API key. Cannot be provided together with note, even if either value is an empty string.
17    #[serde(
18        rename = "name",
19        default,
20        with = "::serde_with::rust::double_option",
21        skip_serializing_if = "Option::is_none"
22    )]
23    pub name: Option<Option<String>>,
24    /// Deprecated alias for name. Cannot be provided together with name, even if either value is an empty string.
25    #[serde(
26        rename = "note",
27        default,
28        with = "::serde_with::rust::double_option",
29        skip_serializing_if = "Option::is_none"
30    )]
31    pub note: Option<Option<String>>,
32    /// Optional expiration timestamp in ISO 8601 format. Must be in the future. Omit or set to null for a key that does not expire.
33    #[serde(
34        rename = "expiresAt",
35        default,
36        with = "::serde_with::rust::double_option",
37        skip_serializing_if = "Option::is_none"
38    )]
39    pub expires_at: Option<Option<chrono::DateTime<chrono::FixedOffset>>>,
40    /// Optional predefined public key. Must start with 'pk-lf-'. If provided, secretKey must also be provided.
41    #[serde(
42        rename = "publicKey",
43        default,
44        with = "::serde_with::rust::double_option",
45        skip_serializing_if = "Option::is_none"
46    )]
47    pub public_key: Option<Option<String>>,
48    /// Optional predefined secret key. Must start with 'sk-lf-'. If provided, publicKey must also be provided.
49    #[serde(
50        rename = "secretKey",
51        default,
52        with = "::serde_with::rust::double_option",
53        skip_serializing_if = "Option::is_none"
54    )]
55    pub secret_key: Option<Option<String>>,
56}
57
58impl ProjectsCreateApiKeyRequest {
59    pub fn new() -> ProjectsCreateApiKeyRequest {
60        ProjectsCreateApiKeyRequest {
61            name: None,
62            note: None,
63            expires_at: None,
64            public_key: None,
65            secret_key: None,
66        }
67    }
68}