百家姓生成API详情

百家姓生成

WordArt锦书-百家姓生成可以输入姓氏文字进行创意设计，支持根据提示词和风格引导图进行自定义设计，同时提供多种精美的预设风格模板，生成图片可以应用于个性社交场景，如作为个人头像、屏幕壁纸、字体表情包等。

输入内容&效果示意：

风格说明：目前支持“自定义”和“预设风格”两种模式，“自定义”模式下，用户可通过提示词（input.prompt）、参考图（input. ref_image_url）和字体相关参数（input.text）进行效果自定义 ；“预设风格”，模式提供12种风格，直接使用预设的风格效果，不支持用户输入提示词（input.prompt）、参考图（input. ref_image_url）和字体相关参数（input.text）进行效果自定义。每一种预设风格具体的示例图如下：

应用场景

• 百家姓文字制作：围绕百家姓文字设计场景，通过简单的提示词描述即可实现创意字形、艺术纹理和个性字体的智能生成，批量生成丰富有趣的具有特效百家姓艺术字内容的个性化壁纸。

• 文档艺术字创作：办公文档艺术字创作设计场景，批量生成丰具有特效艺术字内容的个性化百家姓字体嵌入到文档中，围绕百家姓主题实现内容多样性创作和生成。

• 文字配图创意营销：电商、互动娱乐、视频制作等泛娱乐场景，可根据场景主题风格通过特定的提示词描述生成智能配图的百家姓艺术纹理和个性字体，实现创意文字表情包和姓名个人头像创作。

特色优势

• 灵活创意字体打造：通过简单灵活的提示词描述即可实现创意字形、艺术纹理和个性字体的智能打造。

• 批量稳定特效生成：批量生成丰富有趣的特效艺术百家姓字，在文字的辨识度、创意感、艺术性实现精准可控。

• 自定义风格迁移：支持传入任意风格参考图，生成百家姓图片的整体风格与客户自定义参考图保持风格一致。

模型概览

输入限制

• 百家姓生成服务支持两种模式，自定义模式和预设风格模式，通过风格字段（input.style）进行设置。如果设置为自定义模式，提示词（input.prompt）和参考图（input. ref_image_url）至少需要提供一项，如果提供参考图，建议同时提供提示词对图片画面进行具体描述，以保证生成结果更优；如果设置为预设风格模式，用户输入的提示词、参考图以及字体信息将不起作用。

• 姓氏输入要求：支持1-2个字，不能为空字符串""，仅支持中文（字符的支持范围由ttf文件决定）。

• 参考图输入要求：建议图片大小小于10M，图像格式推荐jpg/png/jpeg/bmp，宽高比不超过2:1，图像的长边不超过2048。

• 若提供ttf文件，需为标准的ttf文件，建议文件大小小于30M，input.text.ttf_url和input.text.font_name字段需要二选一。

• 提示词长度小于1000，且不能为""。

• URL地址中不能包含中文字符。

HTTP调用接口

功能描述

本模型需要相对较长的算法调用时间，所以在接口层面采用了异步调用的方式进行任务提交，在通过任务接口提交作业之后，系统会返回对应的作业ID，随后可以通过对应的异步作业查询接口获取任务的状态并且在作业到达最终完成态后取回对应的作业结果。

前提条件

●已开通服务并获得API-KEY：开通DashScope并创建API-KEY。

说明

接口限制：对单账户（含主账号与RAM子账号）任务下发接口限制QPS为2，并发任务数量限制为1。

作业提交接口调用

POST https://dashscope.aliyuncs.com/api/v1/services/aigc/wordart/surnames

入参描述

出参描述

请求示例

以下示例展示通过CURL命令来调用本模型的脚本。

