Templates — API Reference

Package: dodil.k3.pipeline.v1 · Service: PipelineService

Templates are catalog entries from Scriptum — the recipes new pipelines spawn from. K3 ships a production catalog of 24 audited templates across four categories. See Core Concepts → Template for the type signature.

gRPC setup — grpcurl, endpoints, reflection, and field-name casing — is covered once in Conventions → Using gRPC.

The catalog

Every template below ships with K3, is production-grade, and is discoverable via ListTemplates. Labels show the template’s intended modalities and (where applicable) warehouse_compatible: true — meaning the template emits structured rows suitable for a warehouse destination.

Core analysis (8)

Domain-agnostic processing — classification, extraction, summarization. All warehouse-compatible: bind these to a Tables destination to land structured rows.

Embedding — index pipelines (5)

Ingestion-side embedding pipelines. Each indexes a modality into a Vector collection. Bind these as vector pipelines.

Embedding — search pipelines (5)

Query-side counterparts to the _index templates. These are usually run ad-hoc (via Vector search) rather than bound as ingest pipelines, but you can wire them as free pipelines when needed.

Vision (4)

Image / video / audio analysis. All warehouse-compatible.

E-commerce (2)

Domain templates for commerce / marketplace use cases. Both warehouse-compatible.

Some additional templates exist in an unaudited category (real-estate, IT-ops, telecom, insurance, engineering, media, …). They’re discoverable via ListTemplates but not part of the production catalog — use at your own risk.

ListTemplates

Request

curl -sS "https://k3.dev.dodil.io/admin/templates" \
  -H "Authorization: Bearer $DODIL_TOKEN"

curl -sS "https://k3.dev.dodil.io/admin/templates?category=embedding" \
  -H "Authorization: Bearer $DODIL_TOKEN"

curl -sS "https://k3.dev.dodil.io/admin/templates?search=ocr" \
  -H "Authorization: Bearer $DODIL_TOKEN"

rpc ListTemplates(ListTemplatesRequest) returns (ListTemplatesResponse);
 
message ListTemplatesRequest {
  map<string, string> labels = 1;             // label-equals filter
  optional string category = 2;
  optional string search = 3;                 // free-text on name/description
}

grpcurl \
  -H "Authorization: Bearer $DODIL_TOKEN" \
  -d '{}' \
  $K3_GRPC \
  dodil.k3.pipeline.v1.PipelineService/ListTemplates

grpcurl \
  -H "Authorization: Bearer $DODIL_TOKEN" \
  -d '{
    "category": "embedding"
  }' \
  $K3_GRPC \
  dodil.k3.pipeline.v1.PipelineService/ListTemplates

grpcurl \
  -H "Authorization: Bearer $DODIL_TOKEN" \
  -d '{
    "search": "ocr"
  }' \
  $K3_GRPC \
  dodil.k3.pipeline.v1.PipelineService/ListTemplates

Response

{
  "templates": [
    {
      "templateId": "text_embedding_index",
      "name": "Text Embedding Index",
      "description": "Resolves a source object → chunks → embeds → indexes.",
      "category": "embedding",
      "labels": { "status": "ready", "modality": "text" }
    }
  ]
}

message ListTemplatesResponse {
  repeated Template templates = 1;
}

GetTemplate

Returns one template with its full typed ScriptContract (input fields, output schema, accepted modalities). K3 reads the contract server-side to validate caller-supplied options when spawning pipelines.

Request

curl -sS "https://k3.dev.dodil.io/admin/templates/text_embedding_index" \
  -H "Authorization: Bearer $DODIL_TOKEN"

rpc GetTemplate(GetTemplateRequest) returns (Template);
 
message GetTemplateRequest {
  string template_id = 1;
}

grpcurl \
  -H "Authorization: Bearer $DODIL_TOKEN" \
  -d '{
    "template_id": "text_embedding_index"
  }' \
  $K3_GRPC \
  dodil.k3.pipeline.v1.PipelineService/GetTemplate

Response

A Template — see Core Concepts → Template.

Using templates in pipeline creation

When you create a pipeline you either reference an existing Scriptum script by name (scriptum_template) or spawn a fresh script from a template ID (spawn_from_template) — see CreatePipeline.

Common pairings:

For the “search” half of an embedding workflow (queries), use the matching _search template — typically run ad-hoc through Vector search, not bound as an ingest pipeline.

See also

• Pipelines — spawn pipelines from templates
• Core Concepts → Template — type signature
• Core Concepts → ScriptContract — the typed I/O contract on GetTemplate
• CLI Guide → template — dodil k3 template list / get
• Vector — destination for embedding pipelines
• Tables — destination for warehouse_compatible templates
• grpcurl reference — full flag set + reflection-disabled fallbacks