Get a list of already created keys

GET/customers/{customerId}/ai-hosting-keys/

API version

v2

Request method

GET

Operation ID

ai-hosting-customer-get-keys

---

Request

• customerIdstring

  required

Responses

Format

application/json

Beschreibung

List of keys of a customer.

Schema-Dokumentation

• Array[
  • *object
    • containerMetaobject
      • containerIdstring
      • errorMessagestring
      • ingressIdstring
      • stackIdstring
      • statusstring (one of: created, requested, failed)

        required
    • customerIdstring
    • isBlockedboolean

      required

      Indicates whether the key is blocked.

    • keystring

      required

      The secret API key which is required for authentication with the AI hosting.

    • keyIdstring

      required

      Auto generated uuid to identify keys in requests.

    • modelsarray of string

      required

      An array of LLM model identifiers enabled for this key.

      • Array[
        • *string
        ]
    • namestring

      required
    • projectIdstring
    • rateLimitobject

      required

      The number of allowed requests per unit. Limits are shared across all keys within the same project.

      • allowedRequestsPerUnitinteger

        required
      • unit"minute"

        required
    • tokenUsageobject

      required
      • planLimitinteger (≥ -1, int64)

        required
      • usedinteger (≥ 0, int64)

        required
  ]

Beispiel

Content-Type: application/json

[
  {
    "containerMeta": {
      "containerId": "string",
      "errorMessage": "string",
      "ingressId": "string",
      "stackId": "string",
      "status": "created"
    },
    "customerId": "string",
    "isBlocked": true,
    "key": "string",
    "keyId": "string",
    "models": [
      "string"
    ],
    "name": "string",
    "projectId": "string",
    "rateLimit": {
      "allowedRequestsPerUnit": 123,
      "unit": "minute"
    },
    "tokenUsage": {
      "planLimit": 123,
      "used": 123
    }
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "containerMeta": {
        "properties": {
          "containerId": {
            "type": "string"
          },
          "errorMessage": {
            "type": "string"
          },
          "ingressId": {
            "type": "string"
          },
          "stackId": {
            "type": "string"
          },
          "status": {
            "enum": [
              "created",
              "requested",
              "failed"
            ],
            "type": "string"
          }
        },
        "required": [
          "status"
        ],
        "type": "object"
      },
      "customerId": {
        "type": "string"
      },
      "isBlocked": {
        "default": false,
        "description": "Indicates whether the key is blocked.",
        "type": "boolean"
      },
      "key": {
        "description": "The secret API key which is required for authentication with the AI hosting.",
        "type": "string"
      },
      "keyId": {
        "description": "Auto generated uuid to identify keys in requests.",
        "type": "string"
      },
      "models": {
        "description": "An array of LLM model identifiers enabled for this key.",
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "name": {
        "type": "string"
      },
      "projectId": {
        "type": "string"
      },
      "rateLimit": {
        "description": "The number of allowed requests per unit. Limits are shared across all keys within the same project.",
        "properties": {
          "allowedRequestsPerUnit": {
            "type": "integer"
          },
          "unit": {
            "enum": [
              "minute"
            ],
            "type": "string"
          }
        },
        "required": [
          "allowedRequestsPerUnit",
          "unit"
        ],
        "type": "object"
      },
      "tokenUsage": {
        "properties": {
          "planLimit": {
            "format": "int64",
            "minimum": -1,
            "type": "integer"
          },
          "used": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "used",
          "planLimit"
        ],
        "type": "object"
      }
    },
    "required": [
      "keyId",
      "key",
      "models",
      "name",
      "isBlocked",
      "tokenUsage",
      "rateLimit"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/customers/string/ai-hosting-keys

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.aiHosting.aiHostingCustomerGetKeys({
  "customerId": "string"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\AIHosting\AiHostingCustomerGetKeys\AiHostingCustomerGetKeysRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new AiHostingCustomerGetKeysRequest(
  customerId: "string"
));
$response = $client->aiHosting()->aiHostingCustomerGetKeys($request);

var_dump($response->getBody();