Codia

Codia Open API

把 Codia Open API 安装进你的 AI Coding Agent

让 Codex、Claude、Cursor 和本地 Agent 工作流通过一个 CLI 调用图片转设计、PDF 转设计、PDF 转 PPT、去背景、图片生成、SVG 转换、credits 查询和调用明细。

Codia Open API 连接设计工具和 Agent 工作流

支持平台

一个包,覆盖多个 Agent 入口

把同一套 Codia API 包装安装到团队已经在使用的工具里。

Codex

把 Codia 图片、PDF 和设计 API 作为 Codex skill 安装,并支持本地认证。

Claude

把相同命令封装成可复用的 Claude skills,用于设计自动化任务。

Cursor

通过 Cursor rules 暴露 Codia API 命令,服务代码生成和设计到代码工作流。

能力

为 Agent 执行场景封装的设计 API

CLI 负责认证、上传、API 调用和 JSON 输出,Agent 可以专注完成用户任务。

图片转设计

把截图和 UI 图片转换成结构化、可编辑的设计数据。

PDF 转设计

从 PDF 文件中提取页面布局、文本和视觉结构。

PDF 转 PPT

从图片 PDF 和文档页面生成可编辑 PowerPoint。

去背景

为商品图、人像和创意素材生成干净的抠图结果。

图片生成

通过 Codia endpoint 生成、放大、编辑、重混和描述图片。

SVG 转换

把图片素材转换成适合设计和开发使用的 SVG。

结果

输入清晰,输出可被 Agent 继续使用

每个命令都明确对应一次 API 调用,并返回 Agent 可以继续读取的结构化结果。

输入

screenshot.png

命令

image-to-design --out design.json

输出

可编辑设计 JSON

输入

deck.pdf

命令

pdf-to-ppt --poll --out deck.json

输出

PPTX 下载 URL

输入

product.png

命令

remove-bg --out cutout.json

输出

透明素材 URL

安装

几条命令完成接入,并确认 credits 可用

安装 CLI,绑定 Open API key,为 Codex、Claude、Cursor 安装模板,然后用 credits 查询验证连接。

1

安装 CLI

使用 npm 安装跨平台的 codia-design 命令。

2

绑定 API 访问权限

device-flow 可用时使用浏览器登录,也可以直接绑定已有 Codia Open API key。

3

安装 Skill 模板

把平台对应的 skill 文件复制到 Codex、Claude、Cursor 或全部目标。

terminal
$ npm install -g @codia/design-skills$ codia-design auth set --api-key api_key_xxx$ codia-design install --platform all$ codia-design credits

计费

所有命令共用一个 Open API credits 余额

Codia Open API 使用统一的 Open API credits SKU。用户只需购买或订阅一次,即可在所有公开 API 能力之间通用。

统一 SKU

图片、PDF、PPT、SVG 和去背景 API 共用同一个余额。

用量可见

可以从 CLI 或 Dashboard 查询剩余 credits 和调用明细。

自动充值

可选的自动充值设置可以避免生产 Agent 工作流中断。

常用计费命令
codia-design creditscodia-design usage --page 1 --page_size 20codia-design auto-recharge set --enabled true --threshold 100 --credits 1000 --monthly_max 5000

工作流

面向常见设计任务的 Agent 命令

每个命令都返回结构化 JSON,并支持把大结果写入文件供后续步骤使用。

codia-design image-to-design

把 UI 截图转成 DSL

Agent 可以读取截图,调用 Codia,并把返回的设计结构继续用于代码或 PPT 生成。

codia-design pdf-to-ppt --poll

把 PDF 转成可编辑幻灯片

长耗时转换任务可以由 CLI 轮询,并保存成可复用输出。

codia-design remove-bg

处理商品和创意素材

本地文件会自动上传,结果可以继续进入设计或内容生产链路。

FAQ

团队接入前需要知道的事

Skills 是 Codia Open API 之上的本地封装层。

我需要 Codia API key 吗?

需要。device-flow auth 可用时可以浏览器登录,也可以使用 codia-design auth set --api-key 绑定已有 Open API key。

支持哪些平台?

当前包内置 Codex、Claude、Cursor 模板,并由同一个 CLI 提供底层能力。

credits 在不同 API 间通用吗?

通用。公开 Open API 调用都会从统一的 Codia Open API 余额中扣除。

Agent 可以使用本地图片和 PDF 吗?

可以。CLI 会先上传支持的本地文件,再调用目标 endpoint。

这和 REST API 有什么区别?

它封装的是同一套 Codia Open API,只是额外提供命令和 skill 指令,方便本地 AI Agent 安全调用。

给你的 Agent 装上设计 API 工具箱

创建 API key,安装 skill package,让本地 Agent 在写代码和文档的同一工作流里调用 Codia API。