Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"transition_style"
],
"properties": {
"image": {
"type": "object",
"required": [
"download_url",
"file_id"
],
"properties": {
"file_id": {
"type": "string",
"minLength": 1
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"download_url": {
"type": "string",
"format": "uri",
"description": "A temporary HTTPS download URL supplied by the host. Never construct this from a local path."
}
},
"description": "The room image attached by the user. Do not ask the user for file metadata.",
"additionalProperties": false
},
"end_image": {
"type": "object",
"required": [
"download_url",
"file_id"
],
"properties": {
"file_id": {
"type": "string",
"minLength": 1
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"download_url": {
"type": "string",
"format": "uri",
"description": "A temporary HTTPS download URL supplied by the host. Never construct this from a local path."
}
},
"description": "The transition end image attached by the user. Do not ask the user for file metadata.",
"additionalProperties": false
},
"image_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"anyOf": [
{
"type": "string",
"maxLength": 13981144,
"description": "A complete data:image/jpeg, data:image/png, or data:image/webp base64 URI supplied by the client."
},
{
"type": "object",
"required": [
"media_type",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"type": {
"type": "string",
"const": "base64"
},
"media_type": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"mime_type",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"mime_type": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"mimeType",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"type": {
"type": "string",
"const": "image"
},
"mimeType": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"source"
],
"properties": {
"type": {
"type": "string",
"const": "image"
},
"source": {
"type": "object",
"required": [
"type",
"media_type",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"type": {
"type": "string",
"const": "base64"
},
"media_type": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}
],
"description": "A link or inline copy of the room image supplied by the client."
},
"end_image_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"anyOf": [
{
"type": "string",
"maxLength": 13981144,
"description": "A complete data:image/jpeg, data:image/png, or data:image/webp base64 URI supplied by the client."
},
{
"type": "object",
"required": [
"media_type",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"type": {
"type": "string",
"const": "base64"
},
"media_type": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"mime_type",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"mime_type": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"mimeType",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"type": {
"type": "string",
"const": "image"
},
"mimeType": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"source"
],
"properties": {
"type": {
"type": "string",
"const": "image"
},
"source": {
"type": "object",
"required": [
"type",
"media_type",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"type": {
"type": "string",
"const": "base64"
},
"media_type": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}
],
"description": "A link or inline copy of the transition end image supplied by the client."
},
"duration_seconds": {
"anyOf": [
{
"type": "number",
"const": 5
},
{
"type": "number",
"const": 10
}
],
"description": "The workspace offers 5 or 10 seconds. Omit unless the user requests one; the default is 5 seconds."
},
"transition_style": {
"type": "string",
"maxLength": 5000,
"minLength": 2,
"description": "How the start image should transform into the end image, such as a timelapse, falling into place, assembling, or a custom description."
},
"additional_instructions": {
"type": "string",
"maxLength": 2000,
"description": "Optional user preferences stated in natural language. Do not ask for this when the request is already clear."
}
}
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"room_type",
"furniture_item"
],
"properties": {
"image": {
"type": "object",
"required": [
"download_url",
"file_id"
],
"properties": {
"file_id": {
"type": "string",
"minLength": 1
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"download_url": {
"type": "string",
"format": "uri",
"description": "A temporary HTTPS download URL supplied by the host. Never construct this from a local path."
}
},
"description": "The room image attached by the user. Do not ask the user for file metadata.",
"additionalProperties": false
},
"image_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"anyOf": [
{
"type": "string",
"maxLength": 13981144,
"description": "A complete data:image/jpeg, data:image/png, or data:image/webp base64 URI supplied by the client."
},
{
"type": "object",
"required": [
"media_type",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"type": {
"type": "string",
"const": "base64"
},
"media_type": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"mime_type",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"mime_type": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"mimeType",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"type": {
"type": "string",
"const": "image"
},
"mimeType": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"source"
],
"properties": {
"type": {
"type": "string",
"const": "image"
},
"source": {
"type": "object",
"required": [
"type",
"media_type",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"type": {
"type": "string",
"const": "base64"
},
"media_type": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}
],
"description": "A link or inline copy of the room image supplied by the client."
},
"room_type": {
"type": "string",
"maxLength": 100,
"minLength": 2,
"description": "Room type, such as living room, bedroom, kitchen, bathroom, dining room, or office."
},
"furniture_item": {
"type": "string",
"maxLength": 120,
"minLength": 2,
"description": "Furniture item to replace, such as sofa, bed, chair, or table."
},
"reference_image": {
"type": "object",
"required": [
"download_url",
"file_id"
],
"properties": {
"file_id": {
"type": "string",
"minLength": 1
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"download_url": {
"type": "string",
"format": "uri",
"description": "A temporary HTTPS download URL supplied by the host. Never construct this from a local path."
}
},
"description": "The reference image attached by the user. Do not ask the user for file metadata.",
"additionalProperties": false
},
"reference_image_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"anyOf": [
{
"type": "string",
"maxLength": 13981144,
"description": "A complete data:image/jpeg, data:image/png, or data:image/webp base64 URI supplied by the client."
},
{
"type": "object",
"required": [
"media_type",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"type": {
"type": "string",
"const": "base64"
},
"media_type": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"mime_type",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"mime_type": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"mimeType",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"type": {
"type": "string",
"const": "image"
},
"mimeType": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"source"
],
"properties": {
"type": {
"type": "string",
"const": "image"
},
"source": {
"type": "object",
"required": [
"type",
"media_type",
"data"
],
"properties": {
"data": {
"type": "string",
"maxLength": 13981080,
"minLength": 4,
"description": "The existing base64 image bytes. Pass them unchanged; do not regenerate or summarize them."
},
"type": {
"type": "string",
"const": "base64"
},
"media_type": {
"enum": [
"image/jpeg",
"image/png",
"image/webp"
],
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}
],
"description": "A link or inline copy of the reference image supplied by the client."
},
"additional_instructions": {
"type": "string",
"maxLength": 2000,
"description": "Optional user preferences stated in natural language. Do not ask for this when the request is already clear."
}
}
}