Skip to main content
Create Model
curl --request POST \
  --url https://{api_endpoint}/v1/models \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "display_name": "<string>",
  "provider_config": {
    "api_key": "Dummy",
    "urlToFetch": "<string>",
    "resourceName": "<string>",
    "deploymentId": "<string>",
    "apiVersion": "<string>",
    "adAuth": "<string>",
    "azureAuthMode": "<string>",
    "azureManagedClientId": "<string>",
    "azureEntraClientId": "<string>",
    "azureEntraClientSecret": "<string>",
    "azureEntraTenantId": "<string>",
    "azureAdToken": "<string>",
    "azureModelName": "<string>",
    "workersAiAccountId": "<string>",
    "customHost": "<string>",
    "forwardHeaders": [
      "<string>"
    ],
    "index": 123,
    "cache": "<string>",
    "metadata": {},
    "requestTimeout": 123,
    "transformToFormData": true,
    "awsSecretAccessKey": "<string>",
    "awsAccessKeyId": "<string>",
    "awsSessionToken": "<string>",
    "awsRegion": "<string>",
    "awsAuthType": "<string>",
    "awsRoleArn": "<string>",
    "awsExternalId": "<string>",
    "awsS3Bucket": "<string>",
    "awsS3ObjectKey": "<string>",
    "awsBedrockModel": "<string>",
    "awsServerSideEncryption": "<string>",
    "awsServerSideEncryptionKMSKeyId": "<string>",
    "amznSagemakerCustomAttributes": "<string>",
    "amznSagemakerTargetModel": "<string>",
    "amznSagemakerTargetVariant": "<string>",
    "amznSagemakerTargetContainerHostname": "<string>",
    "amznSagemakerInferenceId": "<string>",
    "amznSagemakerEnableExplanations": "<string>",
    "amznSagemakerInferenceComponent": "<string>",
    "amznSagemakerSessionId": "<string>",
    "amznSagemakerModelName": "<string>",
    "stabilityClientId": "<string>",
    "stabilityClientUserId": "<string>",
    "stabilityClientVersion": "<string>",
    "huggingfaceBaseUrl": "<string>",
    "vertexRegion": "<string>",
    "vertexProjectId": "<string>",
    "vertexServiceAccountJson": {},
    "vertexStorageBucketName": "<string>",
    "vertexModelName": "<string>",
    "filename": "<string>",
    "afterRequestHooks": [
      {}
    ],
    "beforeRequestHooks": [
      {}
    ],
    "defaultInputGuardrails": [
      {}
    ],
    "defaultOutputGuardrails": [
      {}
    ],
    "openaiProject": "<string>",
    "openaiOrganization": "<string>",
    "openaiBeta": "<string>",
    "azureDeploymentName": "<string>",
    "azureApiVersion": "<string>",
    "azureExtraParams": "<string>",
    "azureFoundryUrl": "<string>",
    "strictOpenAiCompliance": false,
    "mistralFimCompletion": "<string>",
    "anthropicBeta": "<string>",
    "anthropicVersion": "<string>",
    "fireworksAccountId": "<string>",
    "snowflakeAccount": "<string>",
    "watsonxVersion": "<string>",
    "watsonxSpaceId": "<string>",
    "watsonxProjectId": "<string>",
    "watsonxDeploymentId": "<string>",
    "watsonxCpdUrl": "<string>",
    "watsonxCpdUsername": "<string>",
    "watsonxCpdPassword": "<string>"
  },
  "config": {
    "decoding_method": "<string>",
    "prompt": "<string>",
    "max_tokens": 123,
    "max_completion_tokens": 123,
    "temperature": 123,
    "top_p": 123,
    "n": 123,
    "stream": true,
    "logprobs": 123,
    "top_logprobs": true,
    "echo": true,
    "stop": "<string>",
    "presence_penalty": 123,
    "frequency_penalty": 123,
    "best_of": 123,
    "logit_bias": {},
    "user": "<string>",
    "context": "<string>",
    "examples": [
      {
        "input": "<unknown>",
        "output": "<unknown>"
      }
    ],
    "top_k": 123,
    "response_format": {
      "type": "<string>",
      "json_schema": null
    },
    "seed": 123,
    "store": true,
    "metadata": {},
    "modalities": [
      "<string>"
    ],
    "audio": {
      "voice": "<string>",
      "format": "<string>"
    },
    "service_tier": "<string>",
    "prediction": {
      "type": "<string>",
      "content": [
        {
          "type": "<string>",
          "text": "<string>"
        }
      ]
    },
    "safety_settings": null,
    "anthropic_beta": "<string>",
    "anthropic_version": "<string>",
    "thinking": {
      "budget_tokens": 123,
      "type": "<string>"
    },
    "space_id": "<string>",
    "project_id": "<string>",
    "reasoning_effort": "<string>"
  },
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "model_type": "chat",
  "connection_id": "<string>"
}
'
import requests

