API-Keys auflisten · DeutschlandGPT

Gibt alle nicht archivierten API-Keys (Benutzer-Keys sowie Agent-Keys) für den Workspace des Aufrufers zurück, einschließlich ihrer Berechtigungen, Ausgabenlimits und des Verbrauchs im laufenden Monat. Administratoren sehen alle Keys; Nicht-Administratoren sehen nur ihre eigenen.

GEThttps://api.deutschlandgpt.de/v2/apiKeys

Beispielaufruf

curl https://api.deutschlandgpt.de/v2/apiKeys \
  -X GET \
  -H "Authorization: Bearer $DGPT_API_KEY"

curl https://api.deutschlandgpt.de/v2/apiKeys \
  -X GET \
  -H "Authorization: Bearer $DGPT_API_KEY"

import os, requests

response = requests.get(
    "https://api.deutschlandgpt.de/v2/apiKeys",
    headers={"Authorization": f"Bearer {os.environ['DGPT_API_KEY']}"},
)

print(response.json())

import os, requests

response = requests.get(
    "https://api.deutschlandgpt.de/v2/apiKeys",
    headers={"Authorization": f"Bearer {os.environ['DGPT_API_KEY']}"},
)

print(response.json())

const response = await fetch('https://api.deutschlandgpt.de/v2/apiKeys', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.DGPT_API_KEY}`,
  },
});

console.log(await response.json());

const response = await fetch('https://api.deutschlandgpt.de/v2/apiKeys', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.DGPT_API_KEY}`,
  },
});

console.log(await response.json());

Antwort

200application/json

{
  "apiKeys": [
    {
      "id": "string",
      "name": "string",
      "obscuredApiKey": "string",
      "state": "active",
      "createdAt": "2025-01-01T00:00:00Z",
      "lastUsedAt": "2025-01-01T00:00:00Z",
      "monthlySpendingLimit": 0,
      "currentMonthSpend": 0,
      "adminScopes": [
        "admin:export_usage"
      ],
      "modelIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "documentFolderIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "customGptIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "restrictDocumentFolders": true,
      "restrictCustomGpts": true
    }
  ]
}

{
  "apiKeys": [
    {
      "id": "string",
      "name": "string",
      "obscuredApiKey": "string",
      "state": "active",
      "createdAt": "2025-01-01T00:00:00Z",
      "lastUsedAt": "2025-01-01T00:00:00Z",
      "monthlySpendingLimit": 0,
      "currentMonthSpend": 0,
      "adminScopes": [
        "admin:export_usage"
      ],
      "modelIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "documentFolderIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "customGptIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "restrictDocumentFolders": true,
      "restrictCustomGpts": true
    }
  ]
}

Liste der API-Keys

apiKeysobject[]erforderlich

idstringerforderlich

24-stellige Key-ID.

namestringerforderlich

Anzeigename.

obscuredApiKeystringerforderlich

Maskierter Key für die Anzeige (z. B. sk_abc...xyz).

statestringerforderlich

Aktueller Status des Keys.

createdAtstring<date-time>erforderlich

ISO 8601-Erstellungszeitstempel.

lastUsedAtstring<date-time> | nulloptional

Zeitpunkt der letzten Verwendung des Keys oder null.

monthlySpendingLimitinteger | nullerforderlich

Monatliches Limit in Mikrocent. Null = unbegrenzt.

currentMonthSpendintegererforderlich

Verbrauch im laufenden Kalendermonat in Mikrocent.

adminScopesstring[]erforderlich

Diesem Key gewährte Admin-Scopes.

modelIdsstring<uuid>[]erforderlich

Modell-IDs, auf die der Key beschränkt ist. Leer = alle Modelle.

documentFolderIdsstring<uuid>[]erforderlich

Dokumentenordner-IDs, auf die der Key beschränkt ist (gilt, wenn restrictDocumentFolders true ist).

customGptIdsstring<uuid>[]erforderlich

Custom GPT-IDs, auf die der Key beschränkt ist (gilt, wenn restrictCustomGpts true ist).

restrictDocumentFoldersbooleanerforderlich

Bei false kann der Key auf alle Dokumentenordner zugreifen; bei true ist der Zugriff auf documentFolderIds beschränkt.

restrictCustomGptsbooleanerforderlich

Bei false kann der Key auf alle Custom GPTs zugreifen; bei true ist der Zugriff auf customGptIds beschränkt.

Statuscodes

200

Liste der API-Keys

object

401

Nicht autorisiert

403

Unzureichende Berechtigungen