Test a Workflow over scripted events

POST /v1/workflows/{workflow_id}/test

Compiles the draft, or a published version, and runs the interpreter over it (1.59.0): the start, then each scripted event (a node's completion with its outlet and output, a node's failure, a closed Turn or the Call's end), with each node a step evaluates evaluated by the engine. It answers each step's evaluations, value, effects, records and state hook dispatches, the nodes entered, the node it waits on and how the Call would end. A draft that does not compile is refused as a publish would be. It writes nothing: no Call, Call event, Audit event or Usage event.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the workflows:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/workflows/wfl_.../test" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "events": []
  }'

const response = await fetch(`${process.env.VOCAL_API}/v1/workflows/wfl_.../test`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "events": []
  }),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/workflows/wfl_.../test",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "events": [],
    },
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: WorkflowTestRequest.

Responses

Fields of the 200 answer

The shape is WorkflowTestResult.