Get a licence of a project

GET/projects/{projectId}/llm-licences/{licenceId}/

API version

v2

Request method

GET

Operation ID

project-get-llm-licence-experimental

---

Request

• projectIdstring

  required
• licenceIdstring

  required

Responses

Format

application/json

Beschreibung

The llm licence of a project.

Schema-Dokumentation

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

    required
• customerIdstring
• isBlockedboolean

  required

  Indicates whether the licence is blocked.

• licenceIdstring

  required

  Auto generated uuid to identify licences in requests.

• licenceKeystring

  required

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

• limitobject

  required

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

  • allowedRequestsPerUnitnumber

    required
  • unitstring (one of: minute, hour)

    required
• modelsarray of string

  required

  An array of LLM model identifiers enabled for this licence.

  • Array[
  • *string
  ]

namestring

required

projectIdstring

rateLimitnumber

deprecated

required

Deprecated, please us limit.allowedRequestsPerUnit

Beispiel

Content-Type: application/json

{
  "containerMeta": {
    "containerId": "string",
    "errorMessage": "string",
    "ingressId": "string",
    "stackId": "string",
    "status": "created"
  },
  "customerId": "string",
  "isBlocked": true,
  "licenceId": "string",
  "licenceKey": "string",
  "limit": {
    "allowedRequestsPerUnit": 123,
    "unit": "minute"
  },
  "models": [
    "string"
  ],
  "name": "string",
  "projectId": "string"
}

JSON Schema

{
  "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 licence is blocked.",
      "type": "boolean"
    },
    "licenceId": {
      "description": "Auto generated uuid to identify licences in requests.",
      "type": "string"
    },
    "licenceKey": {
      "description": "The secret API key which is required for authentication with the LLM hosting.",
      "type": "string"
    },
    "limit": {
      "description": "The number of allowed requests per unit. Limits are shared across all licences within the same project.",
      "properties": {
        "allowedRequestsPerUnit": {
          "type": "number"
        },
        "unit": {
          "enum": [
            "minute",
            "hour"
          ],
          "type": "string"
        }
      },
      "required": [
        "allowedRequestsPerUnit",
        "unit"
      ],
      "type": "object"
    },
    "models": {
      "description": "An array of LLM model identifiers enabled for this licence.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "name": {
      "type": "string"
    },
    "projectId": {
      "type": "string"
    },
    "rateLimit": {
      "deprecated": true,
      "description": "Deprecated, please us limit.allowedRequestsPerUnit",
      "type": "number"
    }
  },
  "required": [
    "licenceId",
    "licenceKey",
    "models",
    "name",
    "rateLimit",
    "isBlocked",
    "limit"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/string/llm-licences/string

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.project.getLlmLicenceExperimental({
  "projectId": "string",
  "licenceId": "string"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Project\GetLlmLicenceExperimental\GetLlmLicenceExperimentalRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetLlmLicenceExperimentalRequest(
  projectId: "string",
  licenceId: "string"
));
$response = $client->project()->getLlmLicenceExperimental($request);

var_dump($response->getBody();