Dreamstudio connects to a Nagent workspace with an API key. Once it is connected, agents can call 5 Dreamstudio actions, such as "List Engines", "Generate Image from Image" and "Generate Image from Text". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Dreamstudio, with input parameters and output schema.
DREAMSTUDIO_GENERATE_IMAGE_FROM_IMAGETool to generate a new image from an initial image and text prompts. Use after you have a reference image and want to transform it via text guidance.
Input parameters
Optional random seed for reproducible results
Number of diffusion steps to run
\[DEPRECATED - DO NOT USE\] Output dimensions are determined by init_image size. This parameter is ignored by the API.
\[DEPRECATED - DO NOT USE\] Output dimensions are determined by init_image size. This parameter is ignored by the API.
How many images to generate in one call
Guidance scale (how strongly to follow the prompt, 0-35)
Engine identifier for generation, e.g. 'stable-diffusion-v1-5' Validate via DREAMSTUDIO_LIST_ENGINES before calling; unsupported values cause failures.
Binary content of the input image to guide generation
List of prompt objects each with text and optional weight
Controls how much the original image is preserved (0-1). Required when init_image_mode='IMAGE_STRENGTH'.
Guidance mode for how the init_image influences the result. 'IMAGE_STRENGTH' uses image_strength, 'STEP_SCHEDULE' uses step_schedule_start/end.
Optional end fraction for image influence in the schedule (0-1). Defaults to 1.0 if omitted.
Fraction at which to start image influence in the sampling schedule (0-1). Required when init_image_mode='STEP_SCHEDULE'.
CLIP guidance presets supported by the DreamStudio image-to-image API.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DREAMSTUDIO_GENERATE_IMAGE_FROM_TEXTGenerate images from text prompts using Stability AI's text-to-image models. Use when you need to create images from textual descriptions without a reference image. Supports multiple prompts with weights, configurable dimensions, and various generation parameters.
Input parameters
Random seed for reproducible generation. Use the same seed with same parameters to get identical results. If omitted, a random seed is used.
Number of diffusion steps. More steps generally improve quality but take longer. Typical range: 30-50. If omitted, engine's default is used.
Width of generated image in pixels. Must be a multiple of 64. Constraints: For 768 engines: 589,824 ≤ height*width ≤ 1,048,576. For other engines: 262,144 ≤ height*width ≤ 1,048,576. If omitted, engine's default width is used.
Height of generated image in pixels. Must be a multiple of 64. Constraints: For 768 engines: 589,824 ≤ height*width ≤ 1,048,576. For other engines: 262,144 ≤ height*width ≤ 1,048,576. If omitted, engine's default height is used.
Available sampler algorithms for image generation.
Number of images to generate in a single request. Default is 1. Higher values consume more API credits.
Classifier-Free Guidance scale - how strictly to follow the text prompt. Higher values (7-15) follow prompt more closely, lower values (1-7) allow more creative freedom. If omitted, engine's default is used.
Engine identifier for generation (e.g., 'stable-diffusion-v1-5', 'stable-diffusion-xl-1024-v1-0'). Use DREAMSTUDIO_LIST_ENGINES to get available engines. Using invalid engine_id will cause the request to fail.
Organization ID to scope the request to. If not provided, uses the user's default organization from their account.
List of text prompts with optional weights. At least one prompt is required.
CLIP guidance presets for text-to-image generation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DREAMSTUDIO_LIST_ENGINESList all available DreamStudio/Stability AI engines accessible with your API key. This action retrieves all AI models (engines) you can use for image generation and other tasks. Common engines include Stable Diffusion XL and various Stable Diffusion versions. Use this action to: - Discover which engines are available to your account - Get engine IDs needed for image generation requests - Check engine types and capabilities No parameters required - simply call to get the complete list of accessible engines. Using an unsupported engine_id in generation requests will cause failures; engines also vary in supported image sizes (typically capped near 1024x1024) and quality for specific tasks.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DREAMSTUDIO_USER_ACCOUNTRetrieves authenticated user's account information from Stability AI. Returns user ID, email, organization memberships, and profile picture. No parameters required - uses authenticated session.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DREAMSTUDIO_USER_BALANCERetrieves the user's current credit balance from their DreamStudio account. Use this tool to check how many credits are available before generating images or to monitor remaining credits after API operations. Credits are consumed when generating images through the Stability AI API. For large or high-resolution batch generation, verify sufficient balance first — insufficient credits will cause failures mid-run.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 5 Dreamstudio actions on Nagent, including "List Engines", "Generate Image from Image" and "Generate Image from Text". List Engines: List all available DreamStudio/Stability AI engines accessible with your API key. Each action is listed on this page with its input parameters and its output.
Dreamstudio connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
It returns data, error and successful.