Foundation Models

Browse and call foundation models.

Deprecated

Retrieve available AI models

get

Deprecated – This endpoint will be removed on 2026-05-05. Please refer to the Migration Guide for instructions on how to migrate.

Retreieve the list of AI models running on the IONOS AI Model Hub. The model identifier is then used with the /predictions endpoint.

Authorizations

tokenAuth

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Responses

200

Successful operation.

application/json

Deprecated – This schema will be removed on 2026-05-05. Please refer to the Migration Guide for instructions on how to migrate.

idstringRead-onlyRequired

Unique Collection Identifier

Example: 9fa7d335-209c-5a1e-a8b2-686772fe7a33

typestring · enumRequired

Entity type

Possible values:

hrefstringRequired

Resource URL

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Forbidden

The user issuing the request does not have the needed permissions.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

get

/models

HTTPcURLJavaScriptPython

GET /models HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "9fa7d335-209c-5a1e-a8b2-686772fe7a33",
  "type": "collection",
  "href": "<RESOURCE-URL>",
  "items": [
    {
      "id": "4b71d0fe-d992-463e-82a1-de337d88ac2d",
      "type": "model",
      "metadata": {
        "lastModifiedDate": "2023-07-21T15:52:53Z",
        "createdDate": "2023-07-21T15:52:53Z"
      },
      "properties": {
        "name": "bloom-7b",
        "description": "BLOOM 7B model",
        "category": "text/nlp"
      }
    },
    {
      "id": "3a62d0fe-d992-463e-82a1-de337d88ac42",
      "type": "model",
      "metadata": {
        "lastModifiedDate": "2022-08-21T15:52:53Z",
        "createdDate": "2022-08-21T15:52:53Z"
      },
      "properties": {
        "name": "othermodel-13b",
        "description": "Other model 13B",
        "category": "text/nlp"
      }
    }
  ]
}

Deprecated

Send a request to the selected AI model

post

Deprecated – This endpoint will be removed on 2026-05-05. Please refer to the Migration Guide for instructions on how to migrate.

Send a request to the AI model and receive the result. The endpoint is synchronous and will return as soon as the model generates the full reply.

Authorizations

tokenAuth

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

modelIdstringRequired

The ID of the model.

Body

application/json

Deprecated – This schema will be removed on 2026-05-05. Please refer to the Migration Guide for instructions on how to migrate.

typestring · enumRead-onlyRequired

The entity type

Possible values:

Responses

200

Successful operation.

application/json

Deprecated – This schema will be removed on 2026-05-05. Please refer to the Migration Guide for instructions on how to migrate.

typestring · enumRead-onlyRequired

The entity type

Possible values:

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Forbidden

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

post

/models/{modelId}/predictions

HTTPcURLJavaScriptPython

POST /models/{modelId}/predictions HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 274

{
  "type": "prediction",
  "properties": {
    "input": "Please provide some sugestion names for my business. I own a flower shop in Berlin.",
    "collectionId": "550e8400-e29b-41d4-a716-446655440000",
    "collectionQuery": "What is a domain?",
    "options": {
      "max_length": "300",
      "temperature": "0.01"
    }
  }
}

{
  "type": "prediction",
  "metadata": {
    "lastModifiedDate": "2022-08-21T15:52:53Z",
    "createdDate": "2022-08-21T15:52:53Z",
    "duration": 0.01
  },
  "properties": {
    "input": "Please provide some sugestion names for my business. I own a flower shop in Berlin.",
    "options": {
      "max_length": "300",
      "temperature": "0.01"
    },
    "output": "The ML model said something smart"
  }
}