Content Table

Prism Endpoint:

Avatar Generator


Usage

Description

Generate unique SVG profile icons from any text seed. Easily customize character shapes, background patterns, border styles, and color palettes to perfectly match your design.


Method & Path

Use https://prism.optical-labs.ca/image/avatar-generator to access this endpoint. The method must be POST and the header should contain your secret API key, as shown below:


Body Fields

Field Name Type Description
seed String (required) Any string between 1 and 255 characters
avatar_shape String (optional) One of: "curved" "square" "diamond"
bg_pattern String (optional) One of: "solid" "layers" "dots" "stripes" "grid"
palette String (optional) See all 25 options here.
color_bg_start Hex color code (optional) Any color in the form "#FF06B5"
color_bg_end Hex color code (optional) Any color in the form "#FF06B5"
color_body_start Hex color code (optional) Any color in the form "#FF06B5"
color_body_end Hex color code (optional) Any color in the form "#FF06B5"
color_head Hex color code (optional) Any color in the form "#FF06B5"
border_radius Integer (optional) A number from 0 (square) to 50 (circle)
border_width Integer (optional) Any number from 0 to around 12

Valid Response

Each successful request to this endpoint costs 1 credit. Your usage and remaining credits are always returned in the meta object of the response.


Palettes

Name Colors

Interactive Preview

Send a real request to the endpoint for free, directly from your browser!


Examples

No examples yet.