Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Weld Transforms API

The Transforms API from Weld — 11 operation(s) for transforms.

Weld Transforms API is one of 13 APIs that Weld publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transforms. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 15 operations across 11 paths, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version 0.1.

Requests are made against a single base URL, https://connect.weld.app.

15 operations 11 paths 20 schemas 2 DELETE7 GET1 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1
Base URL
https://connect.weld.app
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Weld Transforms API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (api_key). By default, every request must be authenticated.

  • api_key — The API key from Settings - API Keys

Paths & Operations 15

Across 11 paths, the API surfaces 15 operations — 2 DELETE, 7 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Transforms 15
GET
/transforms
List transforms
TransformOpenApiController_listTransforms 5 params → 200
POST
/transforms
Create transform
TransformOpenApiController_createTransform body → 201
GET
/transforms/available_references
List available references
TransformOpenApiController_getAvailableReferences → 200
GET
/transforms/{id}
Get transform
TransformOpenApiController_getTransform 1 param → 200404
PATCH
/transforms/{id}
Update transform
TransformOpenApiController_updateTransform 1 param body → 200404
DELETE
/transforms/{id}
Delete transform
TransformOpenApiController_deleteTransform 1 param → 204
GET
/transforms/{id}/schema
Get transform schema
TransformOpenApiController_getTransformSchema 1 param → 200404
POST
/transforms/{id}/orchestration
Attach transform to an orchestration
TransformOpenApiController_attachOrchestration 1 param body → 200400404
DELETE
/transforms/{id}/orchestration
Detach transform from its orchestration
TransformOpenApiController_detachOrchestration 1 param → 200404
POST
/transforms/bulk
Bulk create transforms
TransformOpenApiController_bulkCreateTransforms body → 200
GET
/transforms/{id}/versions
List transform versions
TransformOpenApiController_listVersions 3 params → 200404
POST
/transforms/{id}/publish
Publish transform
TransformOpenApiController_publishTransform 1 param body → 200404
POST
/transforms/query_previews
Create async query preview
TransformOpenApiController_createQueryPreview body → 201
GET
/transforms/query_previews/{queryExecutionId}/status
Get query preview status
TransformOpenApiController_getQueryPreviewStatus 1 param → 200
GET
/transforms/query_previews/{queryExecutionId}/result
Get query preview result
TransformOpenApiController_getQueryPreviewResult 1 param → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are TransformDto (13 properties), TransformCreateRequestDto (7 properties), TransformUpdateRequestDto (7 properties), TransformVersionDto (6 properties). Each schema is shown below with its type and property counts.

TransformPublishRequestDto
object
5 properties
QueryPreviewCreateResponseDto
object
2 properties 2 required
TransformSchemaFieldDto
object
3 properties 3 required
QueryPreviewCreateRequestDto
object
1 property 1 required
TransformBulkCreateResponseDto
object
1 property 1 required
TransformUpdateRequestDto
object
7 properties
TransformSchemaDto
object
1 property 1 required
TransformAttachOrchestrationRequestDto
object
1 property 1 required
PagedTransformDto
object
3 properties 2 required
TransformDto
object
13 properties 9 required
AvailableReferenceDto
object
3 properties 3 required
AvailableReferencesResponseDto
object
1 property 1 required
TransformParameterDto
object
3 properties 3 required
PagedTransformVersionDto
object
3 properties 2 required
TransformBulkCreateRequestDto
object
1 property 1 required
QueryPreviewStatusResponseDto
object
2 properties 1 required
TransformBulkResultItemDto
object
4 properties 2 required
QueryPreviewResultResponseDto
object
2 properties 2 required
TransformCreateRequestDto
object
7 properties 2 required
TransformVersionDto
object
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weld-transforms-api-openapi.yml Raw ↑

Other APIs Weld publishes across the network.

Weld Connection Bridge API
Weld Connections API
Weld Custom Reports API
Weld ELT Stream Runs API
Weld ELT Streams API
Weld ELT Syncs API
Weld Integrations API
Weld Orchestration Runs API
Weld Orchestrations API
Weld Reverse ETL Failed Records API
Weld Reverse ETL Sync Runs API
Weld Reverse ETL Syncs API