Skip to main content
POST
/
api
/
admin
/
aimodel
Create a new AI model
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/aimodel \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "name": "<string>",
  "institution": "<string>",
  "model_use": "conversationModel",
  "description": "<string>",
  "client_library": "openai_cli",
  "api_url": "<string>",
  "api_key": "<string>",
  "default_headers": {},
  "features": {
    "stream": false,
    "tools": false,
    "code": false,
    "vision": false,
    "mcp": false
  },
  "input_media": {
    "text": true,
    "image": false,
    "audio": false,
    "video": false,
    "pdf": false
  },
  "output_media": {
    "text": true,
    "audio": false,
    "video": false,
    "image": false
  },
  "max_input_tokens": 128000,
  "max_output_tokens": 64000,
  "extended_context": false,
  "status": "active",
  "picture_url": "<string>"
}
'
import requests

url = "https://pria.praxislxp.com/api/admin/aimodel"

payload = {
    "name": "<string>",
    "institution": "<string>",
    "model_use": "conversationModel",
    "description": "<string>",
    "client_library": "openai_cli",
    "api_url": "<string>",
    "api_key": "<string>",
    "default_headers": {},
    "features": {
        "stream": False,
        "tools": False,
        "code": False,
        "vision": False,
        "mcp": False
    },
    "input_media": {
        "text": True,
        "image": False,
        "audio": False,
        "video": False,
        "pdf": False
    },
    "output_media": {
        "text": True,
        "audio": False,
        "video": False,
        "image": False
    },
    "max_input_tokens": 128000,
    "max_output_tokens": 64000,
    "extended_context": False,
    "status": "active",
    "picture_url": "<string>"
}
headers = {
    "x-access-token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    institution: '<string>',
    model_use: 'conversationModel',
    description: '<string>',
    client_library: 'openai_cli',
    api_url: '<string>',
    api_key: '<string>',
    default_headers: {},
    features: {stream: false, tools: false, code: false, vision: false, mcp: false},
    input_media: {text: true, image: false, audio: false, video: false, pdf: false},
    output_media: {text: true, audio: false, video: false, image: false},
    max_input_tokens: 128000,
    max_output_tokens: 64000,
    extended_context: false,
    status: 'active',
    picture_url: '<string>'
  })
};

