workflows

Run a workflow

Run a saved workflow: an ordered chain of tool calls where each step can read an earlier step's output. The id is the workflow id from /workflows. Every step that runs costs its own tool's credits, charged before it runs, so a chain that stops halfway is billed for the steps that happened and no more. Workflows belong to an account, so the key must be one created while signed in.

post/api/v1/workflows/{id}/run

Request

  • Base URL: https://toolforte.com
  • URL: https://toolforte.com/api/v1/workflows/{id}/run
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The workflow id, from https://toolforte.com/workflows

Request body

inputsobject

Values for the workflow's declared inputs, keyed by input key.

Response

The run finished, successfully or with a failed step. stopReason says which, steps holds every step that ran, and creditsCharged is what it actually cost.

okboolean

Changes

No recorded changes to this operation across all 1 revision of this API.