Build the API workflow

link

Create a new API workflow project​

• Solution name: Monster Query - 5e SRD
• Workflow name: API Query - 5e Monsters

Configure inputs and outputs​

Add the HTTP request​

1. In the workflow canvas, select + between activities to open the activity menu. Select HTTP Request.
2. Open the activity context menu and select Rename. Name it HTTP Request - Open5e Monster Query.
3. In the Properties pane, set Authentication to Manual authentication.
4. Set Method to GET.
5. Set URL to https://api.open5e.com/v1/monsters/.
6. Rename the activity output to searchResults.

• name__icontains: case-insensitive partial match; dragon returns "Adult Red Dragon", "Young Blue Dragon", and others
• document__slug: wotc-srd: filters to the official D&D 5e SRD; without it, results include third-party homebrew content
• limit: 10: caps candidates at 10; enough for the agent to reason over without flooding its context
• fields: limits the response to only the fields the agent needs; the full Open5e monster object is much larger and would waste token budget

HTTP Request property reference​

• Authentication: pre-built options for OAuth 2.0, API key, and Basic auth. Set to "Manual authentication" here because Open5e requires none. For authenticated APIs, choose the appropriate option and supply credentials.
• Headers: key/value pairs sent with every request. Common uses: Authorization: Bearer <token> for token-based APIs, Accept: application/json to control response format, and API versioning headers.
• Body: used with POST, PUT, and PATCH requests to send JSON, form data, or raw content. Not applicable for GET requests, which carry parameters in the URL via query parameters.
• Query Parameters: key/value pairs appended to the URL. The @variableName syntax references workflow arguments by name; @searchName pulls in the searchName input argument defined in the Data Manager. See configuring activities for more on variables and expressions in Studio Web.
• Output (renamed to searchResults): receives the full HTTP response including status code, headers, and body. Renaming from the default keeps the Set Response expression readable.

Add the response​

1. In the workflow canvas, select + after the HTTP Request and select Set Response.

   Set Response defines what the API Workflow returns to its caller (in this case, what the agent's tool receives when it invokes the workflow). Whatever you put in the response body here becomes the tool output the agent reasons over.

2. Set the response body to:

   assignment

   {
     "monsterResults": $context.outputs.searchResults.content.results
   }
   {
     "monsterResults": $context.outputs.searchResults.content.results
   }
   

Test the workflow​

1. Select Debug from the toolbar.
2. In the input panel, set searchName to dragon or goblin and run the workflow.
3. Verify the response includes a monsterResults array with monster entries before continuing.

Publish to your feed​

1. Select Publish from the toolbar.
2. In the publish dialog, select For me to publish to your personal workspace feed. A personal workspace feed is a private package repository tied to your Orchestrator workspace; publishing "For me" makes this workflow visible only to you, which is the right scope for development and testing. See Personal Workspaces in the UiPath docs for details.
3. Select Publish to confirm.

---