Get Deployment Specifications

curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/model-catalogues/deployment-specs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{controlPlaneURL}/api/svc/v1/model-catalogues/deployment-specs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{controlPlaneURL}/api/svc/v1/model-catalogues/deployment-specs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{controlPlaneURL}/api/svc/v1/model-catalogues/deployment-specs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{controlPlaneURL}/api/svc/v1/model-catalogues/deployment-specs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{controlPlaneURL}/api/svc/v1/model-catalogues/deployment-specs")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "name": "vLLM",
      "displayName": "<string>",
      "description": "<string>",
      "openAPIDescription": "<string>",
      "deployments": [
        {
          "name": "<string>",
          "spec": {},
          "isAvailableInWorkspace": true,
          "cost": {},
          "isTRTLLMEngineAvailable": true
        }
      ]
    }
  ]
}

GET

api

svc

model-catalogues

deployment-specs

Get Deployment Specifications

curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/model-catalogues/deployment-specs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{controlPlaneURL}/api/svc/v1/model-catalogues/deployment-specs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{controlPlaneURL}/api/svc/v1/model-catalogues/deployment-specs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{controlPlaneURL}/api/svc/v1/model-catalogues/deployment-specs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{controlPlaneURL}/api/svc/v1/model-catalogues/deployment-specs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{controlPlaneURL}/api/svc/v1/model-catalogues/deployment-specs")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "name": "vLLM",
      "displayName": "<string>",
      "description": "<string>",
      "openAPIDescription": "<string>",
      "deployments": [
        {
          "name": "<string>",
          "spec": {},
          "isAvailableInWorkspace": true,
          "cost": {},
          "isTRTLLMEngineAvailable": true
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

workspaceId

string

required

Workspace Id

modelVersionFqn

string | null

FQN of the Model Version

huggingfaceHubUrl

string | null

huggingface hub url

huggingfaceHubTokenSecretFqn

string | null

Huggingface hub token secret

pipelineTagOverride

string | null

The pipeline tag of the model for which deployment spec is being generated

Response

Returns deployment specifications for the model version or HuggingFace model URL

data

ModelServerOption · object[]

required

Array of ModelDeploymentSpec

Show child attributes

TrueFoundry SDK

TrueFoundry CLI

Extras

Agent

Agent Skills

Applications

Metrics

Apply

Artifacts

Audit Logs

Clusters

Jobs

LLM Gateway Budgets

Logs

MCP Registry

MCP Servers V2

MLRepos

Model Deployments

Models

Personal Access Tokens

Prompts

Provider Integrations

SCIM v2

Secret Groups

Secrets

Teams

Traces

Users

Virtual Accounts

Role Bindings

Workspaces

Provider Accounts

Get Deployment Specifications

Authorizations

Query Parameters

Response