Get Bundle
curl --request GET \
--url https://api.example.com/api/v1/bundles/{bundle_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/bundles/{bundle_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/bundles/{bundle_id}', 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://api.example.com/api/v1/bundles/{bundle_id}",
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://api.example.com/api/v1/bundles/{bundle_id}"
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://api.example.com/api/v1/bundles/{bundle_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/bundles/{bundle_id}")
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": {
"bundle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issued_at": "2023-11-07T05:31:56Z",
"keys": [
{
"key_id": "<string>",
"request_source": "inference_key",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token_hash": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
],
"catalog": {
"providers": [
{
"provider_id": "<string>",
"kind": "<string>",
"base_url": "<string>",
"param_aliases": {},
"accepted_params": [
"<string>"
],
"params_closed": false
}
],
"models": [
{
"model_id": "<string>",
"provider_id": "<string>",
"upstream_model": "<string>",
"input_price_per_mtok": "<string>",
"output_price_per_mtok": "<string>",
"cache_read_price_per_mtok": "<string>",
"cache_write_price_per_mtok": "<string>",
"context_window": 50000000,
"input_modalities": [
"text"
],
"output_modalities": [
"text"
],
"capabilities": [
"streaming"
],
"max_output_tokens": 50000000,
"parameter_support": {},
"egress_kind": "<string>"
}
],
"credentials": []
},
"policies": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"definition": {
"target": {
"kind": "workspace"
},
"rules": [
{
"match": {
"kind": "all_requests"
},
"action": {
"kind": "models",
"names": [
"<string>"
]
}
}
]
}
}
],
"schema_version": 1
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Synchronization
Get Bundle
Return one immutable bundle visible to the authenticated data plane credential.
Required permission: bundles.read.
GET
/
api
/
v1
/
bundles
/
{bundle_id}
Get Bundle
curl --request GET \
--url https://api.example.com/api/v1/bundles/{bundle_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/bundles/{bundle_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/bundles/{bundle_id}', 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://api.example.com/api/v1/bundles/{bundle_id}",
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://api.example.com/api/v1/bundles/{bundle_id}"
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://api.example.com/api/v1/bundles/{bundle_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/bundles/{bundle_id}")
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": {
"bundle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issued_at": "2023-11-07T05:31:56Z",
"keys": [
{
"key_id": "<string>",
"request_source": "inference_key",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token_hash": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
],
"catalog": {
"providers": [
{
"provider_id": "<string>",
"kind": "<string>",
"base_url": "<string>",
"param_aliases": {},
"accepted_params": [
"<string>"
],
"params_closed": false
}
],
"models": [
{
"model_id": "<string>",
"provider_id": "<string>",
"upstream_model": "<string>",
"input_price_per_mtok": "<string>",
"output_price_per_mtok": "<string>",
"cache_read_price_per_mtok": "<string>",
"cache_write_price_per_mtok": "<string>",
"context_window": 50000000,
"input_modalities": [
"text"
],
"output_modalities": [
"text"
],
"capabilities": [
"streaming"
],
"max_output_tokens": 50000000,
"parameter_support": {},
"egress_kind": "<string>"
}
],
"credentials": []
},
"policies": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"definition": {
"target": {
"kind": "workspace"
},
"rules": [
{
"match": {
"kind": "all_requests"
},
"action": {
"kind": "models",
"names": [
"<string>"
]
}
}
]
}
}
],
"schema_version": 1
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
ManagementKeySessionCookie
A control-plane management key using the sk-cp- prefix. Inference keys are not accepted by control-plane endpoints.
Path Parameters
Policy bundle ID
Response
Successful Response
A complete, versioned policy snapshot for one organization's model traffic.
Show child attributes
Show child attributes