Erstellen Sie den API-Workflow

Build a Monster Query API Workflow that calls the 5e SRD and returns structured monster data.

Schritt 1 – Erstellen des API-Workflows für die Explorer-Abfrage

An API Workflow is a lightweight workflow published as an API endpoint. You build one that wraps the Open5e 5e SRD monster search: one input, one HTTP request, one output. Once published, it appears in the agent builder as a tool your agent can call.

Dieser Schritt hat sechs Unterschritte. Budgeten Sie 10–15 Minuten für den Abschluss.

Erstellen Sie ein neues API-Workflow-Projekt

Select Create New from your Cloud Workspace. In the Start building dialog, choose API Workflow under Task automation.

Selecting the type creates the project immediately, with no name prompt, so you rename it in the next step.

Die Lösung und den Standardworkflow umbenennen. Öffnen Sie das Kontextmenü für jeden Namen im Projekt-Explorer und wählen Sie Umbenennen aus:

• Lösungsname: Monster Query - 5e SRD
• Workflow-Name: API Query - 5e Monsters

Konfigurieren Sie Eingaben und Ausgaben

Wählen Sie den Data Manager (Zwischenablagesymbol neben der linken Leiste), um auf die Datenvariablen für den Workflow zuzugreifen.

Fügen Sie dem Workflow ein Eingabeargument hinzu:

Name	Typ	Erforderlich	Beschreibung
searchName	String	Ja	Der Maximalname oder ein Teilname, nach dem gesucht werden soll

Fügen Sie ein Ausgabeargument hinzu:

Name	Typ	Erforderlich	Beschreibung
monsterResults	Array	Ja	Server-Ergebnisliste

Fügen Sie die HTTP-Anforderung hinzu

1. In the workflow canvas, select + between activities to open the activity menu. Select HTTP. The activity appears on the canvas as HTTP Request.
2. Öffnen Sie das Kontextmenü der Aktivität und wählen Sie Umbenennen aus. Nennen Sie sie HTTP Request - Open5e Monster Query.
3. In the Properties pane, confirm Authentication is Manual authentication and Method is GET. Both are the defaults on a new activity, so there is normally nothing to change.
4. URL auf https://api.open5e.com/v2/creatures/ festlegen.
5. Benennen Sie die Aktivitätsausgabe in searchResults.

Set the Query parameters property:

Open the Query parameters property, which opens a Dictionary editor with Key and Value columns, and add the following fields:

Schlüssel	Wert
name__icontains	the searchName input argument - see the warning below
document__key	srd-2014
limit	10
fields	key,name,type,size,challenge_rating,alignment

Warnung:

name__icontains takes the searchName variable, and you must pick it from the variable picker rather than typing it. In the value field, start by typing @ to open the picker and select searchName - not using the picker will send the input as a literal string, and the API will return HTTP 200 with no results. The field then renders the value as a chip, and the stored value is $input.searchName.

Was die einzelnen Parameter bewirken:

• name__icontains: Teilweise Übereinstimmung ohne Groß-/Kleinschreibung; dragon gibt „Adult Red Dummy“, „Young Blue Dragon“ und andere zurück
• document__key: srd-2014: filters to the official 5e SRD; without it, results include every publisher in the database, third-party content included
• limit: 10: Begrenzt Kandidaten auf 10; genug für den Agent, ohne seinen Kontext zu überfluten
• fields: limits the response to only the fields the agent needs; the full v2 creature object is much larger and would waste token budget

Warnung:

Open5e ignores query parameters it does not recognize, and returns HTTP 200 anyway. Misspell document__key, or use the v1 spelling document__slug, and the filter is silently dropped: the call succeeds, the run is green, and the agent receives creatures from every publisher instead of the SRD. A goblin search returns 2 results with the filter applied and 29 without it, so check that the result count looks like a handful rather than a catalogue.

HTTP-Anforderungseigenschaftsreferenz

Die Aktivität macht die standardmäßigen HTTP-Strukturblöcke verfügbar. Die meisten konfigurieren Sie für jede API, die Sie aufrufen; einige werden Sie bei öffentlichen APIs wie dieser überspringen:

