Skip to main content
GET
/
api
/
cloud-models
/
{id}
Get CloudModel by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/cloud-models/{id} \
  --header 'x-api-key: <api-key>'
{
  "active": true,
  "cachedTokenPrice": 123,
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "embedding": true,
  "id": "<string>",
  "imageUrl": "<string>",
  "inputTokenPrice": 123,
  "modelId": "<string>",
  "name": "<string>",
  "outputTokenPrice": 123,
  "provider": "<string>",
  "providerUrl": "<string>",
  "thinkingTokenPrice": 123,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id
string<uuid>
required

Unique identifier (UUID) of the resource.

Response

The CloudModel

A cloud model configures an external AI model for document processing.

active
boolean | null
cachedTokenPrice
number<double>
changeSequence
integer<int32>
createdOn
string<date-time>
description
string
embedding
boolean | null
id
string
imageUrl
string
inputTokenPrice
number<double>
modelId
string
name
string
outputTokenPrice
number<double>
provider
string
providerUrl
string
thinkingTokenPrice
number<double>
updatedOn
string<date-time>
uuid
string