🔮AI

Note: Currently, only OpenAI is supported as the AI provider. In the future, we may support other providers.

Common Request Body

Every request must include an openAIConfiguration object in the body:

{
  "openAIConfiguration": {
    "apiKey": "string",
    "model": "string"
  },
  // Operation-specific body below
}

Where:

• apiKey: Your OpenAI API key.

• model: The OpenAI model to use (e.g., gpt-4).

Response Format

All requests return a standard response structure:

{
  "status": "ResponseStatus",
  "response": "string",
  "openAiError": "AIError (optional)"
}

• status: The request status (see the ResponseStatus enum).

• response: The output generated by OpenAI.

• openAiError (optional): Any OpenAI-specific error (see the AIError enum).

public enum AIError : byte {
    UNKNOWN = 0,
    CONTENT_FLAGGED = 1,
    TOO_LONG = 2,
    INVALID_API_KEY = 3
}