PiAPI/Joycaption-Create Task

Request

Header Params

x-api-key

string

optional

your api key

Body Params application/json

model

enum<string>

required

Model name, currently select Qubico/joycaption.

Allowed value:

Qubico/joycaption

task_type

enum<string>

required

Currently select joycaption-beta-one.

Allowed value:

joycaption-beta-one

input

object

required

image

string

required

Input image url or base64 string to caption.

prompt_style

enum<string>

optional

Describe the style of caption that you want to generate.

Allowed values:

DescriptiveDescriptive (Casual)StraightforwardStable Diffusion PromptMidJourneyDanbooru tag liste621 tag listRule34 tag listBooru-like tag listArt CriticProduct ListingSocial Media Post

Default:

Descriptive

caption_length

enum<string>

optional

Describe the length of caption.

Allowed values:

anyvery shortshortmediumlongvery long

Default:

any

config

object

required

webhook_config

object

optional

Example

{
    "model": "Qubico/joycaption",
    "task_type": "joycaption-beta-one",
    "input": {
        "workflow_type": "joycaption-beta-one",
        "prompt_style": "Descriptive",
        "caption_length": "any",
        "image": "https://piapi.ai/workspace/flux/input_example.png"
    },
    "config": {
        "webhook_config": {
            "endpoint": "",
            "secret": ""
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.piapi.ai/api/v1/task' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "Qubico/joycaption",
    "task_type": "joycaption-beta-one",
    "input": {
        "workflow_type": "joycaption-beta-one",
        "prompt_style": "Descriptive",
        "caption_length": "any",
        "image": "https://piapi.ai/workspace/flux/input_example.png"
    },
    "config": {
        "webhook_config": {
            "endpoint": "",
            "secret": ""
        }
    }
}'

Responses

🟢200Success

application/json

Body

model

string

optional

task_type

string

optional

input

object

optional

prompt

string

required

negative_prompt

string

optional

video

string

required

steps

integer

optional

seed

integer

optional

config

object

optional

webhook_config

object

optional

Example

{
    "code": 200,
    "data": {
        "task_id": "1e829971-31b6-44e6-83cc-84d20b9e089c",
        "model": "Qubico/joycaption",
        "task_type": "joycaption-beta-one",
        "status": "pending",
        "config": {
            "service_mode": "",
            "webhook_config": {
                "endpoint": "",
                "secret": ""
            }
        },
        "input": {
            "image": "https://piapi.ai/workspace/flux/input_example.png",
            "prompt_style": "Descriptive",
            "caption_length": "any"
        },
        "output": null,
        "meta": {
            "created_at": "2025-07-16T06:21:33.896480518Z",
            "started_at": "0001-01-01T00:00:00Z",
            "ended_at": "0001-01-01T00:00:00Z",
            "usage": {
                "type": "llm",
                "frozen": 0,
                "consume": 100000
            },
            "is_using_private_pool": false
        },
        "detail": null,
        "logs": [],
        "error": {
            "code": 0,
            "raw_message": "",
            "message": "",
            "detail": null
        }
    },
    "message": "success"
}

Image Caption

Overview

Pricing

Request

Request samples

Responses

Image Caption

Overview#

Pricing#

Request

Request samples

Responses

Overview

Pricing