Photoroom

[LEGACY] Image Editing v1 (Plus plan)

Production server (Plus plan)

GET

/v1/render

Render an image using a template. A detailed tutorial is available here

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://image-api.photoroom.com/v1/render?templateId' \
--header 'x-api-key;'

响应示例

200 - 示例 1

{}

请求参数

Query 参数

apiKey

string

API Key

可选

The API key to authenticate the request

示例值:

4a5b60936c3a934hqb3cf5838b390dc3d4dfc9da

templateId

string

Template ID

必需

The ID of the template to render

示例值:

592dd982-4a1b-4cd9-ab11-21481d5a0064

imageUrl

string <uri>

Image URL

可选

The image URL to render

示例值:

https://s3.amazonaws.com/a.storyblok.com/f/191576/1024x1024/d25e1a99d7/sample-05.png

conceptUrl

string <uri>

Concept URL

已废弃

Deprecated, use imageUrl instead.

示例值:

https://s3.amazonaws.com/a.storyblok.com/f/191576/1024x1024/d25e1a99d7/sample-05.png

Header 参数

x-api-key

string

必需

返回响应

🟢200OK

application/json

Body

object {0}

🟠400Bad Request

🟠402Payment Required

🔴500Internal Server Error

修改于 2024-04-17 06:52:37

Image Editing v2 (Plus plan)

[LEGACY] Image Editing v1 (Plus plan)