Appearance
graphic-designer
6 endpoints.
POST /api/v1/graphic-designer/generate
Generate
Request body
json
{
"properties": {
"design_type": {
"type": "string",
"title": "Design Type"
},
"channel": {
"type": "string",
"title": "Channel",
"default": "web"
},
"aspect_ratio": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Aspect Ratio",
"default": "1:1"
},
"prompt": {
"type": "string",
"title": "Prompt"
}
},
"type": "object",
"required": [
"design_type",
"prompt"
],
"title": "GenerateRequest"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/graphic-designer/chat
Chat
Request body
json
{
"properties": {
"message": {
"type": "string",
"title": "Message",
"default": ""
},
"input_images": {
"items": {
"type": "string"
},
"type": "array",
"title": "Input Images",
"default": []
},
"aspect_ratio": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Aspect Ratio"
},
"image_labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Image Labels",
"default": []
}
},
"type": "object",
"title": "ChatRequest"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/graphic-designer/designs
List Designs
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
design_type | query | no | ||
channel | query | no | ||
limit | query | no | integer |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/graphic-designer/designs
Save Design
Request body
json
{
"properties": {
"image_b64": {
"type": "string",
"title": "Image B64"
},
"design_type": {
"type": "string",
"title": "Design Type"
},
"channel": {
"type": "string",
"title": "Channel",
"default": "web"
},
"aspect_ratio": {
"type": "string",
"title": "Aspect Ratio",
"default": "1:1"
},
"prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Prompt"
}
},
"type": "object",
"required": [
"image_b64",
"design_type"
],
"title": "SaveRequest"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}DELETE /api/v1/graphic-designer/designs/{design_id}
Delete Design
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
design_id | path | yes | integer |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/graphic-designer/designs/{design_id}/publish
Publish Design
Uploads the saved design to the given Meta ad account's image library and returns a Create Ad (AI) deep link with it preloaded. Account choice comes from the existing GET /social/accounts list — no new account model.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
design_id | path | yes | integer | |
account_id | query | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}