Skip to main content

Python

Pika API Python SDK​

View on pypi.org: pypi.org/project/pika-sdk

Installation​

pip install pika-sdk

Usage​

If you don't have your API key, get one from pika.style. Check the documentation on how to get your API key

Initialise​

ps = pika_sdk.PikaSdk('YOUR_PIKA_API_KEY')

Generate image​

response = ps.generate_image_from_template('open-graph-image-1', {'title': 'From python sdk new'}, 'base64')
print(response['data']['base64'])

Example​

Base64 response format​

import pika_sdk

ps = pika_sdk.PikaSdk('sk-he2jdus1cbz1dpt4mktgjyvx')
response = ps.generate_image_from_template('open-graph-image-1', {'title': 'From python sdk new'}, 'base64')
print(response)

print("Image base64:", response['data']['base64'])

Base64 output

data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABLAAAAJ2CAYAAABPQHtcAAAAAXNSR0IArs4c6QAAIABJREFUeJzs3XmYJXdZL/Bvna37dM90FghLCBAQkC1BCBAMShLFBJAgKnofroBeFUUF5LrhiihXcV8BQRYVUUAlIewIGPbFmLCFLWwCYZEtzPR+trp/TM/......

Binary response format​

from io import BytesIO

import pika_sdk
from PIL import Image

ps = pika_sdk.PikaSdk('sk-he2jdus1cbz1dpt4mktgjyvx')
response = ps.generate_image_from_template('open-graph-image-1', {'title': 'From python sdk new'}, 'binary')

with Image.open(BytesIO(response.content)) as im:
    im.save('og.png')

This example writes the binary image to the file og.png

generate_image_from_template​

Use this function to generate an image. It takes in 3 arguments

argumentrequireddescription
template_idYesID of the template (open-graph-image-1, tweet-image-1, beautify-screenshot-1)
modificationsYesModifications for the selected template.
response_formatNobase64, url or binary (Defaults to base64).

For available templates and their modifications refer image generation api templates