(Tcl) OpenAI (ChatGTP) List Models

See more OpenAI ChatGPT Examples

Show how to list available OpenAI models and shows how to parse the JSON model information.

For more information, see https://platform.openai.com/docs/api-reference/models/list

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# Implements the following CURL command:

# curl https://api.openai.com/v1/models \
#   -H "Authorization: Bearer $OPENAI_API_KEY"

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

# Adds the "Authorization: Bearer $OPENAI_API_KEY" header.
# This is NOT a real key.  Change the "sk-vi...." to your own key.
CkHttp_put_AuthToken $http "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"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://api.openai.com/v1/models" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "object": "list",
#   "data": [
#     {
#       "id": "babbage",
#       "object": "model",
#       "created": 1649358449,
#       "owned_by": "openai",
#       "permission": [
#         {
#           "id": "modelperm-49FUp5v084tBB49tC4z8LPH5",
#           "object": "model_permission",
#           "created": 1669085501,
#           "allow_create_engine": false,
#           "allow_sampling": true,
#           "allow_logprobs": true,
#           "allow_search_indices": false,
#           "allow_view": true,
#           "allow_fine_tuning": false,
#           "organization": "*",
#           "group": null,
#           "is_blocking": false
#         }
#       ],
#       "root": "babbage",
#       "parent": null
#     },
#     {
#       "id": "davinci",
#       "object": "model",
#       "created": 1649359874,
#       "owned_by": "openai",
#       "permission": [
#         {
#           "id": "modelperm-U6ZwlyAd0LyMk4rcMdz33Yc3",
#           "object": "model_permission",
#           "created": 1669066355,
#           "allow_create_engine": false,
#           "allow_sampling": true,
#           "allow_logprobs": true,
#           "allow_search_indices": false,
#           "allow_view": true,
#           "allow_fine_tuning": false,
#           "organization": "*",
#           "group": null,
#           "is_blocking": false
#         }
#       ],
#       "root": "davinci",
#       "parent": null
#     },
# ...
# ...

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

set v_object [CkJsonObject_stringOf $jResp "object"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set id [CkJsonObject_stringOf $jResp "data[i].id"]
    set v_object [CkJsonObject_stringOf $jResp "data[i].object"]
    set created [CkJsonObject_IntOf $jResp "data[i].created"]
    set owned_by [CkJsonObject_stringOf $jResp "data[i].owned_by"]
    set root [CkJsonObject_stringOf $jResp "data[i].root"]
    set parent [CkJsonObject_stringOf $jResp "data[i].parent"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "data[i].permission"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set id [CkJsonObject_stringOf $jResp "data[i].permission[j].id"]
        set v_object [CkJsonObject_stringOf $jResp "data[i].permission[j].object"]
        set created [CkJsonObject_IntOf $jResp "data[i].permission[j].created"]
        set allow_create_engine [CkJsonObject_BoolOf $jResp "data[i].permission[j].allow_create_engine"]
        set allow_sampling [CkJsonObject_BoolOf $jResp "data[i].permission[j].allow_sampling"]
        set allow_logprobs [CkJsonObject_BoolOf $jResp "data[i].permission[j].allow_logprobs"]
        set allow_search_indices [CkJsonObject_BoolOf $jResp "data[i].permission[j].allow_search_indices"]
        set allow_view [CkJsonObject_BoolOf $jResp "data[i].permission[j].allow_view"]
        set allow_fine_tuning [CkJsonObject_BoolOf $jResp "data[i].permission[j].allow_fine_tuning"]
        set organization [CkJsonObject_stringOf $jResp "data[i].permission[j].organization"]
        set group [CkJsonObject_stringOf $jResp "data[i].permission[j].group"]
        set is_blocking [CkJsonObject_BoolOf $jResp "data[i].permission[j].is_blocking"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp