---
title: "Handle Sql Transform Preview"
method: POST
path: "/sql-transforms/preview"
tags: ["Transforms (SQL)"]
---

# Handle Sql Transform Preview

`POST /sql-transforms/preview`

## Request

- Base URL: `https://api.akkio.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.akkio.com/sql-transforms/preview`
- Auth: none declared

Preview the result of a transform.

## Request body

- SQLTransformPreviewRequest
  - `flow_id` string, required: The ID of the flow for this transform.
  - `transform_plan_ids` integer[]: A list of prior transform plans to be applied before this one. This is the primary mechanism by which we support "chaining" transforms in a way that does not require you to actually commit in order to do the next one.
  - `description` string, required: The user's plaintext request of what transform they want to see.

## Response `200`

Successful Response

- AsyncJobRecord: Do NOT access this table directly.
  - `id` integer, nullable: ID of this object.
  - `created_at` string, date-time, nullable: datetime object representing when this object was created.
  - `updated_at` string, date-time, nullable: datetime object representing when this object was updated.
  - `deleted_at` string, date-time, nullable: datetime object representing when this object was deleted.
  - `status` 'RUNNING' | 'COMPLETED' | 'FAILED'
  - `endpoint` string: Endpoint spawning async job
  - `request` union: request sent to endpoint
    - object
    - unknown[]
      - unknown
  - `sync_response` union: sync response
    - object
    - unknown[]
      - unknown
  - `error` string, nullable: error message
  - `response` unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/akkio/apis/akkio-api.md) - [All operations](https://skmtc.dev/akkio/apis/akkio-api/llms.txt) - [OpenAPI document](https://skmtc.dev/akkio/apis/akkio-api/revisions/c477deff6271?raw)
