Create a materialization

Creates a materialization and starts building. Behavior depends on the request body (see CreateMaterializationRequest):

• Orchestrated build — supply buildInstructions. The publisher builds directly into the caller-assigned names derived from the package’s already-compiled build plan (read off Package.buildPlan). Returns the materialization already building.
• Auto-run (standalone, default) — omit buildInstructions; the publisher self-assigns names and runs all phases in one pass.

POST /environments/{environmentName}/packages/{packageName}/materializations

Create a materialization

cURL

curl --request POST \
  --url https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/materializations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "buildInstructions": {
    "sources": [
      {
        "sourceEntityId": "<string>",
        "materializedTableId": "<string>",
        "physicalTableName": "<string>",
        "sourceID": "<string>"
      }
    ],
    "referenceManifest": [
      {
        "sourceEntityId": "<string>",
        "physicalTableName": "<string>"
      }
    ],
    "strictUpstreams": false
  },
  "forceRefresh": false,
  "sourceNames": [
    "<string>"
  ]
}
'

201

{
  "id": "<string>",
  "environmentId": "<string>",
  "packageName": "<string>",
  "status": "PENDING",
  "manifest": {
    "builtAt": "2023-11-07T05:31:56Z",
    "entries": {},
    "strict": true
  },
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentName · string · required

Name of the environment

packageName · string · required

Name of the package

Body

application/json

Options for starting a materialization. Two modes — (1) auto-run (default), omit buildInstructions and the publisher self-assigns names and runs all phases in one pass; (2) orchestrated build, supply buildInstructions and the publisher builds directly into the caller-assigned names from the package's already-compiled build plan (read off Package.buildPlan).

buildInstructions · object | null

Orchestrated build. When present, the publisher creates the materialization already building these caller-assigned sources (table id, physical name, realization) into the exact names provided — the caller derived these instructions from Package.buildPlan up front. Omit for auto-run (the publisher self-assigns names and builds all persist sources).

Show child attributes

forceRefresh · boolean · default: false

Build a new table even when a source's sourceEntityId is unchanged.

sourceNames · string[]

Restrict the plan/build to these persist source names. Omit = all persist sources.

Response

201

application/json

Materialization created

A record of one materialization run for a package.

id · string

environmentId · string

packageName · string

status · enum<string>

Phase-aware status of a materialization run.

Available options: PENDING, MANIFEST_ROWS_READY, MANIFEST_FILE_READY, FAILED, CANCELLED

manifest · object | null

Build output. Null until status = MANIFEST_FILE_READY.

Show child attributes

startedAt · string<date-time> | null

completedAt · string<date-time> | null

error · string | null

Error message if the materialization failed

metadata · object | null

Materialization metadata including build options, source counts, and durations

createdAt · string<date-time>

updatedAt · string<date-time>