POST /volcv/v1

Method: POSTEndpoint: /volcv/v1

https://www.volcengine.com/docs/6791/1279296For details, see the official integration documentation

Request Parameters

Query Parameters

Action
string
Required
Example:
CVProcess
Version
string
Required
Example:
2022-08-31

Header Parameters

Authorization
string
Optional
Default Value:
Bearer {{YOUR_API_KEY}}

Body Parameters application/json

object
Example
{
"req_key"
:
"high_aes_general_v14_ip_keep"
,
// "binary_data_base64": [],
"image_urls"
:
[
"https://xxx"
]
,
"prompt"
:
"Vast armies charging forward"
,
"model_version"
:
"general_v1.4_ip"
,
"subject_prompt"
:
""
,
"ref_ip_weight"
:
0.7
,
"ref_id_weight"
:
0.9
,
"negative_prompt"
:
"negative prompt：nsfw, nude, blurry, watermark, identifying mark, low resolution, mutated, lack of hierarchy"
,
"seed"
:
-1
,
"scale"
:
3.0
,
"ddim_steps"
:
16
,
"width"
:
512
,
"height"
:
512
,
"use_rephraser"
:
false
,
"use_predict_tags"
:
true
,
"use_sr"
:
true
,
"sr_seed"
:
-1
,
"sr_strength"
:
0.4
,
"sr_scale"
:
3.5
,
"sr_steps"
:
10
,
"return_url"
:
true
,
"logo_info"
:
{
"add_logo"
:
false
,
"position"
:
0
,
"language"
:
0
,
"opacity"
:
0.3
,
"logo_text_content"
:
"This is a visible watermark"
}
}

Example Request

Shell

curl --location --request POST '/volcv/v1?Action=CVProcess&Version=2022-08-31' \
--header 'Authorization: Bearer {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "req_key": "high_aes_general_v14_ip_keep",
    // "binary_data_base64": [],
    "image_urls": ["https://xxx"],
    "prompt": "Vast armies charging forward",
    "model_version": "general_v1.4_ip",
    "subject_prompt": "",
    "ref_ip_weight": 0.7,
    "ref_id_weight": 0.9,
    "negative_prompt": "negative prompt：nsfw, nude, blurry, watermark, identifying mark, low resolution, mutated, lack of hierarchy",
    "seed": -1,
    "scale": 3.0,
    "ddim_steps": 16,
    "width": 512,
    "height": 512,
    "use_rephraser": false,
    "use_predict_tags": true,
    "use_sr": true,
    "sr_seed": -1,
    "sr_strength": 0.4,
    "sr_scale": 3.5,
    "sr_steps": 10,
    "return_url": true,
    "logo_info": {
        "add_logo": false,
        "position": 0,
        "language": 0,
        "opacity": 0.3,
        "logo_text_content": "This is a visible watermark"
    }
}'

Response

🟢 200 Success

Content Type: application/json

Response Schema

object

Example

{
    "code": 10000,
    "data": {
        "algorithm_base_resp": {
            "status_code": 0,
            "status_message": "Success"
        },
        "binary_data_base64": [],
        "image_urls": [
            "https://xxx"
        ],
        "predict_tags_result": "xxx",
        "rephraser_result": "xxx",
        "request_id": "xxxxx9ccce338c963032f7a3ec06f03d259f1c46215750eca3b7f51f5f97xxxx"
    },
    "message": "Success",
    "request_id": "2024101217550004248C63C19B1F15xxxx",
    "status": 10000,
    "time_elapsed": "9.867352102s"
}