Skip to main content
GET
/
custom-tool
/
preferred-models
cURL
curl --request GET \
  --url https://api.beamstudio.ai/custom-tool/preferred-models \
  --header 'current-workspace-id: <current-workspace-id>' \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "modelName": "<string>",
    "modelValue": "<string>",
    "isDefault": true,
    "llmsGroupId": "<string>",
    "creditsCost": 123,
    "inputTokenPrice": 123,
    "outputTokenPrice": 123,
    "enableInChat": true,
    "isPremium": true,
    "llmsGroup": {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "icon": "<string>",
      "isActive": true,
      "llmModels": "<array>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.beam.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

Headers

current-workspace-id
string
required

Response

200 - application/json
id
string
required
modelName
string
required
modelValue
string
required
isDefault
boolean
required
llmsGroupId
string
required
creditsCost
number
required
inputTokenPrice
number
required
outputTokenPrice
number
required
enableInChat
boolean
required
isPremium
boolean
required
llmsGroup
object
required