Get Model

GET

models

get-model

curl --request GET \
  --url https://api.enkryptai.com/models/get-model \
  --header 'X-Enkrypt-Model: <x-enkrypt-model>' \
  --header 'X-Enkrypt-Model-Version: <x-enkrypt-model-version>' \
  --header 'apikey: <api-key>'

{
  "testing_for": "foundationModels",
  "model_name": "mistralai/Mixtral-8x7B-Instruct-v0.1",
  "certifications": [],
  "model_config": {
    "paths": {
      "chat": "/chat/completions",
      "completions": "/completions"
    },
    "apikeys": [
      "xxxxx"
    ],
    "endpoint": {
      "host": "api.together.xyz",
      "port": 443,
      "scheme": "https",
      "base_path": "/v1"
    },
    "auth_data": {
      "header_name": "Authorization",
      "header_prefix": "Bearer",
      "space_after_prefix": true
    },
    "input_modalities": [
      "text"
    ],
    "output_modalities": [
      "text"
    ],
    "model_source": "https://together.ai",
    "system_prompt": "",
    "tools": [
      {
        "name": "web_search",
        "description": "The tool web search is used to search the web for information related to finance."
      }
    ],
    "metadata": {},
    "default_request_options": {}
  },
  "model_saved_name": "Test Model",
  "model_version": "v1",
  "created_at": "2024-10-15T17:22:47.872389+00:00",
  "updated_at": "2024-10-15T17:22:47.872389+00:00",
  "model_id": 1234567890,
  "model_provider": "together",
  "project_name": "default",
  "hosting_type": "External"
}

Authorizations

apikey

string

header

required

Headers

X-Enkrypt-Model

string

required

The model saved name. E.g. Test Model

Example:

"Test Model"

X-Enkrypt-Model-Version

string

required

The model version. Default is 'v1'

Example:

"v1"

X-Enkrypt-Refresh-Cache

boolean

Refresh the cache if data is stale

Example:

false

Response

200 - application/json

Successful Response

model_config

object

required

model_config.model_provider

enum<string>

required

Provider of the model which determines the request response format

Available options:

openai,

together,

huggingface,

groq,

azure_openai,

anthropic,

cohere,

bedrock,

gemini,

ai21,

fireworks,

alibaba,

portkey,

deepseek,

mistral,

llama,

openai_compatible,

cohere_compatible,

anthropic_compatible,

custom

Example:

"together"

model_config.endpoint

object

required

model_config.hosting_type

enum<string>

Hosting type of the model

Available options:

External,

Internal

Example:

"External"

model_config.model_source

string

Source of the model

Example:

"https://together.ai"

model_config.tools

object[]

Array of tools available to the model

Example:

[
  {
    "name": "web_search",
    "description": "The tool web search is used to search the web for information related to finance."
  }
]

model_config.input_modalities

enum<string>[]

Types of input that the model can process

Available options:

text,

image,

audio

Example:

["text"]

model_config.output_modalities

enum<string>[]

Types of output that the model can generate

Available options:

text

Example:

["text"]

model_config.rate_per_min

number

< 100 won't enable async. > 100 will enable async mode. > 200 we can run boosted async (all tests in parallel). Default 20.

Example:

20

model_config.system_prompt

string

System prompt

Example:

""

model_config.paths

object

model_config.auth_data

object

model_config.apikeys

string[]

Example:

["TOGETHER_AI_API_KEY"]

model_config.custom_headers

object[]

Array of custom headers to be sent with requests

Example:

[
  {
    "key": "X-Custom-Header",
    "value": "custom-value"
  }
]

model_config.custom_payload

object

A flexible object that can contain any custom key-value pairs for the request payload. Only condition is to include {prompt} in the payload.

Example:

{
  "messages": [
    {
      "role": "developer",
      "content": "You are a helpful assistant."
    },
    { "role": "user", "content": "{prompt}" }
  ]
}

model_config.custom_response_content_type

enum<string>

Content type of the custom response. Currently only supports JSON.

Available options:

json

Example:

"json"

model_config.custom_response_format

string

Optional response format path. Jq format for json type (e.g. '.choices[0].message.content')

Example:

".choices[0].message.content"

model_config.metadata

object

model_config.default_request_options

object

model_saved_name

string

required

Name of the saved model

Example:

"Test Model"

model_version

string

required

Custom identifier for the model

Example:

"v1"

testing_for

enum<string>

Purpose of testing

Available options:

foundationModels,

chatbotsAndCopilots,

agents

Example:

"foundationModels"

model_name

string

Name of the model. Required for foundationModels

Example:

"mistralai/Mixtral-8x7B-Instruct-v0.1"

certifications

string[]

List of certifications

Example:

[
  "GDPR",
  "CCPA",
  "HIPAA",
  "SOC 2 Type II",
  "SOC 3"
]

model_id

integer

Example:

1234567890

created_at

string

Example:

"2024-10-15T17:22:47.872389+00:00"

updated_at

string

Example:

"2024-10-15T17:22:47.872389+00:00"

project_name

string

Example:

"default"

Create Model Modify Model

curl --request GET \
  --url https://api.enkryptai.com/models/get-model \
  --header 'X-Enkrypt-Model: <x-enkrypt-model>' \
  --header 'X-Enkrypt-Model-Version: <x-enkrypt-model-version>' \
  --header 'apikey: <api-key>'

{
  "testing_for": "foundationModels",
  "model_name": "mistralai/Mixtral-8x7B-Instruct-v0.1",
  "certifications": [],
  "model_config": {
    "paths": {
      "chat": "/chat/completions",
      "completions": "/completions"
    },
    "apikeys": [
      "xxxxx"
    ],
    "endpoint": {
      "host": "api.together.xyz",
      "port": 443,
      "scheme": "https",
      "base_path": "/v1"
    },
    "auth_data": {
      "header_name": "Authorization",
      "header_prefix": "Bearer",
      "space_after_prefix": true
    },
    "input_modalities": [
      "text"
    ],
    "output_modalities": [
      "text"
    ],
    "model_source": "https://together.ai",
    "system_prompt": "",
    "tools": [
      {
        "name": "web_search",
        "description": "The tool web search is used to search the web for information related to finance."
      }
    ],
    "metadata": {},
    "default_request_options": {}
  },
  "model_saved_name": "Test Model",
  "model_version": "v1",
  "created_at": "2024-10-15T17:22:47.872389+00:00",
  "updated_at": "2024-10-15T17:22:47.872389+00:00",
  "model_id": 1234567890,
  "model_provider": "together",
  "project_name": "default",
  "hosting_type": "External"
}

Endpoints API Documentation

Endpoints (Models) APIs

Authorizations

Headers

Response