For the complete documentation index, see llms.txt. This page is also available as Markdown.

Background AI Prompt

API endpoint - /api/2/img/[IMAGE-URL]/prompt/background

Description

/prompt/background - generates prompts that could be used in image transformation API using ?background query parameter.

Without any parameters, API will generate JSON with four prompts with plain text and encoded outputs. Encoded output is what can be passed into ?background query parameter.

Parameters

auth (required) - API secret that's used for authentication.

theme (optional) - theme that is used for prompt generation. It could be either a generic short theme or a full custom prompt. When the parameter is used, then the first prompt in the output will be the exact "theme" included encoded version.

Examples

Image used for the prompt

API call to generate prompt: https://pixboost.com/api/2/img/https://pixboost.com/img/demos/tshirt.jpg/prompt/background?auth=[API_SECRET]

encoded field is what can be passed into transformation API.

Output:

Last updated

Was this helpful?