Nephh External API

外部 API 文档

通过 API Token 调用奶芙的图片和视频生成能力。API 生成使用独立的 API 积分,与网页端共用存储额度、模型配置和并发限制。

用户指南

登录奶芙后,在「用户中心 → 通用设置 → API 密钥」创建和管理 Token。你可以查看明文 Token, 也可以编辑名称、重置、停用、启用或删除密钥。

  • 所有外部 API 请求都需要携带 Bearer Token。
  • 图片模型单次输出 1 张图片,视频模型单次输出 1 个视频。
  • API 积分可在个人中心的 API 密钥页面按金额直购,沿用积分直购兑换比例,有效期一年。生成任务先冻结,成功扣款、失败释放;余额不足不创建任务。查询接口不消耗积分。
  • 查询结果返回 1 小时有效的下载地址,过期后重新查询任务即可获得新的地址。
Authorization
Text
Authorization: Bearer 550e8400e29b41d4a716446655440000

上传素材

上传图片或视频后会返回账户素材 ID,提交生成任务时可通过 assetId 引用。

  • 图片支持 PNG / JPG / JPEG / WebP,单个文件不能超过 10 MB。
  • 视频支持 MP4 / MOV,单个文件不能超过 30 MB,时长不能超过 60 秒。
  • 音频支持 MP3 / WAV / M4A,单个文件不能超过 10 MB,时长不能超过 15 分钟。
  • 通过公网 URL 引用素材时,同样适用以上格式、大小和音视频时长限制。
cURL
Bash
curl -X POST "https://nephh.com/api/v1/assets/upload" \
  -H "Authorization: Bearer 550e8400e29b41d4a716446655440000" \
  -F "file=@./reference.png"
返回结果
JSON
{
  "ok": true,
  "data": {
    "assetId": "cmrxxx",
    "mimeType": "image/png",
    "size": 123456
  }
}

查询结果

输出 URL 是 COS 签名地址,有效期 1 小时。过期后重新查询任务即可获得新的地址。

cURL
Bash
curl "https://nephh.com/api/v1/generations/cmr_api_job_xxx" \
  -H "Authorization: Bearer 550e8400e29b41d4a716446655440000"
返回结果
JSON
{
  "ok": true,
  "data": {
    "taskId": "cmr_api_job_xxx",
    "type": "image",
    "status": "succeeded",
    "progress": 100,
    "error": null,
    "outputs": [
      {
        "assetId": "cmrxxx",
        "title": "生成图片",
        "mimeType": "image/png",
        "url": "https://cos-signed-url...",
        "expiresInSeconds": 3600
      }
    ]
  }
}

清理空间

按文件类型、来源和时间清理账户历史素材,与网页端「文件管理 → 删除历史文件」共用同一套规则, 同样计入账号的存储额度。建议先用 GET 检索可清理数量,确认后再用 POST 执行删除。 删除为硬删除、不可恢复;运行中任务正在使用的素材会自动跳过。

  • kind:ALL / IMAGE / VIDEO / AUDIO,默认 ALL。
  • source:ALL / generated(创作)/ uploaded(上传),默认 ALL。
  • age:ALL / 3d / 7d / 30d,表示「该时间之前」的历史文件,默认 ALL。
  • GET 通过查询参数传值;POST 仅接受 JSON 请求体中的筛选条件,不支持查询参数。
  • POST 至少需提供一个筛选字段,未提供的字段使用上述默认值;清理全部文件时请显式传入 {"kind":"ALL","source":"ALL","age":"ALL"}。
  • 空请求体、空对象、错误类型、空字符串或未知字段返回 400,不执行删除。
检索数量(cURL)
Bash
curl "https://nephh.com/api/v1/storage/cleanup?kind=IMAGE&age=30d" \
  -H "Authorization: Bearer 550e8400e29b41d4a716446655440000"
执行删除(cURL)
Bash
curl --request POST \
  --url https://nephh.com/api/v1/storage/cleanup \
  --header 'Authorization: Bearer 550e8400e29b41d4a716446655440000' \
  --header 'Content-Type: application/json' \
  --data '{
    "kind": "IMAGE",
    "source": "ALL",
    "age": "30d"
}'
返回结果
JSON
{
  "ok": true,
  "data": {
    "mode": "delete",
    "filters": { "kind": "IMAGE", "source": "ALL", "age": "30d" },
    "summary": {
      "totalCount": 128,
      "imageCount": 128,
      "videoCount": 0,
      "audioCount": 0,
      "totalBytes": 536870912,
      "sampleTitles": ["生成图片-1", "生成图片-2", "生成图片-3", "生成图片-4"],
      "matchedCount": 130,
      "skippedRunningCount": 2
    }
  }
}

totalCount 为本次实际删除的素材数,matchedCount 为命中条件的总数, 二者之差即被自动跳过的运行中素材(skippedRunningCount)。GET 预览时不产生删除。