• Authentifizierung: Vorgefertigte Optionen für OAuth 2.0, API-Schlüssel und Standardauthentifizierung. Legen Sie hier „Manuelle Authentifizierung“ fest, da Open5e keine erfordert. Wählen Sie für authentifizierte APIs die entsprechende Option aus und geben Sie Anmeldeinformationen an.
• Header: Schlüssel/Wert-Paare, die mit jeder Anforderung gesendet werden. Wird häufig verwendet: Authorization: Bearer <token> für tokenbasierte APIs, Accept: application/json zum Steuern des Antwortformats und Header für die API-Versionierung.
• Textkörper: Wird mit POST-, PUT- und PATCH-Anforderungen verwendet, um JSON, Formulardaten oder Rohinhalte zu senden. Gilt nicht für GET-Anforderungen, die über Abfrageparameter Parameter in der URL übertragen.
• Query parameters: key/value pairs appended to the URL. To reference a workflow argument, enter @ to open the variable picker and select the argument - the field stores $input.<name> and displays it as a chip. @ is the picker's trigger character, not a reference syntax you can type out. 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 Response expression readable.

Fügen Sie die Antwort hinzu

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

   The Response activity 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. Legen Sie den Antworttext fest auf:

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

$context.outputs enthält jede benannte Ausgabe der Aktivitäten in diesem Workflow. searchResults ist die Ausgabevariable, die Sie für die Aktivität „HTTP Request“ umbenannt haben; .content.results navigiert in den Antwortumschlag, in den Open5e seine Daten umschließt, bis zum eigentlichen Array von Megainträgen. Weitere Informationen finden Sie in der UiPath-Dokumentation unter Verwenden von Javaskript für den Zugriff auf Workflowdaten.

Testen Sie den Workflow

1. Wählen Sie in der Symbolleiste die Option Debuggen .
2. Legen Sie im Eingabebereich searchName auf dragon oder goblin fest und führen Sie den Workflow aus.
3. Überprüfen Sie, ob die Antwort ein monsterResults -Array mit Array-Einträgen enthält, bevor Sie fortfahren.

A successful response contains up to 10 entries, each with key, name, alignment, and challenge_rating, plus nested type and size objects. Searching goblin returns Goblin and Hobgoblin. If you see an empty array, try a different search term; not every creature name has an exact match in the SRD.

In Ihrem Feed veröffentlichen

Beim Veröffentlichen wird der Workflow als bereitgestellter Prozess in Orchestrator registriert. Dadurch ist er in der Liste Verfügbare Ressourcen des Agent Builder auffindbar: Der Builder zeigt veröffentlichte Workflows aus Ihrem Arbeitsbereich an, keine Entwürfe, die lokal in Studio Web gespeichert sind.

1. Wählen Sie in der Symbolleiste die Option veröffentlichen aus.
2. Wählen Sie im Veröffentlichungsdialogfeld die Option Für mich aus, um in Ihrem persönlichen Arbeitsbereichsfeed zu veröffentlichen. Ein Feed für einen persönlichen Arbeitsbereich ist ein privates Paket-Repository, das an Ihren Orchestrator-Arbeitsbereich gebunden ist; Durch das Veröffentlichen von „Für mich“ ist dieser Workflow nur für Sie sichtbar, was der richtige Scope für die Entwicklung und das Testen ist. Weitere Informationen finden Sie unter Persönliche Arbeitsbereiche in der UiPath-Dokumentation.
3. Wählen Sie zum Bestätigen die Option Veröffentlichen .

Hinweis:

Workflow, der nicht in verfügbaren Ressourcen in Schritt 3 angezeigt wird? Der Workflow muss veröffentlicht (nicht nur gespeichert) werden, bevor er als Tool sichtbar ist. Wenn sie nicht angezeigt wird, kehren Sie hierher zurück, bestätigen Sie, dass die Veröffentlichung erfolgreich abgeschlossen wurde, und aktualisieren Sie dann den Agent Builder.

---

Sobald der Workflow veröffentlicht wurde, ist er im Agent Builder als verbundenes Tool im nächsten Abschnitt verfügbar.