Scaffold Templates

Get Scaffold Template Manifest

Changed on

Render a scaffold template as a Mixpeek manifest.

Converts the scaffold's configuration (namespace, bucket, collections, retriever, taxonomies, clusters) into declarative Infrastructure-as-Code YAML — the same format used by POST /v1/manifest/apply and GET /v1/manifest/export.

Returns both the YAML string (manifest_yaml) and the parsed manifest dict (manifest).

get/v1/templates/scaffolds/{template_id}/manifest

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/templates/scaffolds/{template_id}/manifest
  • Auth: HTTP bearer

Path parameters

template_idstring required

Scaffold template ID

Response

Successful Response

template_idstring required

Scaffold template ID

namestring required

Scaffold template display name

manifest_yamlstring required

Manifest rendered as YAML (same style as manifest export)

manifestobject required

Manifest as a JSON-safe dict (parseable by the manifest parser)

Example response

{
  "manifest": {
    "metadata": {
      "name": "Video Understanding"
    },
    "namespaces": [],
    "version": "1.0"
  },
  "manifest_yaml": "version: '1.0'\nmetadata:\n  name: Video Understanding\n...",
  "name": "Video Understanding",
  "template_id": "tmpl_scaffold_video_understanding"
}

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API