url = "https://{api_endpoint}/v1/models"

payload = {
    "name": "<string>",
    "display_name": "<string>",
    "provider_config": {
        "api_key": "Dummy",
        "urlToFetch": "<string>",
        "resourceName": "<string>",
        "deploymentId": "<string>",
        "apiVersion": "<string>",
        "adAuth": "<string>",
        "azureAuthMode": "<string>",
        "azureManagedClientId": "<string>",
        "azureEntraClientId": "<string>",
        "azureEntraClientSecret": "<string>",
        "azureEntraTenantId": "<string>",
        "azureAdToken": "<string>",
        "azureModelName": "<string>",
        "workersAiAccountId": "<string>",
        "customHost": "<string>",
        "forwardHeaders": ["<string>"],
        "index": 123,
        "cache": "<string>",
        "metadata": {},
        "requestTimeout": 123,
        "transformToFormData": True,
        "awsSecretAccessKey": "<string>",
        "awsAccessKeyId": "<string>",
        "awsSessionToken": "<string>",
        "awsRegion": "<string>",
        "awsAuthType": "<string>",
        "awsRoleArn": "<string>",
        "awsExternalId": "<string>",
        "awsS3Bucket": "<string>",
        "awsS3ObjectKey": "<string>",
        "awsBedrockModel": "<string>",
        "awsServerSideEncryption": "<string>",
        "awsServerSideEncryptionKMSKeyId": "<string>",
        "amznSagemakerCustomAttributes": "<string>",
        "amznSagemakerTargetModel": "<string>",
        "amznSagemakerTargetVariant": "<string>",
        "amznSagemakerTargetContainerHostname": "<string>",
        "amznSagemakerInferenceId": "<string>",
        "amznSagemakerEnableExplanations": "<string>",
        "amznSagemakerInferenceComponent": "<string>",
        "amznSagemakerSessionId": "<string>",
        "amznSagemakerModelName": "<string>",
        "stabilityClientId": "<string>",
        "stabilityClientUserId": "<string>",
        "stabilityClientVersion": "<string>",
        "huggingfaceBaseUrl": "<string>",
        "vertexRegion": "<string>",
        "vertexProjectId": "<string>",
        "vertexServiceAccountJson": {},
        "vertexStorageBucketName": "<string>",
        "vertexModelName": "<string>",
        "filename": "<string>",
        "afterRequestHooks": [{}],
        "beforeRequestHooks": [{}],
        "defaultInputGuardrails": [{}],
        "defaultOutputGuardrails": [{}],
        "openaiProject": "<string>",
        "openaiOrganization": "<string>",
        "openaiBeta": "<string>",
        "azureDeploymentName": "<string>",
        "azureApiVersion": "<string>",
        "azureExtraParams": "<string>",
        "azureFoundryUrl": "<string>",
        "strictOpenAiCompliance": False,
        "mistralFimCompletion": "<string>",
        "anthropicBeta": "<string>",
        "anthropicVersion": "<string>",
        "fireworksAccountId": "<string>",
        "snowflakeAccount": "<string>",
        "watsonxVersion": "<string>",
        "watsonxSpaceId": "<string>",
        "watsonxProjectId": "<string>",
        "watsonxDeploymentId": "<string>",
        "watsonxCpdUrl": "<string>",
        "watsonxCpdUsername": "<string>",
        "watsonxCpdPassword": "<string>"
    },
    "config": {
        "decoding_method": "<string>",
        "prompt": "<string>",
        "max_tokens": 123,
        "max_completion_tokens": 123,
        "temperature": 123,
        "top_p": 123,
        "n": 123,
        "stream": True,
        "logprobs": 123,
        "top_logprobs": True,
        "echo": True,
        "stop": "<string>",
        "presence_penalty": 123,
        "frequency_penalty": 123,
        "best_of": 123,
        "logit_bias": {},
        "user": "<string>",
        "context": "<string>",
        "examples": [
            {
                "input": "<unknown>",
                "output": "<unknown>"
            }
        ],
        "top_k": 123,
        "response_format": {
            "type": "<string>",
            "json_schema": None
        },
        "seed": 123,
        "store": True,
        "metadata": {},
        "modalities": ["<string>"],
        "audio": {
            "voice": "<string>",
            "format": "<string>"
        },
        "service_tier": "<string>",
        "prediction": {
            "type": "<string>",
            "content": [
                {
                    "type": "<string>",
                    "text": "<string>"
                }
            ]
        },
        "safety_settings": None,
        "anthropic_beta": "<string>",
        "anthropic_version": "<string>",
        "thinking": {
            "budget_tokens": 123,
            "type": "<string>"
        },
        "space_id": "<string>",
        "project_id": "<string>",
        "reasoning_effort": "<string>"
    },
    "description": "<string>",
    "tags": ["<string>"],
    "model_type": "chat",
    "connection_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    display_name: '<string>',
    provider_config: {
      api_key: 'Dummy',
      urlToFetch: '<string>',
      resourceName: '<string>',
      deploymentId: '<string>',
      apiVersion: '<string>',
      adAuth: '<string>',
      azureAuthMode: '<string>',
      azureManagedClientId: '<string>',
      azureEntraClientId: '<string>',
      azureEntraClientSecret: '<string>',
      azureEntraTenantId: '<string>',
      azureAdToken: '<string>',
      azureModelName: '<string>',
      workersAiAccountId: '<string>',
      customHost: '<string>',
      forwardHeaders: ['<string>'],
      index: 123,
      cache: '<string>',
      metadata: {},
      requestTimeout: 123,
      transformToFormData: true,
      awsSecretAccessKey: '<string>',
      awsAccessKeyId: '<string>',
      awsSessionToken: '<string>',
      awsRegion: '<string>',
      awsAuthType: '<string>',
      awsRoleArn: '<string>',
      awsExternalId: '<string>',
      awsS3Bucket: '<string>',
      awsS3ObjectKey: '<string>',
      awsBedrockModel: '<string>',
      awsServerSideEncryption: '<string>',
      awsServerSideEncryptionKMSKeyId: '<string>',
      amznSagemakerCustomAttributes: '<string>',
      amznSagemakerTargetModel: '<string>',
      amznSagemakerTargetVariant: '<string>',
      amznSagemakerTargetContainerHostname: '<string>',
      amznSagemakerInferenceId: '<string>',
      amznSagemakerEnableExplanations: '<string>',
      amznSagemakerInferenceComponent: '<string>',
      amznSagemakerSessionId: '<string>',
      amznSagemakerModelName: '<string>',
      stabilityClientId: '<string>',
      stabilityClientUserId: '<string>',
      stabilityClientVersion: '<string>',
      huggingfaceBaseUrl: '<string>',
      vertexRegion: '<string>',
      vertexProjectId: '<string>',
      vertexServiceAccountJson: {},
      vertexStorageBucketName: '<string>',
      vertexModelName: '<string>',
      filename: '<string>',
      afterRequestHooks: [{}],
      beforeRequestHooks: [{}],
      defaultInputGuardrails: [{}],
      defaultOutputGuardrails: [{}],
      openaiProject: '<string>',
      openaiOrganization: '<string>',
      openaiBeta: '<string>',
      azureDeploymentName: '<string>',
      azureApiVersion: '<string>',
      azureExtraParams: '<string>',
      azureFoundryUrl: '<string>',
      strictOpenAiCompliance: false,
      mistralFimCompletion: '<string>',
      anthropicBeta: '<string>',
      anthropicVersion: '<string>',
      fireworksAccountId: '<string>',
      snowflakeAccount: '<string>',
      watsonxVersion: '<string>',
      watsonxSpaceId: '<string>',
      watsonxProjectId: '<string>',
      watsonxDeploymentId: '<string>',
      watsonxCpdUrl: '<string>',
      watsonxCpdUsername: '<string>',
      watsonxCpdPassword: '<string>'
    },
    config: {
      decoding_method: '<string>',
      prompt: '<string>',
      max_tokens: 123,
      max_completion_tokens: 123,
      temperature: 123,
      top_p: 123,
      n: 123,
      stream: true,
      logprobs: 123,
      top_logprobs: true,
      echo: true,
      stop: '<string>',
      presence_penalty: 123,
      frequency_penalty: 123,
      best_of: 123,
      logit_bias: {},
      user: '<string>',
      context: '<string>',
      examples: [{input: '<unknown>', output: '<unknown>'}],
      top_k: 123,
      response_format: {type: '<string>', json_schema: null},
      seed: 123,
      store: true,
      metadata: {},
      modalities: ['<string>'],
      audio: {voice: '<string>', format: '<string>'},
      service_tier: '<string>',
      prediction: {type: '<string>', content: [{type: '<string>', text: '<string>'}]},
      safety_settings: null,
      anthropic_beta: '<string>',
      anthropic_version: '<string>',
      thinking: {budget_tokens: 123, type: '<string>'},
      space_id: '<string>',
      project_id: '<string>',
      reasoning_effort: '<string>'
    },
    description: '<string>',
    tags: ['<string>'],
    model_type: 'chat',
    connection_id: '<string>'
  })
};

