Materialize a data binding (bindings-as-files) to parquet

POST

/api/workspaces/{workspaceId}/apps/{id}/bindings/{name}/materialize

const url = 'http://localhost:8080/api/workspaces/example/apps/example/bindings/example/materialize?async=0';
const options = {method: 'POST', headers: {cookie: 'auth_session=<auth_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url 'http://localhost:8080/api/workspaces/example/apps/example/bindings/example/materialize?async=0' \
  --cookie auth_session=<auth_session>

Synchronous by default. With ?async=1 it answers 202 with a jobId at once and builds in the background — for builds longer than the edge’s 100 s request limit; poll GET …/binding-jobs/{jobId}.

Authorizations

cookieAuth
bearerAuth

Parameters

Path Parameters

workspaceId

required

string

required

string

name

required

string

Query Parameters

async

string

Allowed values: 0 1 true false

Responses

2XX

Successful response

application/json

object

success

Whether the request succeeded.

boolean

data

Endpoint-specific response payload.

message

string

error

string

Example

{
  "message": "Operation completed",
  "error": "Error message"
}

4XX

Invalid request

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}

5XX

Internal server error

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}