API setup · Check client requirements
Dify + Luma Cloud
Configure a Luma Cloud chat model for a Dify app or workflow.
Use your Luma Cloud API key, Base URL and an available model ID with the client-specific settings below. SuperGPT desktop installation and sign-in are separate.
Before you start
- Create a named key in Dashboard → API. Use API Wallet credit, or an eligible Builder subscription key.
- Copy an exact model ID from the catalog returned for this key. Replace MODEL_ID_FROM_CATALOG wherever it appears below.
- Use a separate named key for this app. Paste it only into the app's credential field; keep it out of chat prompts, screenshots, shared configuration and workflow exports.
- Workspace owner or administrator access in Dify. Have the selected model's context and output limits available.
Set up Dify
- Install the model provider
Open Integrations → Model Provider and install the official OpenAI-API-compatible provider. In older layouts, Model Provider is under workspace Settings. Choose the model provider, not the similarly named extension that publishes Dify apps as an API.
- Add the model
Open the provider card and use Setup or Add Model. Choose model type LLM. Enter the exact catalog ID as Model Name; use a friendly Model display name such as Luma Cloud if desired. The display name does not change the ID sent to the API.
- Set the connection and protocol
Enter https://api.lumaos.cloud/v1 as API Base URL and your Luma key as API Key. Keep Completion mode at Chat. If the plugin exposes API Type, select Chat Completions API. If it exposes model name for API endpoint, leave it empty to use Model Name, or enter the same exact catalog ID.
- Set only the capabilities you need
Enter the selected model's published context size and an output limit within its allowance. Begin with text, without vision, tools, structured output or provider-specific extra settings. Leave optional sampling overrides unset where possible. Save the model; plugin validation can make a model request.
- Create a small app test
In your app, select this model in the LLM node. Set a fixed User message: Reply with hello. Run the node's preview first; if using a Chatflow, connect its text output to an Answer node so the reply reaches chat. Keep the test unpublished until it works.
- Add the rest of the workflow
After text succeeds, add one tool or retrieval step at a time. Use a separate embedding provider for knowledge indexing. Review retry and loop limits before sharing or scheduling an app.
- Provider plugin
OpenAI-API-compatible- Model type
LLM- Model Name
MODEL_ID_FROM_CATALOG- API Base URL
https://api.lumaos.cloud/v1- API Key
Your Luma Cloud API key- Completion mode
Chat- API Type, when present
Chat Completions API- Model context size
The selected model's published context limit
Reply with hello.A fixed prompt makes the first run independent of workflow variables, knowledge retrieval or tool configuration. Add dynamic inputs after this succeeds.
Check the connection
- Preview the LLM node and check for completed text output, not only a saved provider card.
- In a Chatflow, confirm that the Answer node displays the LLM output to the user.
- After the reply, open Dashboard → Usage. Check API Wallet for a wallet key, or subscription usage for a Builder subscription key.
For errors or a request that stops, see troubleshooting. A visible model list alone does not confirm that a chat or editing task can complete.
What to expect
- Providers and their credentials are shared across a Dify workspace. Requests made with this key use its Luma Cloud balance or quota, including other workspace members' app runs.
- The provider plugin supports several model types, but selecting it does not mean Luma Cloud supplies embeddings, reranking, speech or every optional API operation. This guide configures text generation only.
- Agent tools require a model that supports the required tool-call format. A feature toggle cannot add a missing model capability. Test tools separately from chat before publishing an agent.
- Field names and available protocol controls depend on the installed provider plugin version. If the plugin sends an unsupported parameter that it cannot disable, use the API quickstart or another compatible client.
Troubleshooting Dify
401 or an invalid-key message
Confirm that the saved credential contains a Luma Cloud API key, without surrounding quotes, spaces or a Bearer prefix. Check that this key is still active in Dashboard → API. A dashboard password or another provider's key will not work.
The model is absent from the app picker
Confirm that the model was saved as type LLM in the correct workspace and passed the provider's setup check. Select that provider/model explicitly in each LLM node; existing nodes do not automatically switch.
Model not found, 404 or validation fails
Use https://api.lumaos.cloud/v1 as API Base URL and the exact catalog ID as Model Name. If an endpoint model-name override is set, check it too. Use Chat Completions and Chat mode for this guide; do not append /chat/completions to the base URL.
Unsupported parameter or token-limit error
Remove optional extra settings and sampling overrides. Check context size and output budget against the chosen model. If the error names the output-token field and your plugin exposes Token parameter name, select the field required by the model's API contract; do not increase limits at random.
The node succeeds, but chat is blank or knowledge fails
Connect the LLM text output to the Chatflow Answer node. For knowledge errors, check the separate embedding/retrieval configuration. Neither issue is fixed by replacing a working chat API key.
429, a balance warning or an interrupted run
Read the error and check the usage associated with this key. A wallet key uses API Wallet funds; a Builder subscription key uses its eligible subscription quota. Pause retries, wait for the indicated reset or retry time, and reduce parallel requests. After a timeout, check the existing result before running a costly job again.
Client documentation
Settings checked on 2026-09-28. These instructions are based on the client’s documentation; installed versions may differ.
