API

System APIs

GET global/ai-models/{aiModelId}

Returns details for the specified AI language model, including its current price and replacement model when available.

HTTP method GET
URI https://api.rambase.net/global/ai-models/{aiModelId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {aiModelId} Language model identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 7435, version 5

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<AiModel>
2
     <AiModelId
AiModelId

Language model identifier

>
{Integer}</AiModelId>
3
     <Name
Name

The provider-assigned model name.

>
{String}</Name>
4
     <IsActive
IsActive

Indicates whether the model is active.

>
{Boolean}</IsActive>
5
     <IsDefault
IsDefault

True if language model is default for users

>
{Boolean}</IsDefault>
6
     <DisplayName
DisplayName

The display name of the model.

>
{String}</DisplayName>
7
     <DisplayCost
DisplayCost

The model's relative display cost.

>
{String}</DisplayCost>
8
     <AiProvider>
9
          <AiProviderId
AiProviderId

The identifier of the AI provider.

>
{Integer}</AiProviderId>
10
          <Name
Name

The name of the AI provider.

>
{String}</Name>
11
     </AiProvider>
12
     <ReplacementModel>
13
          <ModelId
ModelId

Language model identifier

>
{Integer}</ModelId>
14
          <Name
Name

The provider-assigned model name.

>
{String}</Name>
15
     </ReplacementModel>
16
     <CurrentPrice>
17
          <AiModelPriceId
AiModelPriceId

The identifier of the AI model price.

>
{Integer}</AiModelPriceId>
18
          <Currency
Currency

The currency code used for the price.

>
{String}</Currency>
19
          <Validity>
20
               <EffectiveDate
EffectiveDate

The date from which the model price is effective.

>
{Date}</EffectiveDate>
21
               <ExpirationDate
ExpirationDate

The date through which the model price is effective.

>
{Date}</ExpirationDate>
22
          </Validity>
23
          <InputPrice
InputPrice

The customer price for input usage.

>
{Decimal}</InputPrice>
24
          <OutputPrice
OutputPrice

The customer price for output usage.

>
{Decimal}</OutputPrice>
25
          <CacheReadPrice
CacheReadPrice

The customer price for cached input reads.

>
{Decimal}</CacheReadPrice>
26
          <CacheWritePrice
CacheWritePrice

The customer price for cache writes.

>
{Decimal}</CacheWritePrice>
27
     </CurrentPrice>
28
</AiModel>
1
{
2
     "aiModel": {
3
          "aiModelId
AiModelId

Language model identifier

":
"{Integer}",
4
          "name
Name

The provider-assigned model name.

":
"{String}",
5
          "isActive
IsActive

Indicates whether the model is active.

":
"{Boolean}",
6
          "isDefault
IsDefault

True if language model is default for users

":
"{Boolean}",
7
          "displayName
DisplayName

The display name of the model.

":
"{String}",
8
          "displayCost
DisplayCost

The model's relative display cost.

":
"{String}",
9
          "aiProvider": {
10
               "aiProviderId
AiProviderId

The identifier of the AI provider.

":
"{Integer}",
11
               "name
Name

The name of the AI provider.

":
"{String}"
12
          },
13
          "replacementModel": {
14
               "modelId
ModelId

Language model identifier

":
"{Integer}",
15
               "name
Name

The provider-assigned model name.

":
"{String}"
16
          },
17
          "currentPrice": {
18
               "aiModelPriceId
AiModelPriceId

The identifier of the AI model price.

":
"{Integer}",
19
               "currency
Currency

The currency code used for the price.

":
"{String}",
20
               "validity": {
21
                    "effectiveDate
EffectiveDate

The date from which the model price is effective.

":
"{Date}",
22
                    "expirationDate
ExpirationDate

The date through which the model price is effective.

":
"{Date}"
23
               },
24
               "inputPrice
InputPrice

The customer price for input usage.

":
"{Decimal}",
25
               "outputPrice
OutputPrice

The customer price for output usage.

":
"{Decimal}",
26
               "cacheReadPrice
CacheReadPrice

The customer price for cached input reads.

":
"{Decimal}",
27
               "cacheWritePrice
CacheWritePrice

The customer price for cache writes.

":
"{Decimal}"
28
          }
29
     }
30
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return: