> This page is for Itential Platform On-Prem, version 6 (default).
> For other versions, use one of these documentation indexes:
> - 6 (default): https://docs-test.itntl.com/itential-platform/6/llms.txt
> - 2023.2: https://docs-test.itntl.com/itential-platform/2023-2/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs-test.itntl.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs-test.itntl.com/_mcp/server.

# Fetch models from a provider

POST https://example.itential.io/model-registry-service/providers/{providerId}/fetch-models
Content-Type: application/json

Validates a credential and retrieves the available models from the provider.

Reference: https://docs-test.itntl.com/itential-platform/6/api-reference/model-registry-service/fetch-models

## Authentication

- `Authorization` header (basic auth, required) — Basic authentication of the form `Basic <base64(username:password)>`.

## Request

### Path parameters

- `providerId` (string, required) — The provider ID.

### Body (application/json)

This endpoint expects an object.

- `credential` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredential, optional, nullable)
- `profileId` (string, optional, nullable)

## Response

### 200

The fetched models and validation result.

- `success` (boolean, required)
- `models` (list of ModelRegistryServiceProvidersProviderIdFetchModelsPostResponsesContentApplicationJsonSchemaModelsItems, required)
- `retrievedAt` (string, required)
- `error` (ModelRegistryServiceProvidersProviderIdFetchModelsPostResponsesContentApplicationJsonSchemaError, optional)

## Errors

### 500 Internal Server Error

Error response from API

- `any`

## Types

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredential

### ModelRegistryServiceProvidersProviderIdFetchModelsPostResponsesContentApplicationJsonSchemaModelsItems

- `id` (string, required)
- `name` (string, required)
- `enabled` (boolean, required)
- `status` (enum, required)
  - Allowed values: `active`, `disabled`, `deprecated`
- `modelVariables` (ModelRegistryServiceProvidersProviderIdFetchModelsPostResponsesContentApplicationJsonSchemaModelsItemsModelVariables, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostResponsesContentApplicationJsonSchemaError

- `type` (enum, required)
  - Allowed values: `auth`, `network`, `timeout`
- `message` (string, required)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredential0

- `type` ("openai", required)
- `apiKey` (string, required)
- `baseURL` (string, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredential1

- `type` ("anthropic", required)
- `apiKey` (string, required)
- `baseURL` (string, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredential2

- `type` ("google", required)
- `apiKey` (string, required)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredential3

- `type` ("ollama", required)
- `baseURL` (string, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredential4

- `type` ("bedrock", required)
- `config` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf4Config, required)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredential5

- `type` ("bedrock-proxy", required)
- `config` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf5Config, required)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredential6

- `type` ("databricks", required)
- `config` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf6Config, required)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredential7

- `type` ("gateway-manager", required)
- `config` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7Config, required)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostResponsesContentApplicationJsonSchemaModelsItemsModelVariables

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf4Config

- `region` (string, required)
- `accessKeyId` (string, required)
- `secretAccessKey` (string, required)
- `iamRole` (string, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf5Config

- `serviceUrl` (string, required)
- `tokenUrl` (string, required)
- `clientId` (string, required)
- `clientSecret` (string, required)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf6Config

- `type` ("oauth-m2m", required)
- `host` (string, required)
- `clientId` (string, required)
- `clientSecret` (string, required)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7Config

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7Config0

- `clusterId` (string, required)
- `backendProvider` ("openai", required)
- `credential` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf0Credential, required)
- `properties` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf0, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7Config1

- `clusterId` (string, required)
- `backendProvider` ("anthropic", required)
- `credential` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf1Credential, required)
- `properties` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf1, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7Config2

- `clusterId` (string, required)
- `backendProvider` ("google", required)
- `credential` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf2Credential, required)
- `properties` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf2, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7Config3

- `clusterId` (string, required)
- `backendProvider` ("mistral", required)
- `credential` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf3Credential, required)
- `properties` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf3, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7Config4

- `clusterId` (string, required)
- `backendProvider` ("ollama", required)
- `credential` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf4Credential, required)
- `properties` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf4, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7Config5

- `clusterId` (string, required)
- `backendProvider` ("bedrock", required)
- `credential` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf5Credential, required)
- `properties` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf5, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7Config6

- `clusterId` (string, required)
- `backendProvider` ("bedrock-proxy", required)
- `credential` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf6Credential, required)
- `properties` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf6, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7Config7

- `clusterId` (string, required)
- `backendProvider` ("databricks", required)
- `credential` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf7Credential, required)
- `properties` (ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf7, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf0Credential

- `apiKey` (string, required)
- `baseURL` (string, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf0

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf1Credential

- `apiKey` (string, required)
- `baseURL` (string, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf1

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf2Credential

- `apiKey` (string, required)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf2

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf3Credential

- `apiKey` (string, required)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf3

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf4Credential

- `baseURL` (string, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf4

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf5Credential

- `region` (string, required)
- `accessKeyId` (string, required)
- `secretAccessKey` (string, required)
- `iamRole` (string, optional)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf5

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf6Credential

- `serviceUrl` (string, required)
- `tokenUrl` (string, required)
- `clientId` (string, required)
- `clientSecret` (string, required)

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf6

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf7Credential

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf7

### ModelRegistryServiceProvidersProviderIdFetchModelsPostRequestBodyContentApplicationJsonSchemaCredentialOneOf7ConfigOneOf7Credential0

- `authType` ("azure-client-secret", required)
- `clientId` (string, required)
- `clientSecret` (string, required)
- `tenantId` (string, required)
- `workspaceUrl` (string, required)
- `resourceId` (string, optional)

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "success": true,
  "models": [
    {
      "id": "string",
      "name": "string",
      "enabled": true,
      "status": "active",
      "modelVariables": {}
    }
  ],
  "retrievedAt": "string",
  "error": {
    "type": "auth",
    "message": "string"
  }
}
```

**SDK Code**

```python
import requests

url = "https://example.itential.io/model-registry-service/providers/providerId/fetch-models"

payload = {}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://example.itential.io/model-registry-service/providers/providerId/fetch-models';
const options = {method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{}'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://example.itential.io/model-registry-service/providers/providerId/fetch-models"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://example.itential.io/model-registry-service/providers/providerId/fetch-models")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://example.itential.io/model-registry-service/providers/providerId/fetch-models")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://example.itential.io/model-registry-service/providers/providerId/fetch-models', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://example.itential.io/model-registry-service/providers/providerId/fetch-models");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://example.itential.io/model-registry-service/providers/providerId/fetch-models")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```