Get ai hosting plan and usages of a project by planId

GET/v2/projects/{projectId}/ai-hostings/{planId}/

API version

v2

Request method

GET

Operation ID

ai-hosting-project-get-plan

---

Request

• projectIdstring

  required
• planIdstring

  required

Responses

Format

application/json

Beschreibung

The project usage and plan.

Schema-Dokumentation

• descriptionstring
• keysobject

  required
  • availableinteger (≥ -1)

    required
  • planLimitinteger (≥ -1)

    required
  • usedinteger (≥ 0)

    required
• modelTermsApprovalRequiredboolean

  required
• nextTokenResetstring (date-time)
• planIdstring

  required
• projectIdstring

  required

Beispiel

Content-Type: application/json

{
  "description": "string",
  "keys": {
    "available": 123,
    "planLimit": 123,
    "used": 123
  },
  "modelTermsApprovalRequired": true,
  "nextTokenReset": "1985-10-26T01:21:00.000Z",
  "planId": "string",
  "projectId": "string"
}

JSON Schema

{
  "properties": {
    "description": {
      "type": "string"
    },
    "keys": {
      "properties": {
        "available": {
          "minimum": -1,
          "type": "integer"
        },
        "planLimit": {
          "minimum": -1,
          "type": "integer"
        },
        "used": {
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "used",
        "available",
        "planLimit"
      ],
      "type": "object"
    },
    "modelTermsApprovalRequired": {
      "type": "boolean"
    },
    "nextTokenReset": {
      "format": "date-time",
      "type": "string"
    },
    "planId": {
      "type": "string"
    },
    "projectId": {
      "type": "string"
    }
  },
  "required": [
    "keys",
    "projectId",
    "planId",
    "modelTermsApprovalRequired"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/string/ai-hostings/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.aiHosting.aiHostingProjectGetPlan({
  "projectId": "string",
  "planId": "string"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new AiHostingProjectGetPlanRequest(
  projectId: "string",
  planId: "string"
));
$response = $client->aiHosting()->aiHostingProjectGetPlan($request);

var_dump($response->getBody();