Skip to main content
POST
Upload an image

Authorizations

Authorization
string
header
required

A workspace API key: wdy_live_… / wdy_test_…. Created at POST /workspaces/{tenantId}/keys and shown exactly once.

Body

application/json
fileName
string
required

Original file name, e.g. "loaf.jpg". A label and the key seed, never a path.

Required string length: 1 - 200
data
string
required

The image file, base64-encoded. Raw base64 only (no data: prefix). The bytes decide the format (PNG/JPEG/WebP/GIF/AVIF).

key
string

Stable kebab-case id the agent emits. Defaults to a slug.

Maximum string length: 48
topics
array[]
Maximum array length: 8
agentId
object | null

The agent this belongs to; null/absent = the workspace pool.

Response

id
string
required
agentId
object | null
required

null = the workspace pool.

key
string
required

The stable key the agent emits to show it.

kind
string
required
mimeType
string
required
byteSize
number
required
orientation
string
required
topics
string[]
required
description
string
required

What the image SHOWS; the planner reads this.

alt
object
required
status
string
required

pending, ready, failed, …

url
string<uri>
required

A signed, short-lived URL. Never store it.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
width
number
height
number
error
string