🎬 MEDIA PLACEHOLDER · MX-MEDIA-4080 · [SCREENSHOT]
[SCREENSHOT_DESCRIPTION]: The Google Gemini connection card in the ModuleX integrations/credentials UI.
[SCREENSHOT_DETAILS]: Capture the API Key Authentication form for Gemini in the credential-management UI: the
API Key field (masked), the optional Base URL field defaulted to https://generativelanguage.googleapis.com/v1beta, and the “Test connection” / “Save” controls. Light theme, 16:9, crop to the card.What you need
A Google AI API key
Create a key in Google AI Studio: click Create API Key, select (or create) a Google Cloud project, then copy the key. Google AI keys start with
AIza (for example AIzaSy…). ModuleX validates the key against the pattern ^AIza[0-9A-Za-z\-_]{35}$ before saving it.A ModuleX organization and an owner/admin role
Credentials are scoped to an organization. Connecting and managing integrations requires the owner or admin role — the
member role is retired. See roles & permissions.A ModuleX API key (for programmatic setup)
To connect Gemini over the API or an SDK, you need a ModuleX API key (
mx_live_…) and your organization id. See authentication.Connect Gemini
You connect Gemini by storing your Google AI API key as a credential for thegemini integration. You can do this in the app or programmatically.
In the app
- Open the integrations catalog and select Gemini, or open Settings → Credentials.
- Choose API Key Authentication and paste your Google AI key.
- Optionally set a custom Base URL (defaults to
https://generativelanguage.googleapis.com/v1beta) — only needed for Google AI-compatible gateways. - Save. ModuleX validates the key with a minimal request before storing it (see Test a key before saving).
api_key. Its fields are:
Your Google AI API key. Stored encrypted and never returned in plaintext. Marked
sensitive. Pattern ^AIza[0-9A-Za-z\-_]{35}$; sample format AIzaSyXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.Optional custom API base URL, only needed when pointing at a Google AI-compatible API. Not required and not sensitive. Must match
^https?://.*.Over the API or an SDK
Create the credential withPOST /credentials. ModuleX detects the credential type from the body: an auth_data.api_key value is stored as an api_key credential. Set make_default: true to make this the default Gemini credential for the organization.
Every request authenticates with Authorization: Bearer mx_live_… plus the X-Organization-ID header (see authentication).
The new credential’s identifier. A
201 response returns the credential metadata; the secret is never echoed back.Creating, listing, and managing credentials and the integration catalog requires the owner or admin role in the organization. A caller without that role receives a
403. The integration-catalog read routes (for example GET /integrations/llm-providers/gemini) are also owner/admin-gated.Test a key before saving
UsePOST /credentials/test-temporary to validate a Gemini key without storing it. ModuleX runs the provider’s test call — a 10-token POST to https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash-lite:generateContent with the header x-goog-api-key set to your key — and reports success when the response status is 200 and includes a candidates field.
true when the test call succeeds.The HTTP status returned by Google’s test endpoint (
200 on success).How the credential was validated. For Gemini this is
api_call.The cost class of the test call. For Gemini this is
minimal (a 10-token request).Available models
ModuleX serves Gemini models from the catalog atGET /integrations/llm-providers/gemini. The catalog is read-only metadata used by the credential UI and the builder — it is not the execution path. The models below are the ones ModuleX currently advertises for Gemini. Every Gemini model supports vision (image input) and a 1,048,576-token context window.
| Model id | Display name | Max input tokens | Max output tokens | Vision | Input $/1M | Output $/1M |
|---|---|---|---|---|---|---|
gemini-2.5-pro | Gemini 2.5 Pro | 1,048,576 | 65,536 | Yes | $2.50 | $15.00 |
gemini-2.5-flash | Gemini 2.5 Flash | 1,048,576 | 65,536 | Yes | $0.30 | $2.50 |
gemini-2.5-flash-lite | Gemini 2.5 Flash Lite | 1,048,576 | 65,536 | Yes | $0.10 | $0.40 |
Prices in the table are Google’s per-token rates as recorded in the ModuleX catalog, in USD per 1,000,000 tokens. Because Gemini is BYOK, these are the rates Google charges you directly — they are not ModuleX credits. See BYOK billing.
The catalog
max_output_tokens is the model’s hard ceiling. Separately, ModuleX applies a per-scenario output cap that is lower than the model ceiling and is not exposed through any catalog API response — for every Gemini model it is 8000 for simple chat, 10000 for chat with knowledge, 4000 for an LLM node, 12000 for an Agent node, 32000 for the main Composer agent, and 4000 for a Composer subagent. These caps are internal defaults and may change.The model list is served from the ModuleX catalog and may change as Google releases or deprecates models. Always read
GET /integrations/llm-providers/gemini for the current set rather than hard-coding ids. Catalog reads are cached for up to 10 minutes.Read the model catalog
models array contains the entries shown above, plus an auth_schemas array describing the api_key scheme. A truncated example:
Catalog detail (truncated)
Use Gemini in ModuleX
Once Gemini is connected, select a Gemini model id wherever a model can be chosen:LLM node
Call Gemini with prompts, variables, and structured output inside a workflow.
Agent node
Run an autonomous step where Gemini can call tools and loop.
Chat
Pick Gemini as the model for a chat conversation.
Assistant
Configure the Assistant to reason and act with a Gemini model.
gemini integration. Set a different default with POST /credentials/{credential_id}/set-default. See managing credentials.
BYOK billing
Gemini is bring-your-own-key, which changes how usage is billed compared with ModuleX-managed models.BYOK (Gemini)
Token usage is billed by Google against your own API key. ModuleX adds no credit charge and no markup for the model call itself. BYOK usage is recorded for analytics only — it does not consume ModuleX credits.
Managed (modulexai)
ModuleX provisions the model and bills it in credits through the usage gate, applying a system margin. Use this when you do not want to manage a provider account.
- No ModuleX credit cost for tokens. A Gemini call made with your Google AI key is not metered in credits. Google invoices you directly at its own rates (the per-million-token prices in the model table).
- Other ModuleX usage still applies. Running a workflow or a turn through the Assistant can still consume the flat per-run credit and may pass through the billing gate even when the model itself is BYOK. See credits & metering and usage gating & limits.
- Rate limits and quotas are Google’s. Token-rate limits, monthly spend caps, and model availability for a BYOK key are governed by your Google AI account, not by ModuleX.
BYOK is available on all plans — there is no separate ModuleX entitlement that gates connecting your own Gemini key. The pricing matrix on the marketing site lists BYOK for every tier; the only ModuleX-side billing that applies to a BYOK call is the non-model usage described above. TBD: confirm with the billing owner that no per-call ModuleX surcharge applies to BYOK model calls before treating “no markup” as a guarantee.
Errors
Catalog and credential operations return ModuleX’s standard error shapes. See errors & status codes for the full taxonomy.| Status | When it happens | Shape |
|---|---|---|
400 | Invalid auth_data/auth_type on credential create, or asking a typed endpoint for the wrong integration type (for example gemini is not a tool). | {detail: string} |
401 | Missing or invalid Authorization / missing X-Organization-ID. | {detail: string} |
403 | Caller is not an owner/admin in the organization. | {detail: string} |
404 | Unknown provider, for example GET /integrations/llm-providers/<unknown> returns LLM provider not found. | {detail: string} |
422 | Query/parameter validation error. | {detail: [ ... ]} |
500 | Unhandled server error. | {detail: string} |
Related
LLM providers
All providers, and how managed vs BYOK selection works.
ModuleX-managed models
The credit-billed managed alternative to BYOK.
Authentication & credentials
How integrations authenticate and the auth schema variants.
Managing credentials
Create, default, rotate, and scope credentials.