Skip to main content

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

argument required description
template_id Yes ID of the template (open-graph-image-1, tweet-image-1, beautify-screenshot-1)
modifications Yes Modifications for the selected template.
response_format No base64 or binary (Defaults to base64).

For available templates and their modifications refer image generation api templates

Metadata

Release files for pika-sdk 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pika-sdk 0.2.1
File Size Uploaded
pika-sdk-0.2.1.tar.gz 3.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pika-sdk 0.2.1
File Interpreter ABI Platform
pika_sdk-0.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 8.3 kB

Release files / pika-sdk-0.2.1.tar.gz

Download URL pika-sdk-0.2.1.tar.gz
Size 3.7 kB
Tags Source
SHA-256 checksum
How to use checksums
5c9eb8edcdc6bc80596ca1206ae3b19378986f5290c24ae89e97f4433585f625
BLAKE2b-256 checksum
How to use checksums
28ba97f73084748fbbdd62c28840f3ff690ae0092562a91f50a4e6fb814523eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.18

Release files / pika_sdk-0.2.1-py3-none-any.whl

Download URL pika_sdk-0.2.1-py3-none-any.whl
Size 4.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
95788bb308a67cc1885c7581181079b5aa9a2b8d2be77058830fc4f368d24f5a
BLAKE2b-256 checksum
How to use checksums
6fe2bb3d8ba506cfdb012a19895bad05979aac69d54c1157990713429169a97f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.18

Release history Release notifications | RSS feed

This release

0.2.1 This release

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page