fetch('https://pria.praxislxp.com/api/admin/aimodel', 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://pria.praxislxp.com/api/admin/aimodel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'institution' => '<string>',
    'model_use' => 'conversationModel',
    'description' => '<string>',
    'client_library' => 'openai_cli',
    'api_url' => '<string>',
    'api_key' => '<string>',
    'default_headers' => [
        
    ],
    'features' => [
        'stream' => false,
        'tools' => false,
        'code' => false,
        'vision' => false,
        'mcp' => false
    ],
    'input_media' => [
        'text' => true,
        'image' => false,
        'audio' => false,
        'video' => false,
        'pdf' => false
    ],
    'output_media' => [
        'text' => true,
        'audio' => false,
        'video' => false,
        'image' => false
    ],
    'max_input_tokens' => 128000,
    'max_output_tokens' => 64000,
    'extended_context' => false,
    'status' => 'active',
    'picture_url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-access-token: <api-key>"
  ],
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://pria.praxislxp.com/api/admin/aimodel"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"institution\": \"<string>\",\n  \"model_use\": \"conversationModel\",\n  \"description\": \"<string>\",\n  \"client_library\": \"openai_cli\",\n  \"api_url\": \"<string>\",\n  \"api_key\": \"<string>\",\n  \"default_headers\": {},\n  \"features\": {\n    \"stream\": false,\n    \"tools\": false,\n    \"code\": false,\n    \"vision\": false,\n    \"mcp\": false\n  },\n  \"input_media\": {\n    \"text\": true,\n    \"image\": false,\n    \"audio\": false,\n    \"video\": false,\n    \"pdf\": false\n  },\n  \"output_media\": {\n    \"text\": true,\n    \"audio\": false,\n    \"video\": false,\n    \"image\": false\n  },\n  \"max_input_tokens\": 128000,\n  \"max_output_tokens\": 64000,\n  \"extended_context\": false,\n  \"status\": \"active\",\n  \"picture_url\": \"<string>\"\n}")

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

	req.Header.Add("x-access-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://pria.praxislxp.com/api/admin/aimodel")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"institution\": \"<string>\",\n  \"model_use\": \"conversationModel\",\n  \"description\": \"<string>\",\n  \"client_library\": \"openai_cli\",\n  \"api_url\": \"<string>\",\n  \"api_key\": \"<string>\",\n  \"default_headers\": {},\n  \"features\": {\n    \"stream\": false,\n    \"tools\": false,\n    \"code\": false,\n    \"vision\": false,\n    \"mcp\": false\n  },\n  \"input_media\": {\n    \"text\": true,\n    \"image\": false,\n    \"audio\": false,\n    \"video\": false,\n    \"pdf\": false\n  },\n  \"output_media\": {\n    \"text\": true,\n    \"audio\": false,\n    \"video\": false,\n    \"image\": false\n  },\n  \"max_input_tokens\": 128000,\n  \"max_output_tokens\": 64000,\n  \"extended_context\": false,\n  \"status\": \"active\",\n  \"picture_url\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://pria.praxislxp.com/api/admin/aimodel")

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

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"institution\": \"<string>\",\n  \"model_use\": \"conversationModel\",\n  \"description\": \"<string>\",\n  \"client_library\": \"openai_cli\",\n  \"api_url\": \"<string>\",\n  \"api_key\": \"<string>\",\n  \"default_headers\": {},\n  \"features\": {\n    \"stream\": false,\n    \"tools\": false,\n    \"code\": false,\n    \"vision\": false,\n    \"mcp\": false\n  },\n  \"input_media\": {\n    \"text\": true,\n    \"image\": false,\n    \"audio\": false,\n    \"video\": false,\n    \"pdf\": false\n  },\n  \"output_media\": {\n    \"text\": true,\n    \"audio\": false,\n    \"video\": false,\n    \"image\": false\n  },\n  \"max_input_tokens\": 128000,\n  \"max_output_tokens\": 64000,\n  \"extended_context\": false,\n  \"status\": \"active\",\n  \"picture_url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "id": "<string>",
  "message": "AIModel created!"
}

Authorizations

​
x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
​
name
string
required

Model name (must be unique per institution + model_use).

​
institution
string

Institution ID. Defaults to the caller's institution when omitted.

​
model_use
enum<string>
default:conversationModel
Available options:
conversationModel,
imageGenerationModel,
audioGenerationModel,
videoGenerationModel,
imageAnalysisModel,
embeddingsModel,
audioAnalysisModel,
videoAnalysisModel,
ttsModel,
summaryModel,
rtModel,
moderationModel
​
description
string
​
client_library
enum<string>
default:openai_cli

SDK / dispatch backend used to talk to the provider.

Available options:
openai_cli,
anthropic_cli,
bedrock_cli,
google_cli,
mistral_cli,
xai_cli,
stability_cli
​
api_url
string

Provider base URL. Required for openai_cli custom models.

​
api_key
string

Provider API key. Required for openai_cli, mistral_cli, and xai_cli custom models.

​
default_headers
object
​
features
object

Capability flags advertised by the model.

​
input_media
object

Input modalities the model accepts.

​
output_media
object

Output modalities the model can produce.

​
max_input_tokens
integer
default:128000
​
max_output_tokens
integer
default:64000
​
reasoning_effort
enum<string> | null
Available options:
none,
low,
medium,
high,
max
​
extended_context
boolean
default:false
​
status
enum<string>
default:active
Available options:
active,
inactive
​
picture_url
string

Response

AI model created successfully

​
success
boolean
​
id
string

The new AI model's ObjectId.

​
message
string
Example:

"AIModel created!"