Xojo Plugin

AI: Diagnosing an Ask Failure

See more AI Examples

Demonstrates how to get information about why a request to the AI provider failed. Xojo Plugin

Dim success As Boolean
success = False

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

Dim ai As New Chilkat.Ai

//  The provider can be "openai", "google", "claude", "deepseek", "xai", or "perplexity".
//  Support for additional providers will be added in future versions of Chilkat.
ai.Provider = "openai"

//  In this case, we're going to cause an intentional failure by using an invalid API key.
ai.ApiKey = "sk-11111111111111111111111111111111111111111111111k"

//  Choose a model.
ai.Model = "gpt-5.6-terra"

//  Add a text input.
success = ai.InputAddText("Say Hello.")

//  Ask the AI for text output.
success = ai.Ask("text")
If (success = False) Then
    //  If the response status code equals 0, it means the error occurred before receiving the HTTP response.
    //  For this case look at the LastErrorText.
    If (ai.ResponseStatusCode = 0) Then
        System.DebugLog(ai.LastErrorText)
    Else
        //  If we received an error response, the status code will be >= 400.
        //  (Ask would've returned 1 if the response status code was 200.)
        System.DebugLog("Response status code: " + Str(ai.ResponseStatusCode))

        //  The error response (JSON) is available in the LastJsonData.
        Dim json As New Chilkat.JsonObject
        json.EmitCompact = False
        ai.GetLastJsonData json
        System.DebugLog(json.Emit())

        //  Sample output:
        //  {
        //    "error": {
        //      "message": "Incorrect API key provided: sk-11111***************************************111k. You can find your API key at https://platform.openai.com/account/api-keys.",
        //      "type": "invalid_request_error",
        //      "param": null,
        //      "code": "invalid_api_key"
        //    }
        //  }
    End If

    Return
End If

//  Get the text response.
Dim sbResponse As New Chilkat.StringBuilder
success = ai.GetOutputTextSb(sbResponse)
System.DebugLog(sbResponse.GetAsString())