错误码

  • 400:参数错误、素材格式不支持、素材地址不可用。
  • 401:缺少 Token 或 Token 无效。
  • 403:账号被禁用或无权访问。
  • 404:任务或素材不存在。
  • 413:上传素材超过图片、视频或音频大小限制。
  • 429:触发提交、上传或查询限流。

公网素材地址只允许 HTTP/HTTPS,不能指向 localhost、内网地址或保留网段。

图像系列

NPT image 2-B

最强模型

POST/api/v1/image/generations

Request Body

modelIdstring必填
npt_image2
promptstring必填
提示词内容。
aspectRatiostring必填
可选:1:1 / 2:3 / 3:2 / 4:5 / 5:4 / 4:3 / 3:4 / 16:9 / 9:16 / 21:9 / 9:21 / 2:1 / 1:2 / 3:1 / 1:3,默认 1:1
resolutionstring必填
可选:1K / 2k / 4k,默认 1K
referenceImageAssetIdsstring[]
账户图片素材 ID,最多 10 个
referenceImageUrlsstring[]
公网图片 URL,最多 10 个,支持 PNG/JPG/JPEG/WebP
图像系列

Nenana

质量速度比较均衡,推荐

POST/api/v1/image/generations

Request Body

modelIdstring必填
nenana_v1
promptstring必填
提示词内容。
aspectRatiostring必填
可选:auto / 1:1 / 16:9 / 9:16 / 4:3 / 3:4 / 3:2 / 2:3 / 5:4 / 4:5 / 21:9,默认 1:1
resolutionstring必填
可选:1K / 2K / 4k,默认 1K
referenceImageAssetIdsstring[]
账户图片素材 ID,最多 5 个
referenceImageUrlsstring[]
公网图片 URL,最多 5 个,支持 PNG/JPG/JPEG/WebP
图像系列

Nenana 2

基于高能效视觉引擎的图生图与图像编辑

POST/api/v1/image/generations

Request Body

modelIdstring必填
nenana_v2
promptstring必填
提示词内容。
aspectRatiostring必填
可选:1:1 / 16:9 / 9:16 / 4:3 / 3:4 / 3:2 / 2:3 / 5:4 / 4:5 / 21:9 / 1:4 / 4:1,默认 1:1
resolutionstring必填
可选:1K / 2K / 4K,默认 2K
referenceImageAssetIdsstring[]
账户图片素材 ID,最多 10 个
referenceImageUrlsstring[]
公网图片 URL,最多 10 个,支持 PNG/JPG/JPEG/WebP
图像系列

Nenana 2 Lite

快速低价的高质量图像模型

POST/api/v1/image/generations

Request Body

modelIdstring必填
nenana_v2_lite
promptstring必填
提示词内容。
aspectRatiostring必填
可选:1:1 / 16:9 / 9:16 / 4:3 / 3:4 / 3:2 / 2:3 / 5:4 / 4:5 / 21:9 / 1:4 / 4:1,默认 1:1
resolutionstring必填
可选:1K,默认 1K
referenceImageAssetIdsstring[]
账户图片素材 ID,最多 10 个
referenceImageUrlsstring[]
公网图片 URL,最多 10 个,支持 PNG/JPG/JPEG/WebP
图像系列

Nenana PRO

支持专业级图像编辑并实现 4K 超清画质

POST/api/v1/image/generations

Request Body

modelIdstring必填
nenana_pro
promptstring必填
提示词内容。
aspectRatiostring必填
可选:1:1 / 16:9 / 9:16 / 4:3 / 3:4 / 3:2 / 2:3 / 5:4 / 4:5 / 21:9,默认 1:1
resolutionstring必填
可选:1K / 2K / 4K,默认 1K
referenceImageAssetIdsstring[]
账户图片素材 ID,最多 10 个
referenceImageUrlsstring[]
公网图片 URL,最多 10 个,支持 PNG/JPG/JPEG/WebP
图像系列

SeeDream 5.0 Pro

字节跳动最强大的图像编辑

POST/api/v1/image/generations

Request Body

modelIdstring必填
seedream_5.0pro
promptstring必填
提示词内容。
aspectRatiostring必填
可选:1:1 / 4:3 / 3:4 / 16:9 / 9:16 / 3:2 / 2:3 / 21:9,默认 4:3
resolutionstring必填
可选:1K / 2K,默认 2K
referenceImageAssetIdsstring[]
账户图片素材 ID,最多 6 个
referenceImageUrlsstring[]
公网图片 URL,最多 6 个,支持 PNG/JPG/JPEG/WebP
图像系列

Midjourney V8

极具艺术能力的图像模型

POST/api/v1/image/generations

Request Body

