Start from a template

A template is a platform-maintained, read-only configuration pre-built for a use case. Starting from one means you adopt a working set of operators and actions and complete the gaps, rather than composing a configuration from scratch. This guide fetches a template, completes it, and saves it as your own configuration.

The examples use the base path https://api.simwood.com/intelligence/v1 and a Bearer API key — see Authentication. You'll need intelligence:read and intelligence:write.

1. Browse the templates

List the available templates to find one tuned for your use case:

curl https://api.simwood.com/intelligence/v1/configuration-templates \
  -H "Authorization: Bearer sk_live_..."

Each entry has a numeric id, a name such as fraud-detection, and a description of what it's tuned for.

2. Fetch the template definition

Retrieve the full template to read its definition — the pre-populated configuration document, with operators, granularities, and actions already in place:

curl https://api.simwood.com/intelligence/v1/configuration-templates/<template_id> \
  -H "Authorization: Bearer sk_live_..."

The definition is complete except for one deliberate gap: actions are defined without their delivery destinations. The granularities reflect a suggested setup for the use case, not a fixed one.

3. Complete the definition

Working from the definition, fill in what the template leaves open and adjust anything you want to change:

• Add each action's webhook_url (and any webhook_headers) — these are always left blank.
• Adjust operator selection, granularity, and context to suit your call patterns.
• Supply any operator parameters the template's operators declare — for example, a kb_document value pointing at your own protocol document.

4. Create your configuration

Post the completed document to create a configuration you own. Pass template_id to record where it came from — this is kept for lineage only and never merges anything from the template back in:

curl -X POST https://api.simwood.com/intelligence/v1/configurations \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "acme-fraud-detection",
    "template_id": 3,
    "operators": [ /* completed from the template definition */ ],
    "actions": [
      {
        "type": "webhook",
        "webhook_url": "https://example.com/hooks/fraud",
        "once_per_session": true,
        "condition": { "operator": "fraud-confidence", "expression": "result.value > 80" }
      }
    ]
  }'

The response returns your configuration's own uuid. Later changes to the template never affect a configuration you've already created.

To check the completed document before saving, post it to POST /configurations/validate for a dry run that returns valid plus any errors without persisting anything.

Next steps