Test a version without changing anything

Runs a version now (the latest unless version says otherwise) against the real records: reads are real; record writes, POSTs and approvals are captured instead of done; waits are skipped.

POST/v1/apps/{appId}/workflows/{workflowId}/test

Request

curl --request POST \
  --url 'https://studio.grid82.app/v1/apps/<appId>/workflows/<workflowId>/test' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "version": 123,
  "stopAfter": "<string>",
  "pins": {},
  "input": {},
  "recordId": "<string>"
}'

import json
import requests

url = "https://studio.grid82.app/v1/apps/<appId>/workflows/<workflowId>/test"
headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"version\":123,\"stopAfter\":\"<string>\",\"pins\":{},\"input\":{},\"recordId\":\"<string>\"}")

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://studio.grid82.app/v1/apps/<appId>/workflows/<workflowId>/test", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "version": 123,
    "stopAfter": "<string>",
    "pins": {},
    "input": {},
    "recordId": "<string>"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.grid82.app/v1/apps/<appId>/workflows/<workflowId>/test");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"version\":123,\"stopAfter\":\"<string>\",\"pins\":{},\"input\":{},\"recordId\":\"<string>\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://studio.grid82.app/v1/apps/<appId>/workflows/<workflowId>/test", bytes.NewBuffer([]byte("{\"version\":123,\"stopAfter\":\"<string>\",\"pins\":{},\"input\":{},\"recordId\":\"<string>\"}")))
  req.Header.Set("Authorization", "Bearer <token>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://studio.grid82.app/v1/apps/<appId>/workflows/<workflowId>/test"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"version\":123,\"stopAfter\":\"<string>\",\"pins\":{},\"input\":{},\"recordId\":\"<string>\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://studio.grid82.app/v1/apps/<appId>/workflows/<workflowId>/test")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\"version\":123,\"stopAfter\":\"<string>\",\"pins\":{},\"input\":{},\"recordId\":\"<string>\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "ok": true,
    "error": null,
    "ms": 123.45,
    "output": null,
    "recordId": "<string>",
    "steps": [
      {
        "name": "<string>",
        "kind": "<string>",
        "status": "<string>",
        "ms": 123.45,
        "output": null,
        "error": "<string>",
        "detail": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}

A workflow that starts from a record is tested on recordId, or on the newest record of its table you can see. The answer is the trace, step by step. AI steps run for real and spend AI credits.

Requires the scopes workflows:read, records:read. Operation workflows.test. MCP tool workflows_test. CLI: grid82 workflows test (npx grid82).

Path parameters

Name	Type	Required	Description
`appId`	string	yes
`workflowId`	string	yes

Headers

Name	Type	Required	Description
`Idempotency-Key`	string	no	Any unique string. Sending the same key with the same request again returns the first response (marked `Idempotency-Replayed: true`) instead of running it twice. Reusing it for a different request is refused with 409. Kept for 24 hours. Up to 255 characters.

Request body

Field	Type	Required	Description
`version`	integer	no	At least 1.
`stopAfter`	string	no	Up to 200 characters.
`pins`	object	no
`input`	object	no
`recordId`	string	no	Up to 64 characters.

Response

application/json

Success

dataobjectrequired

Show child attributes

data.okbooleanrequired

data.errorstringnullrequired

data.msnumberrequired

data.outputobjectrequired

data.recordIdstring

data.stepsobject[]required

Show child attributes

data.steps.namestringrequired

data.steps.kindstringrequired

data.steps.statusstringrequired

data.steps.msnumberrequired

data.steps.outputobject

data.steps.errorstring

data.steps.detailstring

curl --request POST \ --url 'https://studio.grid82.app/v1/apps/<appId>/workflows/<workflowId>/test' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "version": 123, "stopAfter": "<string>", "pins": {}, "input": {}, "recordId": "<string>" }'

{ "data": { "ok": true, "error": null, "ms": 123.45, "output": null, "recordId": "<string>", "steps": [ { "name": "<string>", "kind": "<string>", "status": "<string>", "ms": 123.45, "output": null, "error": "<string>", "detail": "<string>" } ] } }

Test a version without changing anything

Path parameters

Headers

Request body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown