Get Model
curl --request GET \
--url https://api.example.com/api/models/modelimport requests
url = "https://api.example.com/api/models/model"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/models/model', 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/models/model",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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/models/model"
req, _ := http.NewRequest("GET", url, nil)
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/models/model")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/models/model")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"user_id": "<string>",
"base_model_id": "<string>",
"name": "<string>",
"params": {},
"meta": {
"profile_image_url": "<string>",
"description": "<string>",
"capabilities": {}
},
"access_grants": [
{}
],
"is_active": true,
"write_access": true,
"user": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"created_at": 123,
"updated_at": 123
}Models
Get Model
Retrieve a specific model by its ID
GET
/
api
/
models
/
model
Get Model
curl --request GET \
--url https://api.example.com/api/models/modelimport requests
url = "https://api.example.com/api/models/model"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/models/model', 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/models/model",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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/models/model"
req, _ := http.NewRequest("GET", url, nil)
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/models/model")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/models/model")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"user_id": "<string>",
"base_model_id": "<string>",
"name": "<string>",
"params": {},
"meta": {
"profile_image_url": "<string>",
"description": "<string>",
"capabilities": {}
},
"access_grants": [
{}
],
"is_active": true,
"write_access": true,
"user": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"created_at": 123,
"updated_at": 123
}Query Parameters
string
required
The unique identifier of the model to retrieve. Can contain ’/’ characters.
Response
string
The model’s unique identifier used in API calls
string
ID of the user who created the model
string
Optional pointer to the actual model used when proxying requests
string
Human-readable display name of the model
object
JSON object containing model parameters (flexible schema)
object
array
Array of access grant objects defining who can access this model and with what permissions
boolean
Whether the model is currently active and available for use
boolean
Whether the current user has write access to modify this model
object
integer
Unix timestamp (in seconds) of when the model was created
integer
Unix timestamp (in seconds) of when the model was last updated
Example Request
curl -X GET "https://api.example.com/api/models/model?id=gpt-4-custom" \
-H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"id": "gpt-4-custom",
"user_id": "user123",
"base_model_id": "gpt-4",
"name": "Custom GPT-4",
"params": {
"temperature": 0.7,
"max_tokens": 2000,
"top_p": 1.0
},
"meta": {
"profile_image_url": "/static/favicon.png",
"description": "A customized GPT-4 model optimized for code generation",
"capabilities": {
"vision": true,
"function_calling": true
}
},
"access_grants": [
{
"access_type": "user",
"access_id": "user456",
"permission": "read"
}
],
"is_active": true,
"write_access": true,
"user": {
"id": "user123",
"name": "John Doe",
"email": "john@example.com"
},
"created_at": 1704067200,
"updated_at": 1704153600
}
Error Responses
Model not found
{
"detail": "Model not found"
}
Unauthorized - User does not have access to this model
{
"detail": "Access prohibited"
}