fetch('https://{api_endpoint}/v1/models', 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_endpoint}/v1/models",
  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>',
    'display_name' => '<string>',
    'provider_config' => [
        'api_key' => 'Dummy',
        'urlToFetch' => '<string>',
        'resourceName' => '<string>',
        'deploymentId' => '<string>',
        'apiVersion' => '<string>',
        'adAuth' => '<string>',
        'azureAuthMode' => '<string>',
        'azureManagedClientId' => '<string>',
        'azureEntraClientId' => '<string>',
        'azureEntraClientSecret' => '<string>',
        'azureEntraTenantId' => '<string>',
        'azureAdToken' => '<string>',
        'azureModelName' => '<string>',
        'workersAiAccountId' => '<string>',
        'customHost' => '<string>',
        'forwardHeaders' => [
                '<string>'
        ],
        'index' => 123,
        'cache' => '<string>',
        'metadata' => [
                
        ],
        'requestTimeout' => 123,
        'transformToFormData' => true,
        'awsSecretAccessKey' => '<string>',
        'awsAccessKeyId' => '<string>',
        'awsSessionToken' => '<string>',
        'awsRegion' => '<string>',
        'awsAuthType' => '<string>',
        'awsRoleArn' => '<string>',
        'awsExternalId' => '<string>',
        'awsS3Bucket' => '<string>',
        'awsS3ObjectKey' => '<string>',
        'awsBedrockModel' => '<string>',
        'awsServerSideEncryption' => '<string>',
        'awsServerSideEncryptionKMSKeyId' => '<string>',
        'amznSagemakerCustomAttributes' => '<string>',
        'amznSagemakerTargetModel' => '<string>',
        'amznSagemakerTargetVariant' => '<string>',
        'amznSagemakerTargetContainerHostname' => '<string>',
        'amznSagemakerInferenceId' => '<string>',
        'amznSagemakerEnableExplanations' => '<string>',
        'amznSagemakerInferenceComponent' => '<string>',
        'amznSagemakerSessionId' => '<string>',
        'amznSagemakerModelName' => '<string>',
        'stabilityClientId' => '<string>',
        'stabilityClientUserId' => '<string>',
        'stabilityClientVersion' => '<string>',
        'huggingfaceBaseUrl' => '<string>',
        'vertexRegion' => '<string>',
        'vertexProjectId' => '<string>',
        'vertexServiceAccountJson' => [
                
        ],
        'vertexStorageBucketName' => '<string>',
        'vertexModelName' => '<string>',
        'filename' => '<string>',
        'afterRequestHooks' => [
                [
                                
                ]
        ],
        'beforeRequestHooks' => [
                [
                                
                ]
        ],
        'defaultInputGuardrails' => [
                [
                                
                ]
        ],
        'defaultOutputGuardrails' => [
                [
                                
                ]
        ],
        'openaiProject' => '<string>',
        'openaiOrganization' => '<string>',
        'openaiBeta' => '<string>',
        'azureDeploymentName' => '<string>',
        'azureApiVersion' => '<string>',
        'azureExtraParams' => '<string>',
        'azureFoundryUrl' => '<string>',
        'strictOpenAiCompliance' => false,
        'mistralFimCompletion' => '<string>',
        'anthropicBeta' => '<string>',
        'anthropicVersion' => '<string>',
        'fireworksAccountId' => '<string>',
        'snowflakeAccount' => '<string>',
        'watsonxVersion' => '<string>',
        'watsonxSpaceId' => '<string>',
        'watsonxProjectId' => '<string>',
        'watsonxDeploymentId' => '<string>',
        'watsonxCpdUrl' => '<string>',
        'watsonxCpdUsername' => '<string>',
        'watsonxCpdPassword' => '<string>'
    ],
    'config' => [
        'decoding_method' => '<string>',
        'prompt' => '<string>',
        'max_tokens' => 123,
        'max_completion_tokens' => 123,
        'temperature' => 123,
        'top_p' => 123,
        'n' => 123,
        'stream' => true,
        'logprobs' => 123,
        'top_logprobs' => true,
        'echo' => true,
        'stop' => '<string>',
        'presence_penalty' => 123,
        'frequency_penalty' => 123,
        'best_of' => 123,
        'logit_bias' => [
                
        ],
        'user' => '<string>',
        'context' => '<string>',
        'examples' => [
                [
                                'input' => '<unknown>',
                                'output' => '<unknown>'
                ]
        ],
        'top_k' => 123,
        'response_format' => [
                'type' => '<string>',
                'json_schema' => null
        ],
        'seed' => 123,
        'store' => true,
        'metadata' => [
                
        ],
        'modalities' => [
                '<string>'
        ],
        'audio' => [
                'voice' => '<string>',
                'format' => '<string>'
        ],
        'service_tier' => '<string>',
        'prediction' => [
                'type' => '<string>',
                'content' => [
                                [
                                                                'type' => '<string>',
                                                                'text' => '<string>'
                                ]
                ]
        ],
        'safety_settings' => null,
        'anthropic_beta' => '<string>',
        'anthropic_version' => '<string>',
        'thinking' => [
                'budget_tokens' => 123,
                'type' => '<string>'
        ],
        'space_id' => '<string>',
        'project_id' => '<string>',
        'reasoning_effort' => '<string>'
    ],
    'description' => '<string>',
    'tags' => [
        '<string>'
    ],
    'model_type' => 'chat',
    'connection_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://{api_endpoint}/v1/models"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"provider_config\": {\n    \"api_key\": \"Dummy\",\n    \"urlToFetch\": \"<string>\",\n    \"resourceName\": \"<string>\",\n    \"deploymentId\": \"<string>\",\n    \"apiVersion\": \"<string>\",\n    \"adAuth\": \"<string>\",\n    \"azureAuthMode\": \"<string>\",\n    \"azureManagedClientId\": \"<string>\",\n    \"azureEntraClientId\": \"<string>\",\n    \"azureEntraClientSecret\": \"<string>\",\n    \"azureEntraTenantId\": \"<string>\",\n    \"azureAdToken\": \"<string>\",\n    \"azureModelName\": \"<string>\",\n    \"workersAiAccountId\": \"<string>\",\n    \"customHost\": \"<string>\",\n    \"forwardHeaders\": [\n      \"<string>\"\n    ],\n    \"index\": 123,\n    \"cache\": \"<string>\",\n    \"metadata\": {},\n    \"requestTimeout\": 123,\n    \"transformToFormData\": true,\n    \"awsSecretAccessKey\": \"<string>\",\n    \"awsAccessKeyId\": \"<string>\",\n    \"awsSessionToken\": \"<string>\",\n    \"awsRegion\": \"<string>\",\n    \"awsAuthType\": \"<string>\",\n    \"awsRoleArn\": \"<string>\",\n    \"awsExternalId\": \"<string>\",\n    \"awsS3Bucket\": \"<string>\",\n    \"awsS3ObjectKey\": \"<string>\",\n    \"awsBedrockModel\": \"<string>\",\n    \"awsServerSideEncryption\": \"<string>\",\n    \"awsServerSideEncryptionKMSKeyId\": \"<string>\",\n    \"amznSagemakerCustomAttributes\": \"<string>\",\n    \"amznSagemakerTargetModel\": \"<string>\",\n    \"amznSagemakerTargetVariant\": \"<string>\",\n    \"amznSagemakerTargetContainerHostname\": \"<string>\",\n    \"amznSagemakerInferenceId\": \"<string>\",\n    \"amznSagemakerEnableExplanations\": \"<string>\",\n    \"amznSagemakerInferenceComponent\": \"<string>\",\n    \"amznSagemakerSessionId\": \"<string>\",\n    \"amznSagemakerModelName\": \"<string>\",\n    \"stabilityClientId\": \"<string>\",\n    \"stabilityClientUserId\": \"<string>\",\n    \"stabilityClientVersion\": \"<string>\",\n    \"huggingfaceBaseUrl\": \"<string>\",\n    \"vertexRegion\": \"<string>\",\n    \"vertexProjectId\": \"<string>\",\n    \"vertexServiceAccountJson\": {},\n    \"vertexStorageBucketName\": \"<string>\",\n    \"vertexModelName\": \"<string>\",\n    \"filename\": \"<string>\",\n    \"afterRequestHooks\": [\n      {}\n    ],\n    \"beforeRequestHooks\": [\n      {}\n    ],\n    \"defaultInputGuardrails\": [\n      {}\n    ],\n    \"defaultOutputGuardrails\": [\n      {}\n    ],\n    \"openaiProject\": \"<string>\",\n    \"openaiOrganization\": \"<string>\",\n    \"openaiBeta\": \"<string>\",\n    \"azureDeploymentName\": \"<string>\",\n    \"azureApiVersion\": \"<string>\",\n    \"azureExtraParams\": \"<string>\",\n    \"azureFoundryUrl\": \"<string>\",\n    \"strictOpenAiCompliance\": false,\n    \"mistralFimCompletion\": \"<string>\",\n    \"anthropicBeta\": \"<string>\",\n    \"anthropicVersion\": \"<string>\",\n    \"fireworksAccountId\": \"<string>\",\n    \"snowflakeAccount\": \"<string>\",\n    \"watsonxVersion\": \"<string>\",\n    \"watsonxSpaceId\": \"<string>\",\n    \"watsonxProjectId\": \"<string>\",\n    \"watsonxDeploymentId\": \"<string>\",\n    \"watsonxCpdUrl\": \"<string>\",\n    \"watsonxCpdUsername\": \"<string>\",\n    \"watsonxCpdPassword\": \"<string>\"\n  },\n  \"config\": {\n    \"decoding_method\": \"<string>\",\n    \"prompt\": \"<string>\",\n    \"max_tokens\": 123,\n    \"max_completion_tokens\": 123,\n    \"temperature\": 123,\n    \"top_p\": 123,\n    \"n\": 123,\n    \"stream\": true,\n    \"logprobs\": 123,\n    \"top_logprobs\": true,\n    \"echo\": true,\n    \"stop\": \"<string>\",\n    \"presence_penalty\": 123,\n    \"frequency_penalty\": 123,\n    \"best_of\": 123,\n    \"logit_bias\": {},\n    \"user\": \"<string>\",\n    \"context\": \"<string>\",\n    \"examples\": [\n      {\n        \"input\": \"<unknown>\",\n        \"output\": \"<unknown>\"\n      }\n    ],\n    \"top_k\": 123,\n    \"response_format\": {\n      \"type\": \"<string>\",\n      \"json_schema\": null\n    },\n    \"seed\": 123,\n    \"store\": true,\n    \"metadata\": {},\n    \"modalities\": [\n      \"<string>\"\n    ],\n    \"audio\": {\n      \"voice\": \"<string>\",\n      \"format\": \"<string>\"\n    },\n    \"service_tier\": \"<string>\",\n    \"prediction\": {\n      \"type\": \"<string>\",\n      \"content\": [\n        {\n          \"type\": \"<string>\",\n          \"text\": \"<string>\"\n        }\n      ]\n    },\n    \"safety_settings\": null,\n    \"anthropic_beta\": \"<string>\",\n    \"anthropic_version\": \"<string>\",\n    \"thinking\": {\n      \"budget_tokens\": 123,\n      \"type\": \"<string>\"\n    },\n    \"space_id\": \"<string>\",\n    \"project_id\": \"<string>\",\n    \"reasoning_effort\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"model_type\": \"chat\",\n  \"connection_id\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://{api_endpoint}/v1/models")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"provider_config\": {\n    \"api_key\": \"Dummy\",\n    \"urlToFetch\": \"<string>\",\n    \"resourceName\": \"<string>\",\n    \"deploymentId\": \"<string>\",\n    \"apiVersion\": \"<string>\",\n    \"adAuth\": \"<string>\",\n    \"azureAuthMode\": \"<string>\",\n    \"azureManagedClientId\": \"<string>\",\n    \"azureEntraClientId\": \"<string>\",\n    \"azureEntraClientSecret\": \"<string>\",\n    \"azureEntraTenantId\": \"<string>\",\n    \"azureAdToken\": \"<string>\",\n    \"azureModelName\": \"<string>\",\n    \"workersAiAccountId\": \"<string>\",\n    \"customHost\": \"<string>\",\n    \"forwardHeaders\": [\n      \"<string>\"\n    ],\n    \"index\": 123,\n    \"cache\": \"<string>\",\n    \"metadata\": {},\n    \"requestTimeout\": 123,\n    \"transformToFormData\": true,\n    \"awsSecretAccessKey\": \"<string>\",\n    \"awsAccessKeyId\": \"<string>\",\n    \"awsSessionToken\": \"<string>\",\n    \"awsRegion\": \"<string>\",\n    \"awsAuthType\": \"<string>\",\n    \"awsRoleArn\": \"<string>\",\n    \"awsExternalId\": \"<string>\",\n    \"awsS3Bucket\": \"<string>\",\n    \"awsS3ObjectKey\": \"<string>\",\n    \"awsBedrockModel\": \"<string>\",\n    \"awsServerSideEncryption\": \"<string>\",\n    \"awsServerSideEncryptionKMSKeyId\": \"<string>\",\n    \"amznSagemakerCustomAttributes\": \"<string>\",\n    \"amznSagemakerTargetModel\": \"<string>\",\n    \"amznSagemakerTargetVariant\": \"<string>\",\n    \"amznSagemakerTargetContainerHostname\": \"<string>\",\n    \"amznSagemakerInferenceId\": \"<string>\",\n    \"amznSagemakerEnableExplanations\": \"<string>\",\n    \"amznSagemakerInferenceComponent\": \"<string>\",\n    \"amznSagemakerSessionId\": \"<string>\",\n    \"amznSagemakerModelName\": \"<string>\",\n    \"stabilityClientId\": \"<string>\",\n    \"stabilityClientUserId\": \"<string>\",\n    \"stabilityClientVersion\": \"<string>\",\n    \"huggingfaceBaseUrl\": \"<string>\",\n    \"vertexRegion\": \"<string>\",\n    \"vertexProjectId\": \"<string>\",\n    \"vertexServiceAccountJson\": {},\n    \"vertexStorageBucketName\": \"<string>\",\n    \"vertexModelName\": \"<string>\",\n    \"filename\": \"<string>\",\n    \"afterRequestHooks\": [\n      {}\n    ],\n    \"beforeRequestHooks\": [\n      {}\n    ],\n    \"defaultInputGuardrails\": [\n      {}\n    ],\n    \"defaultOutputGuardrails\": [\n      {}\n    ],\n    \"openaiProject\": \"<string>\",\n    \"openaiOrganization\": \"<string>\",\n    \"openaiBeta\": \"<string>\",\n    \"azureDeploymentName\": \"<string>\",\n    \"azureApiVersion\": \"<string>\",\n    \"azureExtraParams\": \"<string>\",\n    \"azureFoundryUrl\": \"<string>\",\n    \"strictOpenAiCompliance\": false,\n    \"mistralFimCompletion\": \"<string>\",\n    \"anthropicBeta\": \"<string>\",\n    \"anthropicVersion\": \"<string>\",\n    \"fireworksAccountId\": \"<string>\",\n    \"snowflakeAccount\": \"<string>\",\n    \"watsonxVersion\": \"<string>\",\n    \"watsonxSpaceId\": \"<string>\",\n    \"watsonxProjectId\": \"<string>\",\n    \"watsonxDeploymentId\": \"<string>\",\n    \"watsonxCpdUrl\": \"<string>\",\n    \"watsonxCpdUsername\": \"<string>\",\n    \"watsonxCpdPassword\": \"<string>\"\n  },\n  \"config\": {\n    \"decoding_method\": \"<string>\",\n    \"prompt\": \"<string>\",\n    \"max_tokens\": 123,\n    \"max_completion_tokens\": 123,\n    \"temperature\": 123,\n    \"top_p\": 123,\n    \"n\": 123,\n    \"stream\": true,\n    \"logprobs\": 123,\n    \"top_logprobs\": true,\n    \"echo\": true,\n    \"stop\": \"<string>\",\n    \"presence_penalty\": 123,\n    \"frequency_penalty\": 123,\n    \"best_of\": 123,\n    \"logit_bias\": {},\n    \"user\": \"<string>\",\n    \"context\": \"<string>\",\n    \"examples\": [\n      {\n        \"input\": \"<unknown>\",\n        \"output\": \"<unknown>\"\n      }\n    ],\n    \"top_k\": 123,\n    \"response_format\": {\n      \"type\": \"<string>\",\n      \"json_schema\": null\n    },\n    \"seed\": 123,\n    \"store\": true,\n    \"metadata\": {},\n    \"modalities\": [\n      \"<string>\"\n    ],\n    \"audio\": {\n      \"voice\": \"<string>\",\n      \"format\": \"<string>\"\n    },\n    \"service_tier\": \"<string>\",\n    \"prediction\": {\n      \"type\": \"<string>\",\n      \"content\": [\n        {\n          \"type\": \"<string>\",\n          \"text\": \"<string>\"\n        }\n      ]\n    },\n    \"safety_settings\": null,\n    \"anthropic_beta\": \"<string>\",\n    \"anthropic_version\": \"<string>\",\n    \"thinking\": {\n      \"budget_tokens\": 123,\n      \"type\": \"<string>\"\n    },\n    \"space_id\": \"<string>\",\n    \"project_id\": \"<string>\",\n    \"reasoning_effort\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"model_type\": \"chat\",\n  \"connection_id\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{api_endpoint}/v1/models")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"provider_config\": {\n    \"api_key\": \"Dummy\",\n    \"urlToFetch\": \"<string>\",\n    \"resourceName\": \"<string>\",\n    \"deploymentId\": \"<string>\",\n    \"apiVersion\": \"<string>\",\n    \"adAuth\": \"<string>\",\n    \"azureAuthMode\": \"<string>\",\n    \"azureManagedClientId\": \"<string>\",\n    \"azureEntraClientId\": \"<string>\",\n    \"azureEntraClientSecret\": \"<string>\",\n    \"azureEntraTenantId\": \"<string>\",\n    \"azureAdToken\": \"<string>\",\n    \"azureModelName\": \"<string>\",\n    \"workersAiAccountId\": \"<string>\",\n    \"customHost\": \"<string>\",\n    \"forwardHeaders\": [\n      \"<string>\"\n    ],\n    \"index\": 123,\n    \"cache\": \"<string>\",\n    \"metadata\": {},\n    \"requestTimeout\": 123,\n    \"transformToFormData\": true,\n    \"awsSecretAccessKey\": \"<string>\",\n    \"awsAccessKeyId\": \"<string>\",\n    \"awsSessionToken\": \"<string>\",\n    \"awsRegion\": \"<string>\",\n    \"awsAuthType\": \"<string>\",\n    \"awsRoleArn\": \"<string>\",\n    \"awsExternalId\": \"<string>\",\n    \"awsS3Bucket\": \"<string>\",\n    \"awsS3ObjectKey\": \"<string>\",\n    \"awsBedrockModel\": \"<string>\",\n    \"awsServerSideEncryption\": \"<string>\",\n    \"awsServerSideEncryptionKMSKeyId\": \"<string>\",\n    \"amznSagemakerCustomAttributes\": \"<string>\",\n    \"amznSagemakerTargetModel\": \"<string>\",\n    \"amznSagemakerTargetVariant\": \"<string>\",\n    \"amznSagemakerTargetContainerHostname\": \"<string>\",\n    \"amznSagemakerInferenceId\": \"<string>\",\n    \"amznSagemakerEnableExplanations\": \"<string>\",\n    \"amznSagemakerInferenceComponent\": \"<string>\",\n    \"amznSagemakerSessionId\": \"<string>\",\n    \"amznSagemakerModelName\": \"<string>\",\n    \"stabilityClientId\": \"<string>\",\n    \"stabilityClientUserId\": \"<string>\",\n    \"stabilityClientVersion\": \"<string>\",\n    \"huggingfaceBaseUrl\": \"<string>\",\n    \"vertexRegion\": \"<string>\",\n    \"vertexProjectId\": \"<string>\",\n    \"vertexServiceAccountJson\": {},\n    \"vertexStorageBucketName\": \"<string>\",\n    \"vertexModelName\": \"<string>\",\n    \"filename\": \"<string>\",\n    \"afterRequestHooks\": [\n      {}\n    ],\n    \"beforeRequestHooks\": [\n      {}\n    ],\n    \"defaultInputGuardrails\": [\n      {}\n    ],\n    \"defaultOutputGuardrails\": [\n      {}\n    ],\n    \"openaiProject\": \"<string>\",\n    \"openaiOrganization\": \"<string>\",\n    \"openaiBeta\": \"<string>\",\n    \"azureDeploymentName\": \"<string>\",\n    \"azureApiVersion\": \"<string>\",\n    \"azureExtraParams\": \"<string>\",\n    \"azureFoundryUrl\": \"<string>\",\n    \"strictOpenAiCompliance\": false,\n    \"mistralFimCompletion\": \"<string>\",\n    \"anthropicBeta\": \"<string>\",\n    \"anthropicVersion\": \"<string>\",\n    \"fireworksAccountId\": \"<string>\",\n    \"snowflakeAccount\": \"<string>\",\n    \"watsonxVersion\": \"<string>\",\n    \"watsonxSpaceId\": \"<string>\",\n    \"watsonxProjectId\": \"<string>\",\n    \"watsonxDeploymentId\": \"<string>\",\n    \"watsonxCpdUrl\": \"<string>\",\n    \"watsonxCpdUsername\": \"<string>\",\n    \"watsonxCpdPassword\": \"<string>\"\n  },\n  \"config\": {\n    \"decoding_method\": \"<string>\",\n    \"prompt\": \"<string>\",\n    \"max_tokens\": 123,\n    \"max_completion_tokens\": 123,\n    \"temperature\": 123,\n    \"top_p\": 123,\n    \"n\": 123,\n    \"stream\": true,\n    \"logprobs\": 123,\n    \"top_logprobs\": true,\n    \"echo\": true,\n    \"stop\": \"<string>\",\n    \"presence_penalty\": 123,\n    \"frequency_penalty\": 123,\n    \"best_of\": 123,\n    \"logit_bias\": {},\n    \"user\": \"<string>\",\n    \"context\": \"<string>\",\n    \"examples\": [\n      {\n        \"input\": \"<unknown>\",\n        \"output\": \"<unknown>\"\n      }\n    ],\n    \"top_k\": 123,\n    \"response_format\": {\n      \"type\": \"<string>\",\n      \"json_schema\": null\n    },\n    \"seed\": 123,\n    \"store\": true,\n    \"metadata\": {},\n    \"modalities\": [\n      \"<string>\"\n    ],\n    \"audio\": {\n      \"voice\": \"<string>\",\n      \"format\": \"<string>\"\n    },\n    \"service_tier\": \"<string>\",\n    \"prediction\": {\n      \"type\": \"<string>\",\n      \"content\": [\n        {\n          \"type\": \"<string>\",\n          \"text\": \"<string>\"\n        }\n      ]\n    },\n    \"safety_settings\": null,\n    \"anthropic_beta\": \"<string>\",\n    \"anthropic_version\": \"<string>\",\n    \"thinking\": {\n      \"budget_tokens\": 123,\n      \"type\": \"<string>\"\n    },\n    \"space_id\": \"<string>\",\n    \"project_id\": \"<string>\",\n    \"reasoning_effort\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"model_type\": \"chat\",\n  \"connection_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
display_name
string
required
provider_config
Options · object
required
config
ModelConfig · object | null
description
string | null
tags
string[] | null
model_type
enum<string>
default:chat
Available options:
chat,
chat_vision,
completion,
embedding
connection_id
string | null

Response

Successful Response