POST
/
v1
/
transforms
/
create
curl --request POST \
  --url https://api.runtrellis.com/v1/transforms/create \
  --header 'Content-Type: application/json' \
  --header 'X-Frontend-Id: <api-key>' \
  --data '{
  "proj_id": "<string>",
  "transform_name": "<string>",
  "transform_params": {
    "table_preferences": {
      "included_table_names": [
        "<string>"
      ],
      "advanced_reasoning": false
    },
    "model": "<string>",
    "mode": "document",
    "operations": [
      {
        "column_name": "<string>",
        "column_type": "<string>",
        "transform_type": "<string>",
        "task_description": "<string>",
        "output_values": {}
      }
    ]
  }
}'
{
  "message": "<string>",
  "data": {
    "transform_id": "<string>"
  }
}

Authorizations

X-Frontend-Id
string
header
required

Frontend Key header

Body

application/json

Represents a transformation request.

Attributes: proj_id (str): The id of the project. transform_name (Optional[str], optional): The name of the transformation. Defaults to None. transform_params (TransformParams): The parameters for the transformation.

proj_id
string
required
transform_params
object
required
transform_name
string

The transform_name parameter is an optional parameter that provides a human-readable name or description for the transformation, which can be useful for identifying and referencing transformations. If provided, the transform_name parameter should be a string. If not provided, the value of transform_name will be None.

Response

200
application/json
Successful Response
message
string
required
data
object
required