# 自定义模式
curl --location 'https://dashscope.aliyuncs.com/api/v1/services/aigc/wordart/surnames' \
--header 'X-DashScope-Async: enable' \
--header 'Authorization: Bearer <YOUR_DASHSCOPE_API_KEY>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "model": "wordart-surnames",
    "input":{
        "text": {
            "font_name": "gufeng1",
            "ttf_url": null,
            "text_strength": 0.5,
            "text_inverse": False,
        },
        "surname": "赵",
        "style": "diy",
        "prompt": "高山，流水", 
        "ref_image_url": null,
    },
    "parameters": {
        "n": 1,
    }
}'


# 预设风格模式
curl --location 'https://dashscope.aliyuncs.com/api/v1/services/aigc/wordart/surnames' \
--header 'X-DashScope-Async: enable' \
--header 'Authorization: Bearer <YOUR_DASHSCOPE_API_KEY>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "model": "wordart-surnames",
    "input":{
        "surname": "赵",
        "style": "fantasy_pavilion",
    },
    "parameters": {
        "n": 1,
    }
}'

响应示例

{
    "output": {
		"task_id": "a8532587-fa8c-4ef8-82be-0c46b17950d1", 
    	"task_status": "PENDING"
    }
    "request_id": "7574ee8f-38a3-4b1e-9280-11c33ab46e51"
}

异常响应示例

在提交作业请求出错的情况下，输出的结果中会通过 code 和 message 指明出错原因。

{
    "code":"InvalidApiKey",
    "message":"Invalid API-key provided.",
    "request_id":"fb53c4ec-1c12-4fc4-a580-cdb7c3261fc1"
}

作业任务状态查询和结果获取接口

GET https://dashscope.aliyuncs.com/api/v1/tasks/{task_id}

入参描述

出参描述

请求示例

以下示例展示通过CURL命令来调用本模型的脚本。

curl -X GET \
--header 'Authorization: Bearer <YOUR-DASHSCOPE-API-KEY>' \
https://dashscope.aliyuncs.com/api/v1/tasks/86ecf553-d340-4e21-af6e-a0c6a421c010

响应示例（作业执行中）

作业提交后将处于排队状态，在得到调度之后将转为运行状态，此时作业的状态为RUNNING，task_metrics将给出具体batch状态；

{
    "request_id":"e5d70b02-ebd3-98ce-9fe8-759d7d7b107d",
    "output":{
        "task_id":"86ecf553-d340-4e21-af6e-a0c6a421c010",
        "task_status":"RUNNING",
        "task_metrics":{
            "TOTAL":1,
            "SUCCEEDED":1,
            "FAILED":0
        }
    }
}

响应示例（作业成功执行完毕）

如果作业执行完成并成功之后，再次查询作业状态，接口将在告知作业状态的同时，一并将作业的结果返回。对于本模型，作业在结束之后的状态会持续保留24小时以备客户随时查询，24小时之后，作业将从系统中清除，相关的结果也将一并清除；对应的，作业生成的结果为图像的URL地址，出于安全考虑，该URL的下载有效期也是24小时，需要用户在获取作业结果后根据需要及时使用或者转存。

{

    "output":{
        "task_id":"a8532587-fa8c-4ef8-82be-0c46b17950d1",
		"task_status":"SUCCEEDED",
        "results":[
            {
                "url":"https://xxx/1.jpg"
            },
            {
                "url":"https://xxx/2.jpg"
            },
            {
                "url":"https://xxx/3.jpg"
            },
            {
                "url":"https://xxx/4.jpg"
            }
        ]
    },
    "usage":{
        "image_count":4
    },
    "request_id":"7574ee8f-38a3-4b1e-9280-11c33ab46e51"
}

响应示例（作业失败）

如果因为某种原因作业失败，则作业状态会设置为FAILED，并且通过code和message字段指明错误原因。

{
    "request_id": "7574ee8f-38a3-4b1e-9280-11c33ab46e51"
  	"output": {
      "task_id": "a8532587-fa8c-4ef8-82be-0c46b17950d1", 
    	"task_status": "FAILED",
    	"code": "xxx", 
    	"message": "xxxxxx", 
    }  
}

状态码说明

DashScope灵积模型服务通用状态码请查阅：返回状态码说明

同时本模型还有如下特定错误码：