Generate Open Graph and social-share preview images in PNG format from URL query parameters, including title, subtitle, eyebrow, label, theme, and size.
Run in Postman
iVBORw0KGgoAAAANSUhEUgAABLAAAAJ2CAYAAABPQHtcAAEa+UlEQVR4nOz9W7x1V1XmC691LdQ+XUis7+oTyP59h1IE3ZYIJFCiEhIQ3OaIcsgRECEnUCAnQA4hCSqSIxAlRwSEnFRKIQnB/VWVQllXRcDLMvjdSl3X7m2ud+Udc605xmitt9PT+xh/fvN9x2K13p/2tDnXetd8MsZY+//Tj/+//sdeD+yXx7NsfbDF+GdWXGANnFUkwn7HzlANSLXYFJxODHAx47JpOKkuQsVDxeAQuRcVewHRBA7McTDLjMlRhSDJuk5Wt7oJOrG4X/7XDR1ZGafOZN0qI1LFs4k1L1ITFdvSR4C1NcCtD7YY/8yKC6yBs4pE2O/YGaoBqRabgtOJAS5mXDYNJ9VFqHioGBwi96JiLyCawIE5DmaZMTmqECRZ18nqVjdBJxbX8Ko16kzWrTIiVTybWPMiNVGxPe0HWFsD3Ppgi/HPrLjAGjirSIT9jp2hGpBqsSk4nRjgYsZl03BSXYSKh4rBIXIvKvYCogkcmONglhmTowpBknWdrG51E3RicQ2vWqPOZN0qI1LFs4k1L1ITFfvQdoC1NcCtD7YY/8yKC6yBs4pE2O/YGaoBqRabgtOJAS5mXDYNJ9VFqHioGBwi96JiLyCawIE5DmaZMTmqECRZ18nqVjdBJxbX8Ko16kzWrTIiVTybWPMiNVGxH+0GWFsD3Ppgi/HPrLjAGjirSIT9jp2hGpBqsSk4nRjgYsZl03BSXYSKh4rBIXIvKvYCogkcmONglhmTowpBknWdrG51E3RicQ2vWqPOZN0qI1LFs4k1L1ITFfvSZoC1NcCtD7YY/8yKC6yBs4pE2O/YGaoBqRabgtOJAS5mXDYNJ9VFqHioGBwi96JiLyCawIE5DmaZMTmqECRZ18nqVjdBJxbX8Ko16kzWrTIiVTybWPMiNVGxP+0FWFsD3Ppgi/HPrLjAGjirSIT9jp2hGpBqsSk4nRjgYsZl03BSXYSKh4rBIXIvKvYCogkcmONglhmTowpBknWdrG51E3RicQ2vWqPOZN0qI1LFs4k1L1ITFcfQVoC1NcCtD7YY/8yKC6yBs4pE2O/YGaoBqRabgtOJAS5mXDYNJ9VFqHioGBwi96JiLyCawIE5DmaZMTmqECRZ18nqVjdBJxbX8Ko16kzWrTIiVTybWPMiNVFxHO0EWFsD3Ppgi/HPrLjAGjirSIT9jp2hGpBqsSk4nRjgYsZl03BSXYSKh4rBIXIvKvYCogkcmONglhmTowpBknWdrG51E3RicQ2vWqPOZN0qI1LFs4k1L1ITFcfSRoC1NcCtD7YY/8yKC6yBs4pE2O/YGaoBqRabgtOJAS5mXDYNJ9VFqHioGBwi96JiLyCawIE5DmaZMTmqECRZ18nqVjdBJxbX8Ko16kzWrTIiVTybWPMiNVFxPPgB1tYAtz7YYvwzKy6wBs4qEmG/Y2eoBqRabApOJwa4mHHZNJxUF6HioWJwiNyLir2AaAIH5jiYZcbkqEKQZF0nq1vdBJ1YXMOr1qgzWbfKiFTxbGLNi9RExTlgB1hbA9z6YIvxz6y4wBo4q0iE/Y6doRqQarEpOJ0Y4GLGZdNwUl2EioeKwSFyLyr2AqIJHJjjYJYZk6MKQZJ1naxudRN0YnENr1qjzmTdKiNSxbOJNS9SExXngRtgbQ1w64Mtxj+z4gJr4KwiEfY7doZqQKrFpuB0YoCLGZdNw0l1ESoeKgaHyL2o2AuIJnBgjoNZZkyOKgRJ1nWyutVN0InFNbxqjTqTdauMSBXPJta8SE1UnAtmgLU1wK0Pthj/zIoLrIGzikTY79gZqgGpFpuC04kBLmZcNg0n1UWoeKgYHCL3omIvIJrAgTkOZpkxOaoQJFnXyepWN0EnFtfwqjXqTNatMiJVPJtY8yI1UXE+eAHW1gC3Pthi/DMrLrAGzioSYb9jZ6gGpFpsCk4nBriYcdk0nFQXoeKhYnCI3IuKvYBoAgfmOJhlxuSoQpBkXSerW90EnVhcw6vWqDNZt8qIVPFsYs2L1ETFGGAFWFsD3Ppgi/HPrLjAGjirSIT9jp2hGpBqsSk4nRjgYsZl03BSXYSKh4rBIXIvKvYCogkcmONglhmTowpBknWdrG51E3RicQ2vWqPOZN0qI1LFs4k1L1ITFeOAE2BtDXDrgy3GP7PiAmvgrCIR9jt2hmpAqsWm4HRigIsZl03DSXURKh4qBofIvajYC4gmcGCOg1lmTI4qBEnWdbK61U3QicU1vGqNOpN1q4xIFc8m1rxITVSMBUaAtTXArQ+2GP/MigusgbOKRNjv2BmqAakWm4LTiQEuZlw2DSfVRah4qBgcIveiYi8gmsCBOQ5mmTE5qhAkWdfJ6lY3QScW1/CqNepM1q0yIlU8m1jzIjVRMR75AdbWALc+2GL8MysusAbOKhJhv2NnqAakWmwKTicGuJhx2TScVBeh4qFikLAnwC70BKIJHJjjYJYZk6MKQZJ1naxudRN0YnENr1qjzmTdKiNSxbOJNS9SExVjkhtgbQ1w64Mtxj+z4gJr4KwiEfY7doZqQKrFpuB0YoCLGZdNw0l1ESoeKgaHyL2o2AuIJnBgjoNZZkyOKgRJ1nWyutVN0InFNbxqjTqTdauMSBXPJta8SE1UjEtegLU1wK0Pthj/zIoLrIGzikTY79gZqgGpFpuC04kBLmZcNg0n1UWoeKgYHCL3omIvIJrAgTkOZpkxOaoQJFnXyepWN0EnFtfwqjXqTNatMiJVPJtY8yI1UTE2OQHW1gC3Pthi/DMrLrAGzioSYb9jZ6gGpFpsCk4nBriYcdk0nFQXoeKhYnCI3IuKvYBoAgfmOJhlxuSoQpBkXSerW90EnVhcw6vWqDNZt8qIVPFsYs2L1ETF+MQHWFsD3Ppgi/HPrLjAGjirSIT9jp2hGpBqsSk4nRjgYsZl03BSXYSKh4rBIXIvKvYCogkcmONglhmTowpBknWdrG51E3RicQ2vWqPOZN0qI1LFs4k1L1ITFbdBbIC1NcCtD7YY/8yKC6yBs4pE2O/YGaoBqRabgtOJAS5mXDYNJ9VFqHioGBwi96JiLyCawIE5DmaZMTmqECRZ18nqVjdBJxbX8Ko16kzWrTIiVTybWPMiNVFxO8QFWFsD3Ppgi/HPrLjAGjirSIT9jp2hGpBqsSk4nRjgYsZl03BSXYSKh4rBIXIvKvYCogkcmONglhmTowpBknWdrG51E3RicQ2vWqPOZN0qI1LFs4k1L1ITFbdFTIC1NcCtD7YY/8yKC6yBs4pE2O/YGaoBqRabgtOJAS5mXDYNJ9VFqHioGBwi96JiLyCawIE5DmaZMTmqECRZ18nqVjdBJxbX8Ko16kzWrTIiVTybWPMiNVFxe/gHWFsD3Ppgi/HPrLjAGjirSIT9jp2hGpBqsSk4nRjgYsZl03BSXYSKh4rBIXIvKvYCogkcmONglhmTowpBknWdrG51E3RicQ2vWqPOZN0qI1LFs4k1L1ITFbeJb4C1NcCtD7YY/8yKC6yBs4pE2O/YGaoBqRabgtOJAS5mXDYNJ9VFqHioGBwi96JiLyCawIE5DmaZMTmqECRZ18nqVjdBJxbX8Ko16kzWrTIiVTybWPMiNVFxu/gFWFsD3Ppgi/HPrLjAGjirSIT9jp2hGpBqsSk4nRjgYsZl03BSXYSKh4rBIXIvKvYCogkcmONglhmTowpBknWdrG51E3RicQ2vWqPOZN0qI1LFs4k1L1ITFbeNT4C1NcCtD7YY/8yKC6yBs4pE2O/YGaoBqRabgtOJAS5mXDYNJ9VFqHioGBwi96JiLyCawIE5DmaZMTmqECRZ18nqVjdBJxbX8Ko16kzWrTIiVTybWPMiNVFx+9gHWFsD3Ppgi/HPrLjAGjirSIT9jp2hGpBqsSk4nRjgYsZl03BSXYSKh4rBIXIvKvYCogkcmONglhmTowpBknWdrG51E3RicQ2vWqPOZN0qI1LFs4k1L1ITFfeBbYC1NcCtD7YY/8yKC6yBs4pE2O/YGaoBqRabgtOJAS5mXDYNJ9VFqHioGBwi96JiLyCawIE5DmaZMTmqECRZ18nqVjdBJxbX8Ko16kzWrTIiVTybWPMiNVFxP9gFWFsD3Ppgi/HPrLjAGjirSIT9jp2hGpBqsSk4nRjgYsZl03BSXYSKh4rBIXIvKvYCogkcmONglhmTowpBknWdrG51E3RicQ2vWqPOZN0qI1LFs4k1L1ITFfeFTYC1NcCtD7YY/8yKC6yBs4pE2O/YGaoBqRabgtOJAS5mXDYNJ9VFqHioGBwi96JiLyCawIE5DmaZMTmqECRZ18nqVjdBJxbX8Ko16kzWrTIiVTybWPMiNVFxf+gDrK0Bbn2wxfhnVlxgDZxVJMJ+x85QDUi12BScTgxwMeOyaTipLkLFQ8XgELkXFXsB0QQOzHEwy4zJUYUgybpOVre6CTqxuIZXrVFnsm6VEani2cSaF6mJivtEF2BtDXDrgy3GP7PiAmvgrCIR9jt2hmpAqsWm4HRigIsZl03DSXURKh4qBofIvajYC4gmcGCOg1lmTI4qBEnWdbK61U3QicU1vGqNOpN1q4xIFc8m1rxITVTcL/UB1tYAtz7YYvwzKy6wBs4qEmG/Y2eoBqRabApOJwa4mHHZNJxUF6HioWJwiNyLir2AaAIH5jiYZcbkqEKQZF0nq1vdBJ1YXMOr1qgzWbfKiFTxbGLNi9RExX1TF2BtDXDrgy3GP7PiAmvgrCIR9jt2hmpAqsWm4HRigIsZl03DSXURKh4qBofIvajYC4gmcGCOg1lmTI4qBEnWdbK61U3QicU1vGqNOpN1q4xIFc8m1rxITVTcP/IAa2uAWx9sMf6ZFRdYA2cVibDfsTNUA1ItNgWnEwNczLhsGk6qi1DxUDE4RO5FxV5ANIEDcxzMMmNyVCFIsq6T1a1ugk4sruFVa9SZrFtlRKp4NrHmRWqi4iVQvhuKAqytAW59sMX4Z1ZcYA2cVSTCfsfOUA1ItdgUnE4McDHjsmk4qS5CxUPF4BC5FxV7AdEEDsxxMMuMyVGFIMm6Tla3ugk6sVjerpU/O6EjK+PUmaxbZUSqeDax5kVqouIlcDAQfoB1UH+CrQ+2GP/MigusgbOKRNjv2BmqAakWm4LTiQEuZlw2DSfVRah4qBgcIveiYi8gmsCBOQ5mmTE5qhAkWdfJ6lY3QScW1/CqNepM1q0yIlU8m1jzIjVR8RI4ORBegHWyvrD1wRbjn1lxgTVwVpEI+x07QzUg1WJTcDoxwMWMy6bhpLoIFQ8Vg0PkXlTsBUQTODDHwSwzJkcVgiTrOlnd6iboxOIaXrVGncm6VUakimcTa16kJipeAtsDmQ+wtuq3Pthi/DMrLrAGzioSYb9jZ6gGpFpsCk4nBriYcdk0nFQXoeKhYnCI3IuKvYBoAgfmOJhlxuSoQpBkXSerW90EnVhcw6vWqDNZt8qIVPFsYs2L1ETFS+D4QKYDrK36rQ+2GP/MigusgbOKRNjv2BmqAakWm4LTiQEuZlw2DSfVRah4qBgcIveiYi8gmsCBOQ5mmTE5qhAkWdfJ6lY3QScW1/CqNepM1q0yIlU8m1jzIjVR8RLYPZDxAGurfuuDLcY/s+ICa+CsIhH2O3aGakCqxabgdGKAixmXTcNJdREqHioGh8i9qNgLiCZwYI6DWWZMjioESdZ1srrVTdCJxTW8ao06k3WrjEgVzybWvEhNVLwExgeyO8Daqt/6YIvxz6y4wBo4q0iE/Y6doRqQarEpOJ0Y4GLGZdNwUl2EioeKwSFyLyr2AqIJHJjjYJYZk6MKQZJ1naxudRN0YnENr1qjzmTdKiNSxbOJNS9SExUvgemBHA+wtuq3Pthi/DMrLrAGzioSYb9jZ6gGpFpsCk4nBriYcdk0nFQXoeKhYnCI3IuKvYBoAgfmOJhlxuSoQpBkXSerW90EnVhcw6vWqDNZt8qIVPFsYs2L1ETFS2B+INsB1lb91gdbjH9mxQXWwFlFIux37AzVgFSLTcHpxAAXMy6bhpPqIlQ8VAwOkXtRsRcQTeDAHAezzJgcVQiSrOtkdauboBOLa3jVGnUm61YZkSqeTax5kZqoeAnwBnIywNqq3/pgi/HPrLjAGjirSIT9jp2hGpBqsSk4nRjgYsZl03BSXYSKh4rBIXIvKvYCogkcmONglhmTowpBknWdrG51E3RicQ2vWqPOZN0qI1LFs4k1L1ITFS8B/kAOAqyt+q0Pthj/zIoLrIGzikTY79gZqgGpFpuC04kBLmZcNg0n1UWoeKgYHCL3omIvIJrAgTkOZpkxOaoQJFnXyepWN0EnFtfwqjXqTNatMiJVPJtY8yI1UfESkA1k/396XgmwnmV88fhnVlxgDZxVJMJ+x85QDUi12BScTgxwMeOyaTipLkLFQ8XgELkXFXsB0QQOzHEwy4zJUYUgybpOVre6CTqxuIZXrVFnsm6VEani2cSaF6mJipeAfCCDAGt88fhnVlxgDZxVJMJ+x85QDUi12BScTgxwMeOyaTipLkLFQ8XgELkXFXsB0QQOzHEwy4zJUYUgybpOVre6CTqxuIZXrVFnsm6VEani2cSaF6mJipdA3UBOBFjji8c/s+ICa+CsIhH2O3aGakCqxabgdGKAixmXTcNJdREqHioGh8i9qNgLiCZwYI6DWWZMjioESdZ1srrVTdCJxTW8ao06k3WrjEgVzybWvEhNVLwE6gdSAqz/dwmwdlO/7UoVrIGzikTY79gZqgGpFpuC04kBLmZcNg0n1UWoeKgYHCL3omIvIJrAgTkOZpkxOaoQJFnXyepWN0EnFtfwqjXqTNatMiJVPJtY8yI1UfES0A1kNMDSbbsihjVwVpEI+x07QzUg1WJTcDoxwMWMy6bhpLoIFQ8Vg0PkXlTsBUQTODDHwSwzJkcVgiTrOlnd6iboxOIaXrVGncm6VUakimcTa16kJipeAvqB7Ayw9NuuiGANnFUkwn7HzlANSLXYFJxODHAx47JpOKkuQsVDxeAQuRcVewHRBA7McTDLjMlRhSDJuk5Wt7oJOrG4hletUWeybpURqeLZxJoXqYmKl4DNQI4FWDbbrrBhDZxVJMJ+x85QDUi12BScTgxwMeOyaTipLkLFQ8XgELkXFXsB0QQOzHEwy4zJUYUgybpOVre6CTqxuIZXrVFnsm6VEani2cSaF6mJipeA3UC2Aiy7bVdYsAbOKhJhv2NnqAakWmwKTicGuJhx2TScVBeh4qFicIjci4q9gGgCB+Y4mGXG5KhCkGRdJ6tb3QSdWFzDq9aoM1m3yohU8WxizYvURMVLwHYgzwZYttuuzMIaOKtIhP2OnaEakGqxKTidGOBixmXTcFJdhIqHisEhci8q9gKiCRyY42CWGZOjCkGSdZ2sbnUTdGJxDa9ao85k3SojUsWziTUvUhMVLwH7gWwCLPttVyZhDZxVJMJ+x85QDUi12BScTgxwMeOyaTipLkLFQ8XgELkXFXsB0QQOzHEwy4zJUYUgybpOVre6CTqxuIZXrVFnsm6VEani2cSaF6mJipeAz0D2/+cSYJW/V6JgPY+sIhH2O3aGakCqxabgdGKAixmXTcNJdREqHioGh8i9qNgLiCZwYI6DWWZMjioESdZ1srrVTdCJxTW8ao06k3WrjEgVzybWvEhNVLwE/AayBliRsJ5HVpEI+x07QzUg1WJTcDoxwMWMy6bhpLoIFQ8Vg0PkXlTsBUQTODDHwSwzJkcVgiTrOlnd6iboxOIaXrVGncm6VUakimcTa16kJipeAr4DWQOsKFjPI6tIhP2OnaEakGqxKTidGOBixmXTcFJdhIqHisEhci8q9gKiCRyY42CWGZOjCkGSdZ2sbnUTdGJxDa9ao85k3SojUsWziTUvUhMVLwH/gawBVgSs55FVJMJ+x85QDUi12BScTgxwMeOyaTipLkLFQ8XgELkXFXsB0QQOzHEwy4zJUYUgybpOVre6CTqxuIZXrVFnsm6VEani2cSaF6mJipdAzEDWAMsb1vPIKhJhv2NnqAakWmwKTicGuJhx2TScVBeh4qFicIjci4q9gGgCB+Y4mGXG5KhCkGRdJ6tb3QSdWFzDq9aoM1m3yohU8WxizYvURMVLIG4ga4DlCet5ZBWJsN+xM1QDUi02BacTA1zMuGwaTqqLUPFQMThE7kXFXkA0gQNzHMwyY3JUIUiyrpPVrW6CTiyu4VVr1JmsW2VEqng2seZFaqLiJRA7kDXA8oL1PLKKRNjv2BmqAakWm4LTiQEuZlw2DSfVRah4qBgcIveiYi8gmsCBOQ5mmTE5qhAkWdfJ6lY3QScW1/CqNepM1q0yIlU8m1jzIjVR8RKIH8gaYHnAeh5ZRSLsd+wM1YBUi03B6cQAFzMum4aT6iJUPFQMDpF7UbEXEE3gwBwHs8yYHFUIkqzrZHWrm6ATi2t41Rp1JutWGZEqnk2seZGaqHgJ5AxkDbCsYT2PrCIR9jt2hmpAqsWm4HRigIsZl03DSXURKh4qBofIvajYC4gmcGCOg1lmTI4qBEnWdbK61U3QicU1vGqNOpN1q4xIFc8m1rxITVS8BPIGsgZYlrCeR1aRCPsdO0M1INViU3A6McDFjMum4aS6CBUPFYND5F5U7AVEEzgwx8EsMyZHFYIk6zpZ3eom6MTiGl61Rp3JulVGpIpnE2tepCYqXgK5A1kDLCtYzyOrSIT9jp2hGpBqsTlY3ShwMeKyaTipLkLFQ8XgELkXFXsB0QQOzHEwy4zJUYUgybpOVre6CTqxuIZXrVFnsm6VEani2cSaF6mJipdA/kDWAMsC1vPIKhJhv2NnqAakWmwKTicGuJhx2TScVBeh4qFicIjci4q9gGgCB+Y4mGXG5KhCkGRdJ6tb3QSdWFzDq9aoM1m3yohU8WxizYvURMVLAGAgpYU1wNJShjgPq0iE/Y6doRqQarE5WN0ocDHismk4qS5CxUPF4BC5FxV7AdEEDsxxMMuMyVGFIMm6Tla3ugk6sbiGV61RZ7JulRGp4tnEmhepiYqXAMBATrSwBlgaTgxxGlaRCPsdO0M1INViU3A6McDFjMum4aS6CBUPFYND5F5U7AVEEzgwx8EsMyZHFYIk6zpZ3eom6MTiGl61Rp3JulVGpIpnE2tepCYqXgIAAxm0sAZYtQyGOA6rSIT9jp2hGpBqsTlY3ShwMeKyaTipLkLFQ8XgELkXFXsB0QQOzHEwy4zJUYUgybpOVre6CTqxuIZXrVFnsm6VEani2cSaF6mJipcAwECOtLAGWDUcGeJuWEUi7HfsDNWAVItNwenEABczLpuGk+oiVDxUDA6Re1GxFxBN4MAcB7PMmBxVCJKs62R1q5ugE4treNUadSbrVhmRKp5NrHmRmqh4CQAMZEcLa4AlZccQj8MqEmG/Y2eoBqRabApOJwa4mHHZNJxUF6HioWJwiNyLir2AaAIH5jiYZcbkqEKQZF0nq1vdBJ1YXMOr1qgzWbfKiFTxbGLNi9RExUsAYCAjLawBloSRIW7DKhJhv2NnqAakWmwKTicGuJhx2TScVBeh4qFicIjci4q9gGgCB+Y4mGXG5KhCkGRdJ6tb3QSdWFzDq9aoM1m3yohU8WxizYvURMVLAGAgEy2sARaXiSGehFUkwn7HzlANSLXYFJxODHAx47JpOKkuQsVDxeAQuRcVewHRBA7McTDLjMlRhSDJuk5Wt7oJOrG4hletUWeybpURqeLZxJoXqYmKlwDAQGZaWAMsDjNDPIBVJMJ+x85QDUi12BScTgxwMeOyaTipLkLFQ8XgELkXFXsB0QQOzHEwy4zJUYUgybpOVre6CTqxuIZXrVFnsm6VEani2cSaF6mJipcAwEAYLawB1hyMITKLRNjv2BmqAakWm4LTiQEuZlw2DSfVRah4qBgcIveiYi8gmsCBOQ5mmTE5qhAkWdfJ6lY3QScW1/CqNepM1q0yIlU8m1jzIjVR8RIAGAizhTXAmoI1RFaR
curl --location --request GET 'https://zylalabs.com/api/13119/ogforge+link+preview+api/26604/generate+og+image' --header 'Authorization: Bearer YOUR_API_KEY'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the OGForge Link Preview API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
(Save 2 months with annual billing 🎉)
Trusted by leading companies
This API generates Open Graph images in PNG format from URL query parameters. Open Graph images are the preview cards that link-sharing systems display for a page.
Endpoint: GET /og
Parameters:
- title: main text (required).
- subtitle: secondary text (optional).
- eyebrow: small label shown above the title (optional).
- theme: one of midnight, sunset, forest, grape, mono (optional, default midnight).
- size: og (1200x630), twitter (1200x600), square (1080x1080), or a custom WIDTHxHEIGHT value (optional, default og).
Response: image/png
Example: GET /og?title=Quarterly report&eyebrow=FINANCE&theme=midnight&size=og
Images are rendered server-side without a headless browser and returned in the response body.
The OGForge Link Preview API returns an image in PNG format that represents an Open Graph card generated from the provided query parameters. This image serves as a visual preview for link-sharing systems.
The endpoint accepts the following parameters: title (required), subtitle (optional), eyebrow (optional), theme (optional, default is midnight), and size (optional, with defaults). Users can customize these parameters to tailor the generated image.
Users can customize requests by specifying values for the title, subtitle, eyebrow, theme, and size parameters in the query string. For example, to create a themed image, users can set the theme parameter to "sunset" or "forest."
The theme parameter accepts values such as midnight, sunset, forest, grape, and mono. The size parameter can be set to predefined values like og (1200x630), twitter (1200x600), square (1080x1080), or a custom WIDTHxHEIGHT format.
The response consists of a single PNG image generated based on the input parameters. There are no additional fields in the response; the image is directly returned in the response body.
Typical use cases include generating social media preview images for articles, blog posts, or products. Developers can use this API to create visually appealing link previews that enhance user engagement on platforms like Facebook and Twitter.
Users can directly display the returned PNG image in their applications or websites as a link preview. This enhances the visual appeal of shared links, making them more attractive to users.
The API generates images server-side without a headless browser, ensuring consistent quality and performance. The rendering process is optimized to produce high-quality images based on the specified parameters.
The OGForge Link Preview API exclusively returns images in PNG format. This format is widely supported across web platforms, making it suitable for use in social media previews and other applications.
Users can specify custom dimensions by using the size parameter in the format WIDTHxHEIGHT. For example, to create an image that is 800x400 pixels, the request would include size=800x400 in the query string.
If the required title parameter is missing from the request, the API will not generate an image and will likely return an error response indicating that the title is mandatory.
The API does not provide a built-in preview feature. Users must make a request with their parameters to generate the image and then view the response to see the result.
While the API documentation does not specify exact character limits for the title and subtitle, it is advisable to keep them concise to ensure optimal rendering and readability in the generated image.
The theme parameter alters the visual style of the generated image, including background colors and font styles. For instance, selecting "sunset" will produce a different aesthetic compared to "forest."
Users should check their query parameters for correctness and ensure that all required fields are included. If issues persist, they may need to consult the API documentation or support for troubleshooting.
The visually appealing images generated by the API can attract more clicks and shares on social media platforms, making links more enticing to users and improving overall engagement with shared content.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund
