Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| SCENARIO_API_KEY | No | Your Scenario.com API key from https://app.scenario.com/ → Settings → API Keys | |
| SCENARIO_API_SECRET | No | Your Scenario.com API secret from https://app.scenario.com/ → Settings → API Keys |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| set-credentials | Configure your Scenario.com API credentials for this session. You MUST call this tool first before using any other Scenario tools. Get your credentials from https://app.scenario.com/ (Settings → API Keys). |
| get-credentials-status | Check if credentials are configured for this session (does not expose actual values). |
| get-assets | List assets of a project team, or list all public assets |
| post-asset | Upload an image or canvas |
| delete-asset | Delete multiple assets |
| post-download-assets | Request a link to batch download assets (batch limited to 1000 assets) |
| get-download-assets | Retrieve the status and the url of a batch download assets request |
| post-asset-get-bulk | Get multiple assets by their IDs |
| get-public-assets | List all public assets |
| get-public-assets-by-asset-id | Get the details of an asset |
| get-assets-by-asset-id | Get the details of an asset |
| put-asset-by-asset-id | Update a canvas asset |
| copy-asset-by-asset-id | Duplicate an asset |
| lock-asset-by-asset-id | Lock a canvas |
| get-canvas-asset-snapshots | List snapshots of a canvas type asset |
| put-assets-tags-by-asset-id | Add/delete tags on a specific asset |
| unlock-asset-by-asset-id | Unlock a canvas |
| get-collections | List collections of a team |
| post-collection | Create a new collection |
| get-collections-by-collection-id | Get the details of a collection |
| put-collections-by-collection-id | Update the name of a Collection |
| delete-collections-by-collection-id | Delete a collection |
| put-assets-by-collection-id | Add assets to a specific collection |
| delete-assets-by-collection-id | Remove assets from a specific collection |
| put-models-by-collection-id | Add models to a specific collection |
| delete-models-by-collection-id | Remove models from a specific collection |
| post-caption-inferences | Caption image(s) |
| post-controlnet-inferences | Trigger a new image generation in ControlNet mode. The control image is used to guide the generation; it can be a pose, canny map, or similar. |
| post-controlnet-img2img-inferences | Trigger a new image generation in ControlNet + Img2Img mode. The control image is used to guide the generation; it can be a pose, canny map, or similar. The reference image is used to initialize the generation process. |
| post-controlnet-inpaint-inferences | Trigger a new image generation in ControlNet + Inpaint mode. The control image is used to guide the generation; it can be a pose, canny map, or similar. The mask indicates the area to inpaint in the reference image. |
| post-controlnet-inpaint-ip-adapter-inferences | Trigger a new image generation in ControlNet + Inpaint + IpAdapter mode. The control image is used to guide the generation; it can be a pose, canny map, or similar. The mask indicates the area to inpaint in the reference image, and the second reference image is used as an IPAdapter to guide the generation process. |
| post-controlnet-ip-adapter-inferences | Trigger a new image generation in ControlNet + IpAdapter mode. The control image is used to guide the generation; it can be a pose, canny map, or similar. The second reference image is used as an IPAdapter to guide the generation process. |
| post-controlnet-texture-inferences | Trigger a new seamless texture image generation in ControlNet mode. The control image is used to guide the generation; it can be a pose, canny map, or similar. |
| post-generate-custom | Generate with any model (Image, Video, Audio, 3d). You can retrieve the model inputs from the Note: This endpoint is not available yet for SD1.5, SDXL, Flux.1 and Flux.1-Kontext based models. For these models, use the |
| post-describe-style-inferences | Describe the style of the given images or models. |
| post-detect-inferences | Advanced precision in image generation by transforming visual data from input images into mode maps. |
| post-embed-inferences | Get embeddings from text |
| post-generative-fill-inferences | Generative fill replace the selected mask area content based on the context. Used to erase objects or characters. |
| post-img2img-inferences | Trigger a new image generation in Img2Img mode with one reference image that initializes the generation process. |
| post-img2img-ip-adapter-inferences | Trigger a new image generation in Img2Img + IpAdapter mode. The first image is used to initialize the generation, and the second reference image is used as an IPAdapter. |
| post-img2img-texture-inferences | Trigger a new seamless texture image generation in Img2Img mode with one reference image that initializes the generation. |
| post-inpaint-inferences | Trigger a new image generation in Inpaint mode. The mask indicates the area to inpaint in the reference image. |
| post-inpaint-ip-adapter-inferences | Trigger a new image generation in Inpaint + IpAdapter mode. The mask indicates the area to inpaint in the reference image, and the second reference image is used as an IPAdapter to guide the inpainting. |
| post-patch-inferences | Patch an asset with an image. |
| post-pixelate-inferences | Advanced pixelization of an image. |
| post-prompt-inferences | Generate, complete or invent new prompts. |
| post-prompt-editing-inferences | Edit an image with a prompt. |
| post-reframe-inferences | Reframe a given image to new sizes. Extra space is filled based on the context. |
| post-remove-background-inferences | Advanced remove-background of an image. |
| post-restyle-inferences | Trigger a restyle process from one sketch image (or other image) and one or more reference style images. |
| post-segment-inferences | Trigger the segmentation of an image. The process will create a new Asset with the segmentation mask as a child. |
| post-skybox-base360-inferences | Trigger the generation of a 360 skybox seamless image. |
| post-skybox-upscale360-inferences | Trigger the upscaling of an image matching the 360 skyboxes specific geometry. |
| post-texture-inferences | Trigger the conversion of an image texture to different texture maps:
The process will create a new Asset with the above texture maps as children + the original image as an Albedo map. |
| post-translate-inferences | Translate text from one language to english. |
| post-txt2img-inferences | Trigger a new image generation in Txt2Img mode. |
| post-txt2img-ip-adapter-inferences | Trigger a new image generation in Txt2Img mode with one IpAdapter reference image that guides the generation process. |
| post-txt2img-texture-inferences | Trigger a new seamless texture image generation in Txt2Img mode. |
| post-upscale-inferences | Trigger the upscaling of an image. You can use styles and presets to quickly get results or craft your very own settings. Note:This endpoint is deprecated and will be removed in the future. Please leverage |
| post-vectorize-inferences | Advanced vectorization of an image. |
| get-jobs | List all jobs matching the given filters. A job is a synchronous operation or an asynchronous task such as a training, a generation, etc. It offers a unified view of all operations running on the platform along with their status and results. |
| get-job-id | Get job data by job ID |
| post-job-action-by-job-id | Trigger an action on a job: cancel |
| get-models | List all models |
| post-models | Create a new model |
| post-models-get-bulk | Get multiple models by their |
| get-public-models | List all public models |
| get-public-models-by-model-id | Get the details of the given |
| get-models-by-model-id | Get the details of the given |
| put-models-by-model-id | Update the given |
| delete-models-by-model-id | Delete a model |
| post-models-copy-by-model-id | Copy the given |
| get-models-description-by-model-id | Get the description of the given |
| put-models-description-by-model-id | Update the markdown description of the given |
| post-download-model | Request a link to download the given |
| get-models-examples-by-model-id | List all examples of the given |
| put-models-examples-by-model-id | Add/delete/sort examples of the given |
| delete-models-images-by-model-id | Delete an image |
| get-model-presets-by-model-id | List all presets for the given |
| post-model-preset-by-model-id | Create a new preset for the given |
| put-model-preset-by-model-id-and-preset-id | Modify the given |
| delete-model-preset-by-model-id-and-preset-id | Delete a preset for the given |
| get-models-scores-prompt-by-model-id | Get the prompt scores for the given |
| get-models-scores-training-dataset-by-model-id | Get the training dataset scores for the given |
| put-models-tags-by-model-id | Add/delete tags for the given |
| put-models-train-by-model-id | Trigger the given |
| post-model-training-action-by-model-id | Trigger an action on a model training: cancel |
| post-models-training-images-by-model-id | Add a new training image to the given |
| put-models-training-images-pairs-by-model-id | Replace all training image pairs for the given |
| put-models-training-images-by-model-id-and-training-image-id | Replace the given |
| delete-models-training-images-by-model-id-and-training-image-id | Delete the given |
| post-models-transfer-by-model-id | Transfer (with a copy or a full ownership change) a model to a new owner, including all of its training images |
| get-public-oscu-prices | Get the public Prepaid Compute Units (or OSCU for One Shot Compute Units) price details |
| get-recommendations-models | List recommended models matching the given filters |
| post-search-assets | Search for assets.
At least one of the following fields must have a value:
|
| post-search-models | Search for models.
At least one of the following fields must have a value:
|
| get-tags | List all tags in use for the given |
| post-uploads | Create a temporary upload URL for a file. Support multipart uploads. Return a list of URLs for each part of the file. |
| get-uploads | Get the details of an existing upload |
| post-uploads-action | Trigger an action on upload |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |