(Java) 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 Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux, Solaris Java Libs for Android

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    // 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.
    http.put_AuthToken("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");

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    success = http.QuickGetSb("https://api.openai.com/v1/models",sbResponseBody);
    if (success == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = http.get_LastStatus();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(http.lastHeader());
        System.out.println("Failed.");
        return;
        }

    // 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

    String id;
    int created;
    String owned_by;
    String root;
    String parent;
    int j;
    int count_j;
    boolean allow_create_engine;
    boolean allow_sampling;
    boolean allow_logprobs;
    boolean allow_search_indices;
    boolean allow_view;
    boolean allow_fine_tuning;
    String organization;
    String group;
    boolean is_blocking;

    String v_object = jResp.stringOf("object");
    int i = 0;
    int count_i = jResp.SizeOfArray("data");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("data[i].id");
        v_object = jResp.stringOf("data[i].object");
        created = jResp.IntOf("data[i].created");
        owned_by = jResp.stringOf("data[i].owned_by");
        root = jResp.stringOf("data[i].root");
        parent = jResp.stringOf("data[i].parent");
        j = 0;
        count_j = jResp.SizeOfArray("data[i].permission");
        while (j < count_j) {
            jResp.put_J(j);
            id = jResp.stringOf("data[i].permission[j].id");
            v_object = jResp.stringOf("data[i].permission[j].object");
            created = jResp.IntOf("data[i].permission[j].created");
            allow_create_engine = jResp.BoolOf("data[i].permission[j].allow_create_engine");
            allow_sampling = jResp.BoolOf("data[i].permission[j].allow_sampling");
            allow_logprobs = jResp.BoolOf("data[i].permission[j].allow_logprobs");
            allow_search_indices = jResp.BoolOf("data[i].permission[j].allow_search_indices");
            allow_view = jResp.BoolOf("data[i].permission[j].allow_view");
            allow_fine_tuning = jResp.BoolOf("data[i].permission[j].allow_fine_tuning");
            organization = jResp.stringOf("data[i].permission[j].organization");
            group = jResp.stringOf("data[i].permission[j].group");
            is_blocking = jResp.BoolOf("data[i].permission[j].is_blocking");
            j = j+1;
            }

        i = i+1;
        }
  }
}