modelIdstring必填
midjoruney_v8.1
promptstring必填
提示词内容。
aspectRatiostring必填
可选:1:1 / 4:3 / 3:2 / 16:9 / 3:4 / 2:3 / 9:16,默认 1:1
resolutionstring必填
可选:1k / 2k,默认 1k
referenceImageAssetIdsstring[]
账户图片素材 ID,最多 1 个
referenceImageUrlsstring[]
公网图片 URL,最多 1 个,支持 PNG/JPG/JPEG/WebP
视频系列

NeGrok Video 1.5

专注于将灵感转化为极具动感的视觉现实

POST/api/v1/video/generations

Request Body

modelIdstring必填
negrok_video_1.5
promptstring必填
提示词内容。
inputModestring
可选:reference(参考模式),默认 reference(参考模式)
aspectRatiostring必填
可选:16:9 / 9:16 / 1:1 / 3:2 / 2:3,默认 16:9
qualitystring必填
可选:480p / 720p,默认 720p
durationstring必填
可选:6s / 7s / 8s / 9s / 10s / 11s / 12s / 13s / 14s / 15s,默认 6s
endFrameAssetIdstring
尾帧账户图片素材 ID
endFrameUrlstring
尾帧公网图片 URL,和 endFrameAssetId 二选一
referenceImageAssetIdsstring[]
参考模式:账户图片素材 ID,最多 7 个
referenceImageUrlsstring[]
参考模式:公网图片 URL,最多 7 个
视频系列

Seedance 1.5 Pro

高质量视频生成,支持音频

POST/api/v1/video/generations

Request Body

modelIdstring必填
seedance_1.5pro
promptstring必填
提示词内容。
inputModestring
可选:frame(首尾帧模式),默认 frame(首尾帧模式)
aspectRatiostring必填
可选:16:9 / 4:3 / 1:1 / 3:4 / 9:16 / 21:9,默认 16:9
qualitystring必填
可选:480p / 720p / 1080p,默认 720p
durationstring必填
可选:4s / 5s / 6s / 7s / 8s / 9s / 10s / 11s / 12s,默认 4s
withAudioboolean
可选:true / false,默认 false
startFrameAssetIdstring
首帧账户图片素材 ID
startFrameUrlstring
首帧公网图片 URL,和 startFrameAssetId 二选一
endFrameAssetIdstring
尾帧账户图片素材 ID
endFrameUrlstring
尾帧公网图片 URL,和 endFrameAssetId 二选一
视频系列

Seedance 2.0

即梦最强多模态参考视频模型

POST/api/v1/video/generations

Request Body

modelIdstring必填
seedance_2.0
promptstring必填
提示词内容。
inputModestring
可选:frame(首尾帧模式) / reference(参考模式),默认 frame(首尾帧模式)
aspectRatiostring必填
可选:16:9 / 4:3 / 1:1 / 3:4 / 9:16 / 21:9,默认 16:9
qualitystring必填
可选:480p / 720p / 1080p,默认 480p
durationstring必填
可选:4s / 5s / 6s / 7s / 8s / 9s / 10s / 11s / 12s / 13s / 14s / 15s,默认 5s
withAudioboolean
可选:true / false,默认 true
startFrameAssetIdstring
首帧账户图片素材 ID
startFrameUrlstring
首帧公网图片 URL,和 startFrameAssetId 二选一
endFrameAssetIdstring
尾帧账户图片素材 ID
endFrameUrlstring
尾帧公网图片 URL,和 endFrameAssetId 二选一
referenceImageAssetIdsstring[]
参考模式:账户图片素材 ID,最多 9 个
referenceImageUrlsstring[]
参考模式:公网图片 URL,最多 9 个
referenceVideoAssetIdsstring[]
参考模式:账户视频素材 ID,最多 9 个
referenceVideoUrlsstring[]
参考模式:公网视频 URL,最多 9 个
referenceAudioAssetIdsstring[]
参考模式:账户音频素材 ID,最多 9 个
referenceAudioUrlsstring[]
参考模式:公网音频 URL,最多 9 个
视频系列

Seedance 2.0 Fast

即梦快速多模态参考视频模型

POST/api/v1/video/generations

Request Body

