Script Templates

List, preview, generate, and manage custom script templates. The templates API lets you discover available code generation templates, render them with variables, create user-supplied templates from _hoody/templates/, and update or delete those custom entries.

List Templates

GET /api/v1/exec/templates/list

Returns all available script templates, including built-in and user-supplied entries. Use the category filter to narrow the result set to a single metadata category such as api or utility.

Parameters

Name	In	Type	Required	Description
category	query	string	No	Filter templates to a single metadata category (e.g. api, utility). Omit to list all categories.
includeBuiltin	query	boolean	No	Include built-in templates in the result set. Default true. Accepts true/false/1/0.
includeCustom	query	boolean	No	Include user-supplied templates (from _hoody/templates/) in the result set. Default true.

Responses

200

{
  "count": 2,
  "templates": [
    {
      "name": "api-fetch",
      "metadata": {
        "category": "api",
        "tags": ["http", "fetch"]
      }
    },
    {
      "name": "utility-log",
      "metadata": {
        "category": "utility",
        "tags": ["logging"]
      }
    }
  ]
}

400

{
  "error": "Invalid parameter format",
  "code": "VALIDATION_ERROR",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {
    "field": "category"
  }
}

Error Code	Title	Description	Resolution
VALIDATION_ERROR	Invalid input	Request parameters failed validation	Check parameter format and requirements

500

{
  "error": "Internal server error",
  "code": "ERROR_500",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {}
}

SDK Usage

const { count, templates } = await client.exec.templates.list({
  category: "api",
  includeBuiltin: true,
  includeCustom: true,
});

curl -X GET "https://api.hoody.com/api/v1/exec/templates/list?category=api&includeBuiltin=true&includeCustom=true" \
  -H "Authorization: Bearer <token>"

---

Preview Template

GET /api/v1/exec/templates/preview

Render a template with the supplied variables and return the substituted code alongside the original source. Useful for inspecting what a generation will produce before committing to writing a file.

Parameters

Name	In	Type	Required	Description
name	query	string	Yes	Name query parameter
variables	query	string	No	Variables query parameter

Responses

200

{
  "template": {
    "name": "api-fetch",
    "metadata": {
      "category": "api",
      "tags": ["http", "fetch"]
    },
    "code": "const url = 'https://api.example.com';\nfetch(url).then(r => r.json());",
    "originalCode": "const url = '{{baseUrl}}';\nfetch(url).then(r => r.json());",
    "substituted": true
  }
}

400

{
  "error": "Invalid parameter format",
  "code": "VALIDATION_ERROR",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {
    "field": "name"
  }
}

Error Code	Title	Description	Resolution
VALIDATION_ERROR	Invalid input	Request parameters failed validation	Check parameter format and requirements

404

{
  "error": "Template not found",
  "code": "NOT_FOUND",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {
    "name": "missing-template"
  }
}

Error Code	Title	Description	Resolution
NOT_FOUND	Resource not found	The requested resource does not exist	Verify the resource identifier

500

{
  "error": "Internal server error",
  "code": "ERROR_500",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {}
}

SDK Usage

const { template } = await client.exec.templates.preview({
  name: "api-fetch",
  variables: "baseUrl=https://api.example.com",
});

curl -X GET "https://api.hoody.com/api/v1/exec/templates/preview?name=api-fetch&variables=baseUrl%3Dhttps%3A%2F%2Fapi.example.com" \
  -H "Authorization: Bearer <token>"

---

Create Custom Template

POST /api/v1/exec/templates/create-custom

Persist a new user-supplied template under _hoody/templates/. The endpoint accepts a request payload describing the template code and its metadata.

Request Body

This endpoint accepts a JSON request body. No specific body fields are defined in the schema.

Responses

200

{
  "created": true,
  "name": "my-custom-fetch",
  "path": "_hoody/templates/my-custom-fetch.js",
  "metadata": {
    "name": "my-custom-fetch",
    "category": "api",
    "tags": ["http", "custom"],
    "description": "Fetch helper for internal APIs",
    "params": ["baseUrl", "method"],
    "version": "1.0.0",
    "author": "dev@hoody.com"
  }
}

400

{
  "error": "Invalid parameter format",
  "code": "VALIDATION_ERROR",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {}
}

Error Code	Title	Description	Resolution
VALIDATION_ERROR	Invalid input	Request parameters failed validation	Check parameter format and requirements

403

{
  "error": "Access denied",
  "code": "FORBIDDEN",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {}
}

Error Code	Title	Description	Resolution
FORBIDDEN	Access denied	Insufficient permissions for this operation	Contact administrator for access

409

{
  "error": "Template already exists",
  "code": "CONFLICT",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {
    "name": "my-custom-fetch"
  }
}

Error Code	Title	Description	Resolution
CONFLICT	Resource conflict	Operation conflicts with existing resource state	Check resource state and retry

500

{
  "error": "Internal server error",
  "code": "ERROR_500",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {}
}

SDK Usage

const result = await client.exec.templates.createCustom({
  data: {},
});

curl -X POST "https://api.hoody.com/api/v1/exec/templates/create-custom" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

---

Generate From Template

POST /api/v1/exec/templates/generate

Render a template with variables and optionally write the result to disk. Returns the generated code, the file path if saved, and the variable map that was applied.

Request Body

