---
title: "Test a version without changing anything"
description: "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."
canonical: "https://grid82.com/docs/app-api/my/workflows-test"
updated: "2026-11-13"
---

# Test a version without changing anything

`POST https://your-suite.grid82.app/your-app/v1/workflows/{workflowId}/test`

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.

> **Note: Generic contract**
>
> Your own version of this operation, with your tables and the fields you can read, is in
> your app's document: `https://{suite}.grid82.app/{app}/v1/openapi.json`, behind your credential.
> [Why each person gets their own](/docs/start/studio-and-runtime#why-an-app-has-an-api-of-its-own).

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 `my.workflows.test`. MCP tool `my_workflows_test`. CLI: `grid82 my workflows test` (`npx grid82`).

## Path parameters

| Name         | Type   | Required | Description |
| ------------ | ------ | -------- | ----------- |
| `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.  |

**Authorizations**

- `Authorization` (bearer, in header, required)

## Response

**200**: Success

- `data` (`object`, required)
- `data.ok` (`boolean`, required)
- `data.error` (`string,null`, required)
- `data.ms` (`number`, required)
- `data.output` (`object`, required)
- `data.recordId` (`string`)
- `data.steps` (`object[]`, required)
- `data.steps.name` (`string`, required)
- `data.steps.kind` (`string`, required)
- `data.steps.status` (`string`, required)
- `data.steps.ms` (`number`, required)
- `data.steps.output` (`object`)
- `data.steps.error` (`string`)
- `data.steps.detail` (`string`)

```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>"
      }
    ]
  }
}
```

**4XX**: Refused

- `error` (`object`, required)
- `error.code` (`enum<string>`, required, one of: `not_found, forbidden, unauthenticated, validation_failed, conflict, rate_limited, payment_required, not_implemented, internal`)
- `error.message` (`string`, required)
- `error.details` (`Record<string, unknown>`)

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

**Example request**

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