Use the template create, list, retrieve, and delete endpoints.
Overview
Use the template create, list, retrieve, and delete endpoints. API clients must be tenant-aware, permission-aware, and capable of handling both JSON and binary responses.
Key points
- POST creates or updates by owner and name.
- GET lists tenant templates.
- GET by UUID or name retrieves matching templates and resources.
- DELETE removes an owned template.
- The global endpoint lists catalog templates.
- Use the versioned path for new integrations.
Endpoints
| Method | Route | Purpose |
|---|---|---|
| POST | /api/v1/templates | Create or update a template by owner and name. |
| GET | /api/v1/templates | List templates for the request instance. |
| GET | /api/v1/templates/i/{uuid} | Retrieve a template by UUID. |
| GET | /api/v1/templates/n/{name} | Retrieve a template by name. |
| GET | /api/v1/templates/g | List globally published templates. |
| DELETE | /api/v1/templates/i/{uuid} | Delete an instance-owned template. |
Recommended procedure
- Send authentication and instance headers.
- Validate the request body before transmission.
- Inspect HTTP status, content type, and structured errors.
- Log non-sensitive identifiers needed to reproduce failures.
Client requirements
- Check the HTTP status before processing the body.
- Check
Content-Typebefore deciding whether the response is JSON, DOCX, or PDF. - Do not log authentication tokens or complete client document data.
- Preserve the instance context through every Feradel service-to-service call.
- Treat validation and compilation errors as input or template defects rather than transient network failures.
Troubleshooting
A client treats an error as a file
Check HTTP status and Content-Type before writing the response body to disk.
The same request works in another tenant
Compare instance, owner, token permissions, and object UUIDs.
A route returns an unexpected envelope
The current controllers are not fully standardized; handle HTTP status and documented fields defensively.
Related documentation
- Template Resource and Global Import API
- Template Assignment, Validation, and Compilation API
- Component API Reference
Documentation source: feradelinc/feradel.render.api, reviewed against repository revision b2c3a710. Verify behavior against the deployed release before publishing exact routes, limits, or version requirements.