Field	Type	Required	Description
name	string	Yes	Name of the template to generate.
variables	object	No	Map of template variables used during substitution.
outputPath	string	No	Destination path where generated code is written when saveFile is true.
saveFile	boolean	No	When true, writes the rendered code to outputPath. Default false.

Responses

200

{
  "generated": true,
  "template": "api-fetch",
  "code": "const url = 'https://api.example.com';\nfetch(url).then(r => r.json());",
  "saved": true,
  "path": "_hoody/generated/api-fetch.js",
  "variables": {
    "baseUrl": "https://api.example.com"
  }
}

400

{
  "error": "Missing required field: name",
  "code": "VALIDATION_ERROR",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {
    "field": "name"
  }
}

Error Code	Title	Description	Resolution
VALIDATION_ERROR	Invalid input	Request parameters failed validation	Check parameter format and requirements

403

{
  "error": "Access denied",
  "code": "FORBIDDEN",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {}
}

Error Code	Title	Description	Resolution
FORBIDDEN	Access denied	Insufficient permissions for this operation	Contact administrator for access

404

{
  "error": "Template not found",
  "code": "NOT_FOUND",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {
    "name": "missing-template"
  }
}

Error Code	Title	Description	Resolution
NOT_FOUND	Resource not found	The requested resource does not exist	Verify the resource identifier

500

{
  "error": "Internal server error",
  "code": "ERROR_500",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {}
}

SDK Usage

const result = await client.exec.templates.generate({
  data: {
    name: "api-fetch",
    variables: { baseUrl: "https://api.example.com" },
    outputPath: "_hoody/generated/api-fetch.js",
    saveFile: true,
  },
});

curl -X POST "https://api.hoody.com/api/v1/exec/templates/generate" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "api-fetch",
    "variables": { "baseUrl": "https://api.example.com" },
    "outputPath": "_hoody/generated/api-fetch.js",
    "saveFile": true
  }'

---

Update Custom Template

PUT /api/v1/exec/templates/update-custom/:name

Patch the source code and/or metadata of an existing custom template. The supplied metadata object is merged with existing metadata rather than replacing it.

Parameters

Name	In	Type	Required	Description
name	path	string	Yes	Name of the custom template to update.

Request Body

Field	Type	Required	Description
code	string	No	Replacement source code for the template.
metadata	object	No	Metadata fields to merge into the existing template metadata.

Responses

200

{
  "updated": true,
  "name": "my-custom-fetch",
  "metadata": {
    "name": "my-custom-fetch",
    "category": "api",
    "tags": ["http", "custom", "internal"],
    "description": "Fetch helper for internal APIs (updated)",
    "params": ["baseUrl", "method"],
    "version": "1.1.0",
    "author": "dev@hoody.com"
  }
}

400

{
  "error": "Invalid parameter format",
  "code": "VALIDATION_ERROR",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {
    "field": "metadata"
  }
}

Error Code	Title	Description	Resolution
VALIDATION_ERROR	Invalid input	Request parameters failed validation	Check parameter format and requirements

404

{
  "error": "Template not found",
  "code": "NOT_FOUND",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {
    "name": "missing-template"
  }
}

Error Code	Title	Description	Resolution
NOT_FOUND	Resource not found	The requested resource does not exist	Verify the resource identifier

500

{
  "error": "Internal server error",
  "code": "ERROR_500",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {}
}

SDK Usage

const result = await client.exec.templates.updateCustom({
  name: "my-custom-fetch",
  data: {
    code: "fetch('{{baseUrl}}', { method: '{{method}}' }).then(r => r.json());",
    metadata: {
      tags: ["http", "custom", "internal"],
      version: "1.1.0",
      params: ["baseUrl", "method"],
    },
  },
});

curl -X PUT "https://api.hoody.com/api/v1/exec/templates/update-custom/my-custom-fetch" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "fetch(\"{{baseUrl}}\", { method: \"{{method}}\" }).then(r => r.json());",
    "metadata": {
      "tags": ["http", "custom", "internal"],
      "version": "1.1.0",
      "params": ["baseUrl", "method"]
    }
  }'

---

Delete Custom Template

DELETE /api/v1/exec/templates/delete-custom/:name

Remove a user-supplied template from _hoody/templates/. Built-in templates cannot be deleted.

Parameters

Name	In	Type	Required	Description
name	path	string	Yes	Name of the custom template to delete.

Responses

200

{
  "deleted": true,
  "name": "my-custom-fetch"
}

400

{
  "error": "Invalid parameter format",
  "code": "VALIDATION_ERROR",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {
    "field": "name"
  }
}

Error Code	Title	Description	Resolution
VALIDATION_ERROR	Invalid input	Request parameters failed validation	Check parameter format and requirements

404

{
  "error": "Template not found",
  "code": "NOT_FOUND",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {
    "name": "missing-template"
  }
}

Error Code	Title	Description	Resolution
NOT_FOUND	Resource not found	The requested resource does not exist	Verify the resource identifier

500

{
  "error": "Internal server error",
  "code": "ERROR_500",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "details": {}
}

SDK Usage

const result = await client.exec.templates.deleteCustom({
  name: "my-custom-fetch",
});

curl -X DELETE "https://api.hoody.com/api/v1/exec/templates/delete-custom/my-custom-fetch" \
  -H "Authorization: Bearer <token>"

Note

Built-in templates are immutable. Delete operations only affect user-supplied templates stored under _hoody/templates/. Attempting to delete a built-in template returns NOT_FOUND because the lookup scopes only to custom entries.