API reference · 3 endpoints

Namespace templates

Export a namespace's configuration as a template and import it elsewhere.

GET/v1/default/namespaces/{namespace_id}/export

Export namespace template

Export a namespace's current configuration, automations, and directives as a template manifest. The exported manifest can be imported into another namespace to replicate the setup.

Parameters

namespace_idstringpathrequired
curl -X GET "https://api.illumina.sh/v1/default/namespaces/demo/export" \
  -H "Authorization: Bearer $ILLUMINA_API_KEY"
Response · 200
{
  "namespace": {
    "disposition_empathy": 5,
    "enable_observations": true,
    "reflect_mission": "You are helping a support agent remember customer interactions.",
    "retain_mission": "Extract customer issues, resolutions, and sentiment."
  },
  "directives": [
    {
      "content": "Always respond with empathy and understanding.",
      "name": "Always be empathetic",
      "priority": 10
    }
  ],
  "automations": [
    {
      "id": "sentiment-overview",
      "name": "Customer Sentiment Overview",
      "source_query": "What is the overall sentiment trend?",
      "trigger": {
        "refresh_after_consolidation": true
      }
    }
  ],
  "version": "1"
}

400 · 401 · 402 · 403 · 404 · 405 · 409 · 410 · 422see error reference

POST/v1/default/namespaces/{namespace_id}/import

Import namespace template

Import a namespace template manifest to create or update a namespace's configuration, automations, and directives. If the namespace does not exist it is created. Config fields are applied as per-namespace overrides. Automations are matched by id, directives by name — existing ones are updated, new ones are created. Use dry_run=true to validate the manifest without applying changes.

Parameters

namespace_idstringpathrequired
dry_runbooleanquery

Validate only, do not apply changes

curl -X POST "https://api.illumina.sh/v1/default/namespaces/demo/import" \
  -H "Authorization: Bearer $ILLUMINA_API_KEY"
Response · 200
{
  "namespace_id": "demo",
  "config_applied": false
}

400 · 401 · 402 · 403 · 404 · 405 · 409 · 410 · 422see error reference

GET/v1/namespace-template-schema

Get namespace template JSON Schema

Returns the JSON Schema for the namespace template manifest format. Use this to validate template manifests before importing.

curl -X GET "https://api.illumina.sh/v1/namespace-template-schema" \
  -H "Authorization: Bearer $ILLUMINA_API_KEY"
Response · 200
null

400 · 401 · 402 · 403 · 404 · 405 · 409 · 410see error reference

Search docs

Search the documentation