Skip to main content
GET
/
api
/
v1
/
runtimes
/
{runtime_id}
/
requirements
Get Runtime Requirements
curl --request GET \
  --url https://control-plane.kubiya.ai/api/v1/runtimes/{runtime_id}/requirements \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://control-plane.kubiya.ai/api/v1/runtimes/{runtime_id}/requirements"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://control-plane.kubiya.ai/api/v1/runtimes/{runtime_id}/requirements', 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://control-plane.kubiya.ai/api/v1/runtimes/{runtime_id}/requirements",
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://control-plane.kubiya.ai/api/v1/runtimes/{runtime_id}/requirements"

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))

}
HttpResponse<String> response = Unirest.get("https://control-plane.kubiya.ai/api/v1/runtimes/{runtime_id}/requirements")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://control-plane.kubiya.ai/api/v1/runtimes/{runtime_id}/requirements")

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
{
  "model_requirement": {
    "description": "<string>",
    "supported_providers": [
      "<string>"
    ],
    "supported_families": [
      "<string>"
    ],
    "examples": [
      "<string>"
    ]
  },
  "required_config_fields": [
    "<string>"
  ],
  "recommended_config_fields": [
    "<string>"
  ],
  "max_history_length": 123,
  "requires_system_prompt": false,
  "requires_tools": false
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Enter your Kubiya API token (format: Bearer )

Path Parameters

runtime_id
string
required

Response

Successful Response

Requirements specification for a runtime

model_requirement
ModelRequirementInfo · object
required

Model requirements for a runtime

required_config_fields
string[]
max_history_length
integer | null
requires_system_prompt
boolean
default:false
requires_tools
boolean
default:false