modelIdstring必填
seedance_2.0_fast
promptstring必填
提示词内容。
inputModestring
可选:frame(首尾帧模式) / reference(参考模式),默认 frame(首尾帧模式)
aspectRatiostring必填
可选:16:9 / 4:3 / 1:1 / 3:4 / 9:16 / 21:9,默认 16:9
qualitystring必填
可选:480p / 720p,默认 480p
durationstring必填
可选:4s / 5s / 6s / 7s / 8s / 9s / 10s / 11s / 12s / 13s / 14s / 15s,默认 5s
withAudioboolean
可选:true / false,默认 true
startFrameAssetIdstring
首帧账户图片素材 ID
startFrameUrlstring
首帧公网图片 URL,和 startFrameAssetId 二选一
endFrameAssetIdstring
尾帧账户图片素材 ID
endFrameUrlstring
尾帧公网图片 URL,和 endFrameAssetId 二选一
referenceImageAssetIdsstring[]
参考模式:账户图片素材 ID,最多 9 个
referenceImageUrlsstring[]
参考模式:公网图片 URL,最多 9 个
referenceVideoAssetIdsstring[]
参考模式:账户视频素材 ID,最多 9 个
referenceVideoUrlsstring[]
参考模式:公网视频 URL,最多 9 个
referenceAudioAssetIdsstring[]
参考模式:账户音频素材 ID,最多 9 个
referenceAudioUrlsstring[]
参考模式:公网音频 URL,最多 9 个
视频系列

Seedance 2.0 Mini

即梦低价多模态参考视频模型

POST/api/v1/video/generations

Request Body

modelIdstring必填
seedance_2.0_mini
promptstring必填
提示词内容。
inputModestring
可选:frame(首尾帧模式) / reference(参考模式),默认 frame(首尾帧模式)
aspectRatiostring必填
可选:16:9 / 4:3 / 1:1 / 3:4 / 9:16 / 21:9,默认 16:9
qualitystring必填
可选:480p / 720p,默认 480p
durationstring必填
可选:4s / 5s / 6s / 7s / 8s / 9s / 10s / 11s / 12s / 13s / 14s / 15s,默认 5s
withAudioboolean
可选:true / false,默认 true
startFrameAssetIdstring
首帧账户图片素材 ID
startFrameUrlstring
首帧公网图片 URL,和 startFrameAssetId 二选一
endFrameAssetIdstring
尾帧账户图片素材 ID
endFrameUrlstring
尾帧公网图片 URL,和 endFrameAssetId 二选一
referenceImageAssetIdsstring[]
参考模式:账户图片素材 ID,最多 9 个
referenceImageUrlsstring[]
参考模式:公网图片 URL,最多 9 个
referenceVideoAssetIdsstring[]
参考模式:账户视频素材 ID,最多 9 个
referenceVideoUrlsstring[]
参考模式:公网视频 URL,最多 9 个
referenceAudioAssetIdsstring[]
参考模式:账户音频素材 ID,最多 9 个
referenceAudioUrlsstring[]
参考模式:公网音频 URL,最多 9 个
视频系列

HappyHorse 1.0

阿里最新视频模型

POST/api/v1/video/generations

Request Body

modelIdstring必填
happyhorse_v1.0
promptstring必填
提示词内容。
inputModestring
可选:frame(首尾帧模式) / reference(参考模式),默认 reference(参考模式)
aspectRatiostring必填
可选:16:9 / 4:3 / 1:1 / 3:4 / 9:16,默认 16:9
qualitystring必填
可选:720p / 1080p,默认 720p
durationstring必填
可选:3s / 4s / 5s / 6s / 7s / 8s / 9s / 10s / 11s / 12s / 13s / 14s / 15s,默认 3s
startFrameAssetIdstring
首帧账户图片素材 ID
startFrameUrlstring
首帧公网图片 URL,和 startFrameAssetId 二选一
endFrameAssetIdstring
尾帧账户图片素材 ID
endFrameUrlstring
尾帧公网图片 URL,和 endFrameAssetId 二选一
referenceImageAssetIdsstring[]
参考模式:账户图片素材 ID,最多 9 个
referenceImageUrlsstring[]
参考模式:公网图片 URL,最多 9 个
视频系列

Kling o3

可灵最新旗舰视频模型

POST/api/v1/video/generations

Request Body

modelIdstring必填
kling_o3
promptstring必填
提示词内容。
inputModestring
可选:frame(首尾帧模式) / reference(参考模式),默认 frame(首尾帧模式)
aspectRatiostring必填
可选:16:9 / 9:16 / 1:1,默认 16:9
qualitystring必填
可选:720p / 1080p,默认 720p
durationstring必填
可选:3s / 4s / 5s / 6s / 7s / 8s / 9s / 10s / 11s / 12s / 13s / 14s / 15s,默认 3s
withAudioboolean
可选:true / false,默认 false
startFrameAssetIdstring
首帧账户图片素材 ID
startFrameUrlstring
首帧公网图片 URL,和 startFrameAssetId 二选一
endFrameAssetIdstring
尾帧账户图片素材 ID
endFrameUrlstring
尾帧公网图片 URL,和 endFrameAssetId 二选一
referenceImageAssetIdsstring[]
参考模式:账户图片素材 ID,最多 7 个
referenceImageUrlsstring[]
参考模式:公网图片 URL,最多 7 个
referenceVideoAssetIdsstring[]
参考模式:账户视频素材 ID,最多 1 个
referenceVideoUrlsstring[]
参考模式:公网视频 URL,最多 1 个