Overview
This node integrates with the Prompt Studio API to run prompt recipes on specified deployments. It allows users to select a recipe, choose a deployment associated with that recipe, and provide input data mapped to the deployment's expected schema. The node then sends this input to the Prompt Studio API to execute the prompt and returns the results.
Common scenarios for this node include automating AI prompt executions, integrating custom AI workflows into n8n automation, or running predefined prompt templates with dynamic inputs. For example, a user might use this node to send customer data to an AI model hosted in Prompt Studio and receive generated responses or insights.
Properties
| Name | Meaning |
|---|---|
| Recipe | Select a prompt recipe from Prompt Studio. Recipes represent predefined prompt templates or workflows. The selection is searchable and fetched dynamically from the API. |
| Deployment Name or ID | Choose a specific deployment of the selected recipe. Deployments are instances where the recipe is deployed and can be executed. Options are loaded based on the selected recipe. You can also specify an ID via expression. |
| Inputs | Define the input fields to send to the deployment. This uses a resource mapper to map input data fields according to the deployment's request schema. All required input fields must be provided as strings. |
Output
The node outputs an array of JSON objects, each representing the response from the Prompt Studio API for each input item processed. Each output object contains the full JSON response returned by the API after running the prompt on the specified deployment.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the Prompt Studio API.
- The node makes HTTP requests to
https://api.prompt.studio/api/v1. - The node depends on dynamic loading of recipes and deployments from the Prompt Studio API.
- Input mapping depends on schemas retrieved from the API for each deployment.
Troubleshooting
- No schema found for the selected deployment: This error occurs if the deployment does not have an associated request schema. Ensure the deployment is valid and has a defined input schema in Prompt Studio.
- Authentication errors: If the API key credential is missing or invalid, requests will fail. Verify the API key configuration.
- Empty or invalid inputs: Since all input fields are required and expected as strings, ensure that the input mapping provides all necessary fields correctly.
- Deployment or recipe not found: If the selected recipe or deployment is deleted or unavailable, the node will fail to load options or execute properly. Refresh the list or verify IDs.
Links and References
- Prompt Studio API Documentation (assumed URL for reference)
- n8n Expressions Documentation
- n8n Resource Locator Documentation