{"id":17967231,"url":"https://github.com/petesteege/imageapi","last_synced_at":"2026-04-13T03:44:19.599Z","repository":{"id":259238157,"uuid":"877384338","full_name":"petesteege/imageapi","owner":"petesteege","description":"An API / web gui for docker that uses html as a template to render down to an image.","archived":false,"fork":false,"pushed_at":"2024-10-23T19:35:53.000Z","size":294,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-05T14:37:22.692Z","etag":null,"topics":["api","artwork","coverart","docker","docker-compose","html","image-generator","json","music","php"],"latest_commit_sha":null,"homepage":"https://petesteege.com/devlopment/imageapi","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/petesteege.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-23T14:57:49.000Z","updated_at":"2024-10-23T20:00:01.000Z","dependencies_parsed_at":"2024-10-23T19:43:17.829Z","dependency_job_id":"cccbe939-75db-47ca-9717-cf3d670cb82b","html_url":"https://github.com/petesteege/imageapi","commit_stats":null,"previous_names":["slh2171/imageapi"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petesteege%2Fimageapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petesteege%2Fimageapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petesteege%2Fimageapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petesteege%2Fimageapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/petesteege","download_url":"https://codeload.github.com/petesteege/imageapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230043145,"owners_count":18163966,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","artwork","coverart","docker","docker-compose","html","image-generator","json","music","php"],"created_at":"2024-10-29T14:04:41.936Z","updated_at":"2026-04-13T03:44:14.551Z","avatar_url":"https://github.com/petesteege.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# imageapi\n\nNote: This is still a working progress but mostly there. \n\nAn API / web gui for docker that uses html as a template to render down to an image.\n\nCan be used for Music Cover art generation / banners etc. \n\n1. Setup your environment variables in the .env file, and install using the docker-compose.yml, this creates two containers, the API and a web GUI.\n\n2. create an html template in the gui or upload one via the API (i think that works).\n\n3 in the template add any api  variables you wish to send to you template using  - {{my_api_var}}. \n\n    \u003cdiv class=\"album-id\"\u003e{{album_id}}\u003c/div\u003e\n\nthen in the API you can send this variable - \n\n  https://api.myserver.com/api/make_image?{=\u0026album_id=My Great Album\u0026}\n\n  or as JSON - \n\n      e.g. -\n    \n      { \n        \"template_id\": \"2\",\n        \"width\": 1400,\n        \"height\": 1400,\n        \"data\":{\"artist_name\": \"Bob\",\n                \"track_title\": \"McBobface\",\n                \"back_url\": \"null\",\n                \"artworkcopy\": \"Image (c) courtesy of someone with a camera\",\n                \"release_date\": \"produciton date\",\n                \"font_col\": \"%23FFFFFF\",\n                \"back_col\": \"%23FFFFFF\",\n                \"track_col\": \"%23FFFFFF\",\n                \"album_id\": \"34786259\",\n                \"copyright\":\"Copyright (c) McBobface Music, . All rights reserved.\"\n            }\n        }\n\n\nAPI auth\n\nHeader - X-API-Key: \u003capi key in the .env file\u003e\n\n4. click download image button (if using the GUI) or the API should return the following JSON -\n\n        {\n            \"status\": \"success\",\n            \"file_url\": \"https://api.myserver.com/output/1f4c8db8-a604-4daa-bf2d-9548d35a1f78.png\"\n        }\n\n\nAny questions (or improvements) get in touch. As i say, this is still a working progress :)\n\n\n\nendpoints available  \u003cserver url\u003e/docs\n\n\n\n# Screenshot\n\n\n\n\n![imageapi_screenshot](https://github.com/user-attachments/assets/cb5c8805-d6b6-4817-a443-c10cafdbdf97)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpetesteege%2Fimageapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpetesteege%2Fimageapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpetesteege%2Fimageapi/lists"}