🐛 Bug: Unknown GraphQL Error

[sudo-vaibhav]

♻️ Reproduction Steps

import {
  CopilotRuntime,
  GoogleGenerativeAIAdapter,
  copilotRuntimeNodeHttpEndpoint,
} from "@copilotkit/runtime";

import {
  createPartFromUri,
  createUserContent,
  GoogleGenAI,
} from "@google/genai";
import express from "express";

const GEMINI_API_KEY = process.env.AI_API_KEY;

const googleAI = new GoogleGenAI({ apiKey: GEMINI_API_KEY });

const serviceAdapter = new GoogleGenerativeAIAdapter({
  model: "gemini-2.0-flash",
  apiKey: GEMINI_API_KEY,
});

export function configureCopilotRuntimeMiddleware(apiPath = "/api/ai") {
  return {
    middleware: async (
      req: express.Request,
      res: express.Response,
      next: express.NextFunction,
    ) => {
      const runtime = new CopilotRuntime({});
      const handler = copilotRuntimeNodeHttpEndpoint({
        endpoint: apiPath,
        runtime,
        serviceAdapter,
        logLevel: "error",
      });

      try {
        await handler(req, res);
      } catch (err) {
        next(err);
      }
    },
    apiPath: apiPath,
  };
}

Frontend

import {
  CopilotKit,
  useCopilotAction,
  useCopilotReadable,
} from "@copilotkit/react-core";

export const CopilotProvider = (props: {
  children: React.ReactNode;
  runtimeUrl?: string;
  headers?: Record<string, string>;
}) => {
  return (
    <CopilotKit
      // publicApiKey="ck_pub_d4fbbcc340cbe5bace584b3766d2971e"
      runtimeUrl={props.runtimeUrl || "/api/ai"}
      headers={props.headers}
    >
      {props.children}
    </CopilotKit>
  );
};

export const useCopilotClientSideAction = useCopilotAction;
export const useCopilotClientSideContext = useCopilotReadable;

export const CopilotPopup = () => {
  return (
    <div
      style={
        {
          "--copilot-kit-primary-color": "var(--color-primary)", // Primary Blue (theme.colors.primary)
          "--copilot-kit-secondary-color": "var(--color-secondary)", // Secondary Yellow (theme.colors.secondary)
          "--copilot-kit-background-color": "var(--color-surface)", // White background (theme.colors.white)
          "--copilot-kit-text-color": "var(--color-content)", // Dark grey text (theme.colors.grey[800])
          "--copilot-kit-border-radius": "6px", // Medium border radius (theme.borderRadius.medium)
        } as CopilotKitCSSProperties
      }
    >
      <CopilotPopupComponent
        instructions={systemPrompt}
        labels={{
          title: "Intelligence App",
          initial: "Need any help?",
        }}
      />
    </div>
  );
};

✅ Expected Behavior

a response from copilotkit copilot

❌ Actual Behavior

Application error: GraphQLError: An unexpected error occurred. Please check the logs for more details. ║
at CopilotResolver.generateCopilotResponse (/Users/sudomakes/code/nx-monorepo/dist/apps/backend-core/webpack:/node_modules/@copilotkit/ru ║
ntime/dist/index.js:7267:1) ║
at processTicksAndRejections (node:internal/process/task_queues:105:5) { ║
path: [ 'generateCopilotResponse' ], ║
locations: [ { line: 2, column: 3 } ], ║
extensions: { ║
name: 'CopilotError', ║
statusCode: 500, ║
code: 'UNKNOWN', ║
visibility: 'toast', ║
severity: 'critical', ║
troubleshootingUrl: null, ║
originalError: CopilotKitError [GraphQLError] [CopilotError]: An unexpected error occurred. Please check the logs for more details. ║
at new CopilotKitError (/Users/sudomakes/code/nx-monorepo/dist/apps/backend-core/webpack:/node_modules/@copilotkit/shared/dist/index. ║
js:349:1) ║
at CopilotRuntime.convertStreamingErrorToStructured (/Users/sudomakes/code/nx-monorepo/dist/apps/backend-core/webpack:/node_modules/@ ║
copilotkit/runtime/dist/index.js:5743:1) ║
at /Users/sudomakes/code/nx-monorepo/dist/apps/backend-core/webpack:/node_modules/@copilotkit/runtime/dist/index.js:5115:1 ║
at ensureStructuredError (/Users/sudomakes/code/nx-monorepo/dist/apps/backend-core/webpack:/node_modules/@copilotkit/shared/dist/inde ║
x.js:518:1) ║
at CopilotRuntime.processRuntimeRequest (/Users/sudomakes/code/nx-monorepo/dist/apps/backend-core/webpack:/node_modules/@copilotkit/r ║
untime/dist/index.js:5115:1) ║
at processTicksAndRejections (node:internal/process/task_queues:105:5) ║
at CopilotResolver.generateCopilotResponse (/Users/sudomakes/code/nx-monorepo/dist/apps/backend-core/webpack:/node_modules/@copilotki ║
t/runtime/dist/index.js:7249:1) { ║
path: undefined, ║
locations: undefined, ║
extensions: [Object], ║
code: 'UNKNOWN', ║
statusCode: 500, ║
severity: 'critical', ║
visibility: 'toast' ║
} █
} █
}

𝌚 CopilotKit Version

^1.10.3

📄 Logs (Optional)

[linear]

CPK-4459 🐛 Bug: Unknown GraphQL Error

[copilotkit-support-bot]

The error you're encountering is most commonly caused by authentication issues, empty AIMessage validation errors, network problems, model configuration issues, or message format problems when using the GoogleGenerativeAIAdapter in CopilotKit runtime v1.10.3. Below are the possible causes and recommended solutions based on the codebase analysis.

Details

Possible Causes & Solutions

1. Authentication Issues (Most Common)

• Missing or Invalid API Key:

// Ensure GOOGLE_API_KEY is properly set
process.env.GOOGLE_API_KEY = "your-actual-google-api-key"

// Or pass it directly to the adapter
new GoogleGenerativeAIAdapter({
  apiKey: "your-actual-google-api-key"
})

• API Key Format Issues: Verify your Google API key is correctly formatted and has the necessary permissions for Gemini API access.

2. Empty AIMessage Validation Errors

• Known Gemini Issue: Gemini specifically rejects conversations containing AIMessages with empty content. This was a recently fixed issue in v1.10.3.

• Solution: Ensure you're using the latest version where empty AIMessage filtering is implemented:

npm install @copilotkit/runtime@latest

3. Network Connectivity Issues

• Check for network errors like ECONNREFUSED, ENOTFOUND, or ETIMEDOUT
• Firewall/proxy issues blocking access to Google's APIs
• Solution: Verify network connectivity to generativelanguage.googleapis.com

4. Model Configuration Problems

• Invalid model name: The adapter uses "gemini-1.5-pro" by default
• Model availability issues in your region
• Solution: Try specifying the model explicitly:

new GoogleGenerativeAIAdapter({
  model: "gemini-1.5-pro", // or "gemini-pro"
  apiKey: process.env.GOOGLE_API_KEY
})

5. Message Format Issues

• Malformed conversation history being passed to the adapter
• Invalid tool calls or function definitions
• Solution: Ensure message objects follow the expected format and tool calls are properly structured

Debugging Steps

1. Enable Detailed Logging

// Add more detailed error logging in your CopilotKit setup
console.log("GOOGLE_API_KEY present:", !!process.env.GOOGLE_API_KEY)

2. Check Browser Network Tab

• Look for failed API calls to Google's services
• Check for 401/403 authentication errors
• Verify request payloads are properly formatted

3. Test API Key Directly

curl -H "Content-Type: application/json" \
     -d '{"contents":[{"parts":[{"text":"Hello"}]}]}' \
     -X POST "https://generativelanguage.googleapis.com/v1beta/models/gemini-pro:generateContent?key=YOUR_API_KEY"

Recent Fix Information

The latest version includes fixes for filtering empty AIMessages that were causing Gemini validation errors. If you're still on an older version, upgrading should resolve many of these issues.

Documentation References:

• Google Generative AI Setup
• Troubleshooting Guide

Confidence: High - Based on comprehensive codebase analysis and recent changelog entries showing specific fixes for GoogleGenerativeAIAdapter issues.

---

Was this helpful?

If this solution worked for you, please click on the appropriate option below to help us improve:

✅ Issue Solved | ❌ Need more help

[sudo-vaibhav]

here's what helped, downgrading to 1.9.1, that gives more helpful error, apparently for the same gemini model that I was using previously, the way I was declaraing function params for actions become illegal, upgrading to gemini 2.5 flash as the conversation model fixed the issue.