Workflows · Ephemeral Docs

Speichern Sie Ausführungsdefinitionen unter einem Namen und starten Sie sie mit POST /v1/runs. member- und admin-Schlüssel können jeden Endpunkt auf dieser Seite nutzen. Wie gespeicherte Felder und Überschreibungen zusammenwirken, beschreibt Workflows.

Einen Workflow speichern

PUT/v1/workflows/{name}

Erstellt den Workflow oder ersetzt ihn, falls der Name existiert. Namen beginnen mit einem Buchstaben oder einer Ziffer und enthalten bis zu 128 Buchstaben, Ziffern, _, . oder -.

Body

promptstringerforderlich

Die Aufgabe. Bis zu 128 KiB.

modelstring

Modell-ID. Wenn weggelassen, verwendet jede Ausführung das Standardmodell zum Zeitpunkt ihrer Erstellung.

filesarray

Dateieinträge wie in einer Ausführungsanfrage. Namen werden beim Erstellen jeder Ausführung aufgelöst.

connectionsobject

Verbindungen, nach dem Namen geordnet, den der Agent sieht. Bevorzugen Sie Einträge der Form {"ref": "<saved name>"}.

descriptionstring

Was der Workflow tut und welche Eingabe er erwartet. Bis zu 500 Zeichen.

input_schemaobject

Ein JSON Schema, dem die input jeder Ausführung entsprechen muss; eine Ausführung, die nicht passt, wird mit 400 abgelehnt. Siehe Eingabe und Ausgabe beschreiben.

output_schemaobject

Ein JSON Schema, dem die Ausgabe jeder Ausführung entsprechen muss; die Ausgabe ist dann JSON, und eine Ausführung, deren Ausgabe nicht passt, schlägt fehl. Siehe Eingabe und Ausgabe beschreiben.

timeout_secondsinteger

1 bis 3600. Ausführungen verwenden 300, wenn weggelassen.

shellboolean

Ausführungen verwenden true, wenn weggelassen.

webboolean | object

Webzugriff für die Ausführungen des Workflows: true oder ein Objekt mit allow und search. Aus, wenn weggelassen.

Ein Workflow kann weder input noch max_cost_micros oder callback enthalten; diese gehören zu jeder einzelnen Ausführung. Die Antwort lautet {"name": "investigate-payment"}.

curl -X PUT $EPHEMERAL_URL/v1/workflows/investigate-payment \
  -H "Authorization: Bearer $EPHEMERAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Find out why this payment failed. Follow the playbook.",
    "model": "anthropic/claude-haiku-5.5",
    "files": [{ "file": "playbook.md" }],
    "connections": { "payments": { "ref": "payments-api", "allowed_methods": ["GET"] } },
    "timeout_seconds": 120,
    "shell": false
  }'

Einen Workflow starten

Senden Sie den Workflow-Namen mit der Eingabe und dem Budget für diese Ausführung an POST /v1/runs. Jedes Definitionsfeld, das Sie angeben, ersetzt den gespeicherten Wert für diese Ausführung; files und connections ersetzen die gesamte Sammlung.

Terminal

curl $EPHEMERAL_URL/v1/runs \
  -H "Authorization: Bearer $EPHEMERAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workflow":"investigate-payment","input":{"payment_id":"pay_123"},"max_cost_micros":500000}'

Existiert der Workflow nicht, schlägt die Anfrage mit 400 und der Meldung saved workflow not found fehl.

Workflows auflisten

GET/v1/workflows

Liefert die Workflows der Organisation in alphabetischer Reihenfolge, jeweils als Objekt mit seinem name. Mit ?detail=true kommen description, input_schema und output_schema jedes Workflows hinzu, sofern vorhanden. Rufen Sie einen Workflow über seinen Namen ab, um seine ganze Definition zu sehen.

JSON

[{ "name": "investigate-payment" }, { "name": "weekly-report" }]

Mit ?detail=true sieht ein Agent, was jeder Workflow erwartet und liefert:

JSON

[
  {
    "name": "weather",
    "description": "Current weather for a city. Input is a city name.",
    "input_schema": { "type": "object", "required": ["city"], "properties": { "city": { "type": "string" } } },
    "output_schema": { "type": "object", "required": ["city", "temperature_c", "summary"] }
  },
  { "name": "weekly-report" }
]

Einen Workflow abrufen

GET/v1/workflows/{name}

Liefert die gespeicherte Definition. Zugangsdaten in Inline-Verbindungen werden entfernt, und Query-Werte in ihren URLs werden maskiert.

Um einen Workflow zu bearbeiten, rufen Sie ihn ab, ändern ihn und speichern ihn mit PUT zurück. Zugangsdatenfelder, die Sie leer lassen, behalten ihre gespeicherten Werte, solange sich der Authentifizierungstyp der Verbindung nicht ändert.

Einen Workflow löschen

DELETE/v1/workflows/{name}

Löscht den Workflow und liefert 204 No Content. Ausführungen, die ihn bereits verwendet haben, sind nicht betroffen.

Workflows haben keine Versionen. Speichern oder Löschen wirkt sich auf die nächste Ausführung aus, die ihn nennt.