Get a list of currently active models

GET/v2/projects/{projectId}/ai-hosting-models/

API version

v2

Request method

GET

Operation ID

ai-hosting-project-get-detailed-models

---

Request

• projectIdstring (uuid)

  required

Responses

Format

application/json

Description

List of currently active models.

Schema documentation

• Array[
  • *object
    • activeAtstring (date-time)

      required
    • displayNamestring

      required
    • docLinkstring

      required
    • namestring

      required
    • removalAtstring (date-time)
    • replacesModelNamestring
    • statusstring (one of: active, needApproval, deprecated)

      required
    • termsOfServiceLinkstring

      required
  ]

Example

Content-Type: application/json

[
  {
    "activeAt": "1985-10-26T01:21:00.000Z",
    "displayName": "string",
    "docLink": "string",
    "name": "string",
    "removalAt": "1985-10-26T01:21:00.000Z",
    "replacesModelName": "string",
    "status": "active",
    "termsOfServiceLink": "string"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "activeAt": {
        "format": "date-time",
        "type": "string"
      },
      "displayName": {
        "type": "string"
      },
      "docLink": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "removalAt": {
        "format": "date-time",
        "type": "string"
      },
      "replacesModelName": {
        "type": "string"
      },
      "status": {
        "enum": [
          "active",
          "needApproval",
          "deprecated"
        ],
        "type": "string"
      },
      "termsOfServiceLink": {
        "type": "string"
      }
    },
    "required": [
      "name",
      "displayName",
      "docLink",
      "termsOfServiceLink",
      "activeAt",
      "status"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/f0f86186-0a5a-45b2-aa33-502777496347/ai-hosting-models

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.aiHostingProjectGetDetailedModels({
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new AiHostingProjectGetDetailedModelsRequest(
  projectId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->aiHosting()->aiHostingProjectGetDetailedModels($request);

var_dump($response->getBody();