Skip to main content

​
Templates

Templates provide pre-configured workspace starting points. Use built-in templates for common project types or create custom templates for your organization.

​
What Are Templates

Templates are workspace blueprints that include:
  • File structure: Standard project layout
  • Dependencies: Pre-installed packages
  • Configuration: Build tools, linting, testing setup
  • Variables: Customizable placeholders

​
Using Templates

​
In Work Orders

Specify a template as your workspace source: 
{
  "taskPrompt": "Create a REST API with user authentication",
  "workspaceSource": {
    "type": "template",
    "templateId": "node-typescript-api",
    "variables": {
      "projectName": "my-auth-api",
      "author": "Your Name"
    }
  }
}

​
Built-In Templates

Template IDDescription
node-typescript-apiNode.js API with TypeScript, Express
node-typescript-libNode.js library with TypeScript
python-fastapiPython API with FastAPI
python-flaskPython API with Flask
react-typescriptReact app with TypeScript
next-typescriptNext.js app with TypeScript
Use GET /v1/templates to see all available templates and their configurations.

​
Template Variables

Templates can define variables for customization: 
{
  "workspaceSource": {
    "type": "template",
    "templateId": "node-typescript-api",
    "variables": {
      "projectName": "my-api",
      "description": "My awesome API",
      "author": "Jane Developer",
      "license": "MIT"
    }
  }
}
Variables are substituted in template files: 
// template package.json
{
  "name": "{{projectName}}",
  "description": "{{description}}",
  "author": "{{author}}",
  "license": "{{license}}"
}

​
Creating Organization Templates

Create custom templates for your organization’s needs.

​
Create Template

curl -X POST https://agentgate.mynewapi.com/v1/templates \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "our-api-template",
    "name": "Our API Template",
    "description": "Standard API template with our conventions",
    "source": {
      "type": "git",
      "repository": "https://github.com/our-org/api-template",
      "branch": "main"
    },
    "variables": [
      {
        "name": "serviceName",
        "description": "Name of the service",
        "required": true
      },
      {
        "name": "team",
        "description": "Owning team",
        "default": "platform"
      }
    ]
  }'

​
Template Structure

{
  "id": "unique-template-id",
  "name": "Human Readable Name",
  "description": "What this template provides",
  "source": {
    // Where to get template files
  },
  "variables": [
    // Variable definitions
  ],
  "hooks": {
    // Lifecycle hooks
  }
}

​
Template Sources

{
  "source": {
    "type": "git",
    "repository": "https://github.com/org/template-repo",
    "branch": "main",
    "path": "templates/api"  // Optional subdirectory
  }
}

​
Variable Definitions

{
  "variables": [
    {
      "name": "projectName",
      "description": "Name of the project",
      "required": true,
      "pattern": "^[a-z][a-z0-9-]*$"  // Validation regex
    },
    {
      "name": "port",
      "description": "Server port",
      "default": "3000",
      "type": "number"
    },
    {
      "name": "enableAuth",
      "description": "Include authentication",
      "default": "true",
      "type": "boolean"
    }
  ]
}

​
Template Hooks

Run commands during workspace setup: 
{
  "hooks": {
    "postCreate": [
      "npm install",
      "npm run setup"
    ]
  }
}

​
Managing Templates

​
List Templates

curl https://agentgate.mynewapi.com/v1/templates \
  -H "Authorization: Bearer YOUR_API_KEY"
Response includes both built-in and organization templates: 
{
  "templates": [
    {
      "id": "node-typescript-api",
      "name": "Node.js TypeScript API",
      "description": "Express API with TypeScript",
      "builtIn": true
    },
    {
      "id": "our-api-template",
      "name": "Our API Template",
      "description": "Standard API with our conventions",
      "builtIn": false
    }
  ]
}

​
Get Template Details

curl https://agentgate.mynewapi.com/v1/templates/our-api-template \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Update Template

curl -X PUT https://agentgate.mynewapi.com/v1/templates/our-api-template \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Our API Template v2",
    "description": "Updated template with new conventions",
    "source": {
      "type": "git",
      "repository": "https://github.com/our-org/api-template",
      "branch": "v2"
    }
  }'

​
Delete Template

curl -X DELETE https://agentgate.mynewapi.com/v1/templates/our-api-template \
  -H "Authorization: Bearer YOUR_API_KEY"
Built-in templates cannot be deleted.

​
Template Best Practices

Define variables for things that change between uses:
  • Project/service names
  • Team ownership
  • Feature flags
  • Configuration values
Provide defaults where possible to reduce required input:
{
  "name": "logLevel",
  "default": "info"
}
Use patterns to catch errors early:
{
  "name": "projectName",
  "pattern": "^[a-z][a-z0-9-]{2,30}$"
}
Provide clear descriptions for each variable:
{
  "name": "databaseUrl",
  "description": "PostgreSQL connection string (postgres://user:pass@host/db)"
}

Workspaces

Learn about workspace sources

API Reference

Templates API endpoints