> ## Documentation Index > Fetch the complete documentation index at: https://docs.revoengine.com/llms.txt > Use this file to discover all available pages before exploring further. # Run template by exact ID or unique name. > ROLES: AUTOMATION_RUNNER,AUTOMATION_ADMIN USER: true SERVICE ACCOUNT: true PARAMETER: jobTemplateId accepts an exact active template UUID or unique name. ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/automation/template/{jobTemplateId}/run openapi: 3.0.0 info: title: RevoEngine Platform API description: Official RevoEngine Platform API documentation. version: 1.5.1 contact: name: Support email: support@revoengine.com termsOfService: https://docs.revoengine.com/tos servers: - url: https://api.revoengine.com description: Production security: [] tags: - name: Accounts description: Users, service accounts, API keys, status, and platform access. externalDocs: description: Identity and access guide url: https://docs.revoengine.com/operate/identity-and-access - name: Activity description: Snapshot-backed activity and version history. externalDocs: description: Observability guide url: https://docs.revoengine.com/operate/observability - name: Agent Memory description: Administrative access to durable Agent memory. externalDocs: description: Agent memory and workspaces guide url: https://docs.revoengine.com/ai/memory-and-workspaces - name: Agent Plugins description: Agent plugin definitions, synchronization, testing, and lifecycle. externalDocs: description: Agent plugins guide url: https://docs.revoengine.com/ai/plugins - name: Agents description: >- Agent definitions, runs, sessions, inboxes, memory, tools, workspaces, and lifecycle. externalDocs: description: Autonomous Agents guide url: https://docs.revoengine.com/ai/agents - name: Assistant description: >- Assistant threads, messages, responses, goals, reports, sharing, attachments, and control. externalDocs: description: Assistant guide url: https://docs.revoengine.com/ai/assistant - name: Automation description: >- Jobs, templates, schedules, events, webhooks, execution history, and lifecycle. externalDocs: description: Automation guide url: https://docs.revoengine.com/operate/automation - name: Chat description: Collaborative chat threads, messages, reactions, uploads, and attachments. externalDocs: description: Team Chat guide url: https://docs.revoengine.com/operate/chat - name: Component deployments description: >- Custom Node.js runtime deployment attempts, readiness, activation, and rollback. externalDocs: description: Custom Node.js guide url: https://docs.revoengine.com/build/custom-nodejs - name: Components description: Components, elements, versions, validation, activation, and lifecycle. externalDocs: description: Components guide url: https://docs.revoengine.com/build/components - name: Config description: Instance configuration, usage, logs, and cache administration. externalDocs: description: Instance settings guide url: https://docs.revoengine.com/platform/instance-settings - name: Database Cache description: Instance Database cache values and statistics. externalDocs: description: Database Cache guide url: https://docs.revoengine.com/operate/database-cache - name: Database Views description: Database Views, previews, refreshes, exports, and controlled data actions. externalDocs: description: Database Views guide url: https://docs.revoengine.com/operate/database-views - name: Databases description: Database definitions, data, audits, exports, cloning, and lifecycle. externalDocs: description: Databases guide url: https://docs.revoengine.com/operate/databases - name: Endpoints description: >- Endpoint definitions, activation, validation, generated OpenAPI, and statistics. externalDocs: description: Endpoints guide url: https://docs.revoengine.com/operate/endpoints - name: Files description: Compatibility file listing, preview, download, and deletion operations. externalDocs: description: Files compatibility guide url: https://docs.revoengine.com/operate/files - name: Groups description: Groups, membership, avatars, and lifecycle. externalDocs: description: Groups guide url: https://docs.revoengine.com/operate/groups - name: Me description: Current user profile, keys, avatar, and session information. externalDocs: description: Authentication guide url: https://docs.revoengine.com/developers/authentication - name: Preferences description: User and instance preference values. externalDocs: description: Platform UI guide url: https://docs.revoengine.com/platform/ui-tour - name: Role Groups description: Role groups, members, assigned roles, and lifecycle. externalDocs: description: Permissions guide url: https://docs.revoengine.com/operate/permissions - name: Roles description: Available platform roles and role details. externalDocs: description: Permissions guide url: https://docs.revoengine.com/operate/permissions - name: Search description: Cross-domain search over objects visible to the caller. externalDocs: description: Search and discovery guide url: https://docs.revoengine.com/platform/search - name: Secrets description: >- Secret definitions, revisions, activation, reveal, disable, and destruction. externalDocs: description: Secrets guide url: https://docs.revoengine.com/operate/secrets - name: Storage description: >- Storage workspaces, folders, objects, upload sessions, signed access, and lifecycle. externalDocs: description: Storage guide url: https://docs.revoengine.com/operate/storage externalDocs: description: Documentation url: https://docs.revoengine.com paths: /api/v1/automation/template/{jobTemplateId}/run: post: tags: - Automation summary: Run template by exact ID or unique name. description: |2- ROLES: AUTOMATION_RUNNER,AUTOMATION_ADMIN USER: true SERVICE ACCOUNT: true PARAMETER: jobTemplateId accepts an exact active template UUID or unique name. operationId: AutomationController_runFromTemplate parameters: - name: jobTemplateId required: true in: path schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/RunJobDto' responses: '201': description: Job scheduled. '403': description: Forbidden. '404': description: Not found. security: - bearer: [] components: schemas: RunJobDto: type: object properties: scheduleFor: description: >- Absolute execution time as an ISO 8601 date-time string or Unix timestamp in milliseconds. Must not be in the past or more than 30 days in the future. oneOf: - format: date-time type: string - type: integer format: int64 inputs: type: object description: >- Template input values for this run. Must be a JSON object; null is normalized to an empty object. Values are materialized only under api.input().templateInputs and cannot modify the top-level execution envelope. nullable: true options: description: Options. allOf: - $ref: '#/components/schemas/JobOptionsDto' JobOptionsDto: type: object properties: input: type: object description: >- Custom low-code template input values exposed through api.input().templateInputs. Must be a JSON object; null is stored as an empty object. example: region: eu mode: incremental nullable: true skipLibs: type: boolean description: >- Skip loading shared execution libraries when the component does not need them. example: false legacyResults: type: boolean description: >- Return legacy-shaped results for backward-compatible execution consumers. example: false hideRequest: type: boolean description: Hide the request payload from persisted execution history. example: true hideResponse: type: boolean description: Hide the response payload from persisted execution history. example: false memory: type: number description: >- Job execution memory budget in MiB. The effective limit comes from the instance jobMemory quota, up to 4096 MiB (4 GiB). example: 512 maximum: 4096 concurrency: description: Optional execution concurrency policy. example: key: nightly_sync limit: 3 ttl: 120 allOf: - $ref: '#/components/schemas/ConcurrencyJobDto' retry: description: Optional automatic retry policy for errored jobs. example: enabled: true maxAttempts: 5 minBackoffSeconds: 30 maxBackoffSeconds: 3600 maxDoublings: 5 bypassConcurrencyOnRetry: false allOf: - $ref: '#/components/schemas/RetryJobDto' ConcurrencyJobDto: type: object properties: key: type: string description: >- Unique concurrency bucket key. When omitted, executions are not serialized. example: nightly_sync limit: type: number description: Maximum concurrent executions allowed for the same concurrency key. example: 3 minimum: 1 maximum: 1000 ttl: type: number description: Seconds after which abandoned concurrency capacity is reclaimed. example: 120 minimum: 1 maximum: 86400 RetryJobDto: type: object properties: enabled: type: boolean description: Enable automatic retry for jobs that finish with ERROR. example: true default: false maxAttempts: type: number description: >- Total execution attempts including the original job. Null means retry indefinitely with bounded backoff. example: 5 nullable: true minBackoffSeconds: type: number description: Initial retry backoff in seconds before jitter is applied. example: 30 minimum: 1 default: 30 maxBackoffSeconds: type: number description: >- Maximum retry backoff in seconds. Values below 60 seconds are rejected to avoid retry storms. example: 3600 minimum: 60 maximum: 2592000 default: 3600 maxDoublings: type: number description: Number of exponential doublings before retry delay grows linearly. example: 5 minimum: 0 maximum: 16 default: 5 bypassConcurrencyOnRetry: type: boolean description: Bypass job-template concurrency for automatic retry executions only. example: false default: false securitySchemes: bearer: scheme: bearer bearerFormat: JWT description: Bearer JWT token or API Key (sk-*). type: http ````