Connecting to Templated
To authenticate to Templated, you will need an API key. You can obtain your API key from the Templated Dashboard under the API Key tab (app.templated.io > Dashboard > API Key).
Using API Key Authentication
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Templated API key.
Example connection string:
Profile=C:\profiles\Templated.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';
Available Tables
The Templated API Profile provides access to the following tables:
- Account: Authenticated account details including plan and API usage information.
- Clones: Cloned templates derived from source templates. Filter by SourceTemplateId or ExternalId.
- ClonesCount: Count of clones for a specific source template. Requires SourceTemplateId.
- Folders: Folders used to organize templates. Filter by Name.
- FolderRenders: Renders produced from templates in a specific folder. Requires FolderId.
- FolderTemplates: Templates within a specific folder. Requires FolderId.
- Fonts: Available fonts including Google Fonts and user-uploaded custom fonts.
- GalleryTemplates: Public gallery templates available to all users. Filter by Name, CategoryId, Height, Width, or Tags.
- Renders: Rendered assets for templates, supporting list and single-record retrieval by Id. Filter by TemplateId or ExternalId.
- TemplateLayers: Editable layers within a specific template. Requires TemplateId.
- TemplatePages: Pages within a specific template, each containing layer definitions. Requires TemplateId.
- TemplateRenders: Renders produced from a specific template. Requires TemplateId. Filter by ExternalId.
- Templates: User-owned templates, supporting list and single-record retrieval by Id. Filter by Name, ExternalId, Height, Width, or Tags.
- Uploads: User-uploaded image assets. Filter by Name or Tags.
Usage Examples
Account:
SELECT * FROM Account
Clones:
SELECT * FROM Clones
ClonesCount:
SELECT * FROM ClonesCount WHERE SourceTemplateId = 'template-uuid'
Folders:
SELECT * FROM Folders
INSERT INTO Folders (Name) VALUES ('Marketing Assets')
UPDATE Folders SET Name = 'Renamed Folder' WHERE Id = 'folder-uuid'
DELETE FROM Folders WHERE Id = 'folder-uuid'
FolderRenders:
SELECT * FROM FolderRenders WHERE FolderId = 'folder-uuid'
FolderTemplates:
SELECT * FROM FolderTemplates WHERE FolderId = 'folder-uuid'
Fonts:
SELECT * FROM Fonts
DELETE FROM Fonts WHERE Name = 'My Custom Font'
GalleryTemplates:
SELECT * FROM GalleryTemplates
Renders:
SELECT * FROM Renders
INSERT INTO Renders (TemplateId, Name, Format, ExternalId, Height, Width) VALUES ('template-uuid', 'My Render', 'png', 'ext-123', 1080, 1920)
DELETE FROM Renders WHERE Id = 'render-uuid'
TemplateLayers:
SELECT * FROM TemplateLayers WHERE TemplateId = 'template-uuid'
TemplatePages:
SELECT * FROM TemplatePages WHERE TemplateId = 'template-uuid'
TemplateRenders:
SELECT * FROM TemplateRenders WHERE TemplateId = 'template-uuid'
Templates:
SELECT * FROM Templates
INSERT INTO Templates (Name, Height, Width, Duration) VALUES ('My Template', 1080, 1920, 5000)
UPDATE Templates SET Name = 'Renamed Template', Description = 'Updated description', Height = 1200, Width = 1600 WHERE Id = 'template-uuid'
DELETE FROM Templates WHERE Id = 'template-uuid'
Uploads:
SELECT * FROM Uploads
Connection Properties
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.
| Property | Description |
| APIKey | Your Templated API Key. |
| AuthScheme | The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT |