Skip to content

logo-editor ​

← All modules

64 endpoints.

GET /api/v1/logo-editor/designs ​

List Designs

The library's live designs; archived=true the archived ones instead ("delete must archive, not delete" - owner 2026-10-27). Archived designs keep their row, thumbnail and scene, and come back with /restore.

Parameters

NameInRequiredTypeDescription
archivedquerynoboolean

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/logo-editor/designs ​

Create Design

Request body

json
{
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 160
        },
        {
          "type": "null"
        }
      ],
      "title": "Name"
    },
    "width": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 8000,
          "minimum": 16
        },
        {
          "type": "null"
        }
      ],
      "title": "Width"
    },
    "height": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 8000,
          "minimum": 16
        },
        {
          "type": "null"
        }
      ],
      "title": "Height"
    },
    "scene": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Scene"
    },
    "thumbnail": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Thumbnail"
    },
    "brand_kit_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Brand Kit Id"
    },
    "folder_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Folder Id"
    }
  },
  "type": "object",
  "title": "DesignIn"
}

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/logo-editor/designs/order ​

Order Designs

Sort logos by hand: ids in the order they should show (one folder's, or the unfiled ones). Ids that are not this tenant's live logos are ignored.

Request body

json
{
  "properties": {
    "ids": {
      "items": {
        "type": "integer"
      },
      "type": "array",
      "maxItems": 2000,
      "title": "Ids"
    }
  },
  "type": "object",
  "required": [
    "ids"
  ],
  "title": "DesignOrderIn"
}

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/logo-editor/designs/{design_id} ​

Get Design

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

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"
}

PATCH /api/v1/logo-editor/designs/{design_id} ​

Update Design

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

Request body

json
{
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 160
        },
        {
          "type": "null"
        }
      ],
      "title": "Name"
    },
    "width": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 8000,
          "minimum": 16
        },
        {
          "type": "null"
        }
      ],
      "title": "Width"
    },
    "height": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 8000,
          "minimum": 16
        },
        {
          "type": "null"
        }
      ],
      "title": "Height"
    },
    "scene": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Scene"
    },
    "thumbnail": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Thumbnail"
    },
    "brand_kit_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Brand Kit Id"
    },
    "folder_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Folder Id"
    }
  },
  "type": "object",
  "title": "DesignIn"
}

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/logo-editor/designs/{design_id} ​

Delete Design

Archive it, never destroy it (owner 2026-10-27: "delete must archive, not delete"). The row, its scene, thumbnail and files stay; it leaves the library and comes back with /restore.

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

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/logo-editor/designs/{design_id}/duplicate ​

Duplicate Design

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

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/logo-editor/designs/{design_id}/restore ​

Restore Design

Take an archived design back into the library, in the folder it was in.

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

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/logo-editor/folders ​

List Folders

Folders with how many live logos each holds. The Brands folder always exists and is always listed first.

200 — Successful Response

json
{}

POST /api/v1/logo-editor/folders ​

Create Folder

Request body

json
{
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "title": "Name"
    },
    "sort_order": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sort Order"
    }
  },
  "type": "object",
  "required": [
    "name"
  ],
  "title": "FolderIn"
}

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"
}

PATCH /api/v1/logo-editor/folders/{folder_id} ​

Rename Folder

Parameters

NameInRequiredTypeDescription
folder_idpathyesinteger

Request body

json
{
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "title": "Name"
    },
    "sort_order": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sort Order"
    }
  },
  "type": "object",
  "required": [
    "name"
  ],
  "title": "FolderIn"
}

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/logo-editor/folders/{folder_id} ​

Delete Folder

Removes the folder only: its logos become unfiled, never deleted.

Parameters

NameInRequiredTypeDescription
folder_idpathyesinteger

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/logo-editor/assets ​

List Assets

200 — Successful Response

json
{}

POST /api/v1/logo-editor/assets ​

Upload Asset

Request body

json
{
  "properties": {
    "image_b64": {
      "type": "string",
      "title": "Image B64"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Name"
    }
  },
  "type": "object",
  "required": [
    "image_b64"
  ],
  "title": "UploadIn"
}

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/logo-editor/assets/{uuid_hex}/file ​

Asset File

Parameters

NameInRequiredTypeDescription
uuid_hexpathyesstring

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/logo-editor/assets/{uuid_hex} ​

Delete Asset

Parameters

NameInRequiredTypeDescription
uuid_hexpathyesstring

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/logo-editor/import ​

Import File

A file (SVG, PDF, image, or Canva's multi-page zip) as new logos: one per image/page, each on an artboard sized to it, the file stored as a placed image. The editor finishes the job on first open: the scene's pendingImport names the asset to lay onto the artboard (as shapes, or as one picture when picture - see svc.is_layered_picture).

Request body

json
{
  "properties": {
    "file_b64": {
      "type": "string",
      "title": "File B64"
    },
    "name": {
      "type": "string",
      "maxLength": 255,
      "title": "Name",
      "default": ""
    },
    "folder_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Folder Id"
    }
  },
  "type": "object",
  "required": [
    "file_b64"
  ],
  "title": "ImportIn"
}

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/logo-editor/fonts ​

List Fonts

The site's font library (fonts brought in by imports), for the editor's font list. full: the whole font; else only the letters the imported designs used (a licensed face Google does not carry).

200 — Successful Response

json
{}

POST /api/v1/logo-editor/fonts ​

Upload Font

A whole font file the user is licensed to use (TTF/OTF). It joins the library under its own PostScript name and REPLACES any copy of that name (an import's partial font - only the letters the Canva design used): those rows are superseded and every design set in them is switched to the upload, so typed letters the partial lacked render. replaced lists the old ids, for the open design to switch too.

Request body

json
{
  "properties": {
    "file_b64": {
      "type": "string",
      "title": "File B64"
    },
    "file_name": {
      "type": "string",
      "title": "File Name",
      "default": ""
    }
  },
  "type": "object",
  "required": [
    "file_b64"
  ],
  "title": "FontUploadIn"
}

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/logo-editor/google-fonts ​

Google Fonts

Every Google Fonts family with its variants, most popular first.

200 — Successful Response

json
{}

GET /api/v1/logo-editor/google-fonts/file/{token}.ttf ​

Google Font File

Parameters

NameInRequiredTypeDescription
tokenpathyesstring

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/logo-editor/font-pack ​

Font Pack

The installed font pack, shared by every site.

200 — Successful Response

json
{}

GET /api/v1/logo-editor/font-pack/file/{token} ​

Font Pack File

Parameters

NameInRequiredTypeDescription
tokenpathyesstring

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"
}

Icon Search

Parameters

NameInRequiredTypeDescription
qquerynostring

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/logo-editor/icon-svgs ​

Icon Svgs

Previews: name -> SVG for up to 200 icons in one call.

Request body

json
{
  "properties": {
    "names": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Names",
      "default": []
    }
  },
  "type": "object",
  "title": "IconBatchIn"
}

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/logo-editor/icon-svg ​

Icon Svg

Parameters

NameInRequiredTypeDescription
namequeryyesstring

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/logo-editor/cutout ​

Cutout

Request body

json
{
  "properties": {
    "asset": {
      "type": "string",
      "title": "Asset"
    },
    "mode": {
      "type": "string",
      "title": "Mode",
      "default": "flat"
    },
    "tolerance": {
      "type": "integer",
      "maximum": 200,
      "minimum": 1,
      "title": "Tolerance",
      "default": 32
    }
  },
  "type": "object",
  "required": [
    "asset"
  ],
  "title": "CutoutIn"
}

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/logo-editor/trace ​

Trace

Request body

json
{
  "properties": {
    "asset": {
      "type": "string",
      "title": "Asset"
    },
    "preset": {
      "type": "string",
      "title": "Preset",
      "default": "logo"
    },
    "speckle": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 128,
          "minimum": 0
        },
        {
          "type": "null"
        }
      ],
      "title": "Speckle"
    },
    "colours": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 8,
          "minimum": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Colours"
    }
  },
  "type": "object",
  "required": [
    "asset"
  ],
  "title": "TraceIn"
}

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/logo-editor/styles ​

Styles

200 — Successful Response

json
{}

POST /api/v1/logo-editor/concepts ​

Concepts

Request body

json
{
  "properties": {
    "brand": {
      "type": "string",
      "maxLength": 120,
      "title": "Brand",
      "default": ""
    },
    "brief": {
      "type": "string",
      "maxLength": 1000,
      "title": "Brief",
      "default": ""
    },
    "style": {
      "type": "string",
      "title": "Style",
      "default": "minimal"
    },
    "colours": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Colours",
      "default": []
    },
    "count": {
      "type": "integer",
      "maximum": 4,
      "minimum": 1,
      "title": "Count",
      "default": 4
    }
  },
  "type": "object",
  "title": "ConceptsIn"
}

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/logo-editor/chat ​

Chat

Nova edits the open design: returns reply and the ops the page applies. Spends Nova AI credits (the Claude call's own usage).

Request body

json
{
  "properties": {
    "message": {
      "type": "string",
      "maxLength": 1000,
      "minLength": 1,
      "title": "Message"
    },
    "history": {
      "items": {
        "properties": {
          "role": {
            "type": "string",
            "title": "Role",
            "default": "user"
          },
          "text": {
            "type": "string",
            "maxLength": 2000,
            "title": "Text",
            "default": ""
          }
        },
        "type": "object",
        "title": "ChatTurn"
      },
      "type": "array",
      "title": "History",
      "default": []
    },
    "scene": {
      "additionalProperties": true,
      "type": "object",
      "title": "Scene"
    },
    "kit_colours": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Kit Colours",
      "default": []
    },
    "kits": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "type": "array",
      "title": "Kits",
      "default": []
    },
    "linked_kit": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Linked Kit"
    },
    "erp_sites": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "type": "array",
      "title": "Erp Sites",
      "default": []
    },
    "fonts": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Fonts",
      "default": []
    },
    "shapes": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Shapes",
      "default": []
    },
    "erp_instances": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "type": "array",
      "title": "Erp Sites",
      "default": []
    }
  },
  "type": "object",
  "required": [
    "message",
    "scene"
  ],
  "title": "ChatIn"
}

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/logo-editor/designs/{design_id}/chat ​

Get Chat

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

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"
}

PUT /api/v1/logo-editor/designs/{design_id}/chat ​

Save Chat

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

Request body

json
{
  "properties": {
    "messages": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "type": "array",
      "title": "Messages",
      "default": []
    }
  },
  "type": "object",
  "title": "ChatSaveIn"
}

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/logo-editor/designs/{design_id}/chat ​

New Chat

"New chat": the conversation starts over.

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

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/logo-editor/erp-sites ​

Erp Sites

Where "Apply to ERP" can send a logo: this ERP and its linked ones.

200 — Successful Response

json
{}

GET /api/v1/logo-editor/apply-logo/addresses ​

Apply Logo Addresses

Where an apply lands, by address (owner 2026-10-07: "apply logo must mention the website address and erp address"): site's ERP host, each website the Website target can write, and the page a brand belongs on.

Parameters

NameInRequiredTypeDescription
sitequeryno

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/logo-editor/designs/{design_id}/apply-settings ​

Get Apply Settings

This design's Apply choices (None: never saved - the panel's defaults).

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

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"
}

PUT /api/v1/logo-editor/designs/{design_id}/apply-settings ​

Put Apply Settings

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

Request body

json
{
  "properties": {
    "targets": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Targets",
      "default": []
    },
    "websites": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Websites",
      "default": []
    }
  },
  "type": "object",
  "title": "ApplySettingsIn"
}

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"
}

Apply Logo

Make this design the logo of site (this ERP or a linked one) in targets: the images go into THAT site's own branding and website. Then every place is read back - the answer is what the site holds now.

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

Request body

json
{
  "properties": {
    "targets": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Targets"
    },
    "site": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Site"
    },
    "app_logo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 750000
        },
        {
          "type": "null"
        }
      ],
      "title": "App Logo"
    },
    "favicon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 750000
        },
        {
          "type": "null"
        }
      ],
      "title": "Favicon"
    },
    "documents_logo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 750000
        },
        {
          "type": "null"
        }
      ],
      "title": "Documents Logo"
    },
    "website_logo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 750000
        },
        {
          "type": "null"
        }
      ],
      "title": "Website Logo"
    },
    "website_favicon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 750000
        },
        {
          "type": "null"
        }
      ],
      "title": "Website Favicon"
    },
    "website_social": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 750000
        },
        {
          "type": "null"
        }
      ],
      "title": "Website Social"
    },
    "newsletter_logo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 750000
        },
        {
          "type": "null"
        }
      ],
      "title": "Newsletter Logo"
    },
    "login_logo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 750000
        },
        {
          "type": "null"
        }
      ],
      "title": "Login Logo"
    },
    "login_icon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 750000
        },
        {
          "type": "null"
        }
      ],
      "title": "Login Icon"
    },
    "websites": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Websites"
    },
    "remember": {
      "type": "boolean",
      "title": "Remember",
      "default": true
    },
    "icon_only": {
      "type": "boolean",
      "title": "Icon Only",
      "default": false
    },
    "instance": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Site"
    }
  },
  "type": "object",
  "required": [
    "targets"
  ],
  "title": "ApplyLogoIn"
}

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/logo-editor/designs/{design_id}/move ​

Move Design

Copy this design into a linked ERP's own logo library (owner 2026-10-05: "a button to move the current design over", then "rename the button to copy, not move"). The original stays here.

Images travel inside the scene (data: URLs). Imported fonts are library files named in it as "cf-<asset uuid>": each is copied with its file and keeps its uuid, so the scene needs no rewrite - unless that ERP already holds the uuid for another business, when it gets a new one and the scene is rewritten to match. The linked brand kit goes too (one of the same name there is reused). Everything is owned by this person's account THERE.

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

Request body

json
{
  "properties": {
    "site": {
      "type": "string",
      "title": "Site"
    },
    "archive_source": {
      "type": "boolean",
      "title": "Archive Source",
      "default": false
    },
    "instance": {
      "type": "string",
      "title": "Site"
    }
  },
  "type": "object",
  "required": [
    "site"
  ],
  "title": "MoveIn"
}

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/logo-editor/apply-logo/undo ​

Undo Apply Logo

Put back the logos the last apply on site replaced (read back like apply).

Request body

json
{
  "anyOf": [
    {
      "properties": {
        "site": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Site"
        },
        "instance": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Site"
        }
      },
      "type": "object",
      "title": "UndoLogoIn"
    },
    {
      "type": "null"
    }
  ],
  "title": "Body"
}

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"
}

Page Logo

The lock-up file page draws (its product line, file and size), or null.

Parameters

NameInRequiredTypeDescription
pagequeryyesstring

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"
}

Apply Page Logo

Replace page's lock-up with the design, at the old file's height.

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

Request body

json
{
  "properties": {
    "page": {
      "type": "string",
      "maxLength": 500,
      "title": "Page"
    },
    "png": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 12000000
        },
        {
          "type": "null"
        }
      ],
      "title": "Png"
    }
  },
  "type": "object",
  "required": [
    "page"
  ],
  "title": "PageLogoIn"
}

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/logo-editor/page-logo/undo ​

Undo Page Logo

Put back the lock-up the last apply on page replaced.

Request body

json
{
  "properties": {
    "page": {
      "type": "string",
      "maxLength": 500,
      "title": "Page"
    },
    "png": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 12000000
        },
        {
          "type": "null"
        }
      ],
      "title": "Png"
    }
  },
  "type": "object",
  "required": [
    "page"
  ],
  "title": "PageLogoIn"
}

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/logo-editor/designs/{design_id}/apply-page-icon ​

Apply Page Icon

Make the design's square icon page's own tab icon (owner 2026-11-09: "apply brand button must have option to apply favicon to webpage and app").

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

Request body

json
{
  "properties": {
    "page": {
      "type": "string",
      "maxLength": 500,
      "title": "Page"
    },
    "png": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 12000000
        },
        {
          "type": "null"
        }
      ],
      "title": "Png"
    }
  },
  "type": "object",
  "required": [
    "page"
  ],
  "title": "PageLogoIn"
}

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/logo-editor/page-icon/undo ​

Undo Page Icon

Put back the tab icon the applies on page replaced.

Request body

json
{
  "properties": {
    "page": {
      "type": "string",
      "maxLength": 500,
      "title": "Page"
    },
    "png": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 12000000
        },
        {
          "type": "null"
        }
      ],
      "title": "Png"
    }
  },
  "type": "object",
  "required": [
    "page"
  ],
  "title": "PageLogoIn"
}

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/logo-editor/designs/{design_id}/apply-team-icon ​

Apply Team Icon

Make the design Lubb Team's tab icon and, with logo, its content-area watermark, sign-in logo and menu mark.

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

Request body

json
{
  "properties": {
    "icon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 12000000
        },
        {
          "type": "null"
        }
      ],
      "title": "Icon"
    },
    "logo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 12000000
        },
        {
          "type": "null"
        }
      ],
      "title": "Logo"
    }
  },
  "type": "object",
  "title": "TeamIconIn"
}

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/logo-editor/apply-team-icon/undo ​

Undo Team Icon

Put back Lubb Team's tab icon the last apply replaced.

200 — Successful Response

json
{}

POST /api/v1/logo-editor/designs/{design_id}/apply-desk ​

Apply Desk Logo

Make the design Lubb Desk's logo and tab icon.

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

Request body

json
{
  "properties": {
    "logo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 12000000
        },
        {
          "type": "null"
        }
      ],
      "title": "Logo"
    },
    "icon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 12000000
        },
        {
          "type": "null"
        }
      ],
      "title": "Icon"
    }
  },
  "type": "object",
  "title": "DeskLogoIn"
}

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/logo-editor/apply-desk/undo ​

Undo Desk Logo

Put back Lubb Desk's logo and icons the last apply replaced.

200 — Successful Response

json
{}

POST /api/v1/logo-editor/designs/{design_id}/apply-harness ​

Apply Harness Logo

Make the design the Harness's sign-in logo, sidebar mark and tab icon.

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

Request body

json
{
  "properties": {
    "logo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 12000000
        },
        {
          "type": "null"
        }
      ],
      "title": "Logo"
    },
    "icon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 12000000
        },
        {
          "type": "null"
        }
      ],
      "title": "Icon"
    }
  },
  "type": "object",
  "title": "DeskLogoIn"
}

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/logo-editor/apply-harness/undo ​

Undo Harness Logo

Put back the Harness's logo and icons the last apply replaced.

200 — Successful Response

json
{}

POST /api/v1/logo-editor/designs/{design_id}/apply-mobile ​

Apply Mobile Logo

Make the design brand's Lubb Mobile header logo and menu icon.

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

Request body

json
{
  "properties": {
    "brand": {
      "type": "string",
      "maxLength": 64,
      "title": "Brand"
    },
    "logo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 12000000
        },
        {
          "type": "null"
        }
      ],
      "title": "Logo"
    },
    "icon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 12000000
        },
        {
          "type": "null"
        }
      ],
      "title": "Icon"
    }
  },
  "type": "object",
  "required": [
    "brand"
  ],
  "title": "MobileLogoIn"
}

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/logo-editor/apply-mobile/undo ​

Undo Mobile Logo

Put back the Lubb Mobile tab's header logo and menu icon the last apply replaced.

Request body

json
{
  "properties": {
    "brand": {
      "type": "string",
      "maxLength": 64,
      "title": "Brand"
    }
  },
  "type": "object",
  "required": [
    "brand"
  ],
  "title": "MobileUndoIn"
}

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/logo-editor/signature-domains ​

Signature Domains

Lubb Team's mail domains: how many signatures each would update, the pictures they show now, and which are left alone (no picture to replace).

200 — Successful Response

json
{}

POST /api/v1/logo-editor/designs/{design_id}/apply-signatures ​

Apply Signatures

Make this design the signature picture of every signature on domain that has one. The answer is read back from the mail box; what was replaced is kept (the last 10 applies) for Undo.

Parameters

NameInRequiredTypeDescription
design_idpathyesinteger

Request body

json
{
  "properties": {
    "domain": {
      "type": "string",
      "maxLength": 253,
      "title": "Domain"
    },
    "image": {
      "type": "string",
      "maxLength": 2100000,
      "title": "Image"
    }
  },
  "type": "object",
  "required": [
    "domain",
    "image"
  ],
  "title": "ApplySignaturesIn"
}

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/logo-editor/apply-signatures/undo ​

Undo Apply Signatures

Put back the pictures the last apply on domain replaced.

Request body

json
{
  "properties": {
    "domain": {
      "type": "string",
      "maxLength": 253,
      "title": "Domain"
    }
  },
  "type": "object",
  "required": [
    "domain"
  ],
  "title": "UndoSignaturesIn"
}

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/logo-editor/chat/review ​

Chat Review

Check one chat turn's verified results against what was asked: missing is every part of the request they do not do.

Request body

json
{
  "properties": {
    "request": {
      "type": "string",
      "maxLength": 1000,
      "minLength": 1,
      "title": "Request"
    },
    "verified": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Verified",
      "default": []
    }
  },
  "type": "object",
  "required": [
    "request"
  ],
  "title": "ReviewIn"
}

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/logo-editor/brand-kits ​

List Kits

200 — Successful Response

json
{}

POST /api/v1/logo-editor/brand-kits ​

Create Kit

Request body

json
{
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "title": "Name"
    },
    "colours": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Colours",
      "default": []
    },
    "heading_font": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 64
        },
        {
          "type": "null"
        }
      ],
      "title": "Heading Font"
    },
    "body_font": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 64
        },
        {
          "type": "null"
        }
      ],
      "title": "Body Font"
    },
    "notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Notes"
    }
  },
  "type": "object",
  "required": [
    "name"
  ],
  "title": "KitIn"
}

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"
}

PUT /api/v1/logo-editor/brand-kits/{kit_id} ​

Update Kit

Parameters

NameInRequiredTypeDescription
kit_idpathyesinteger

Request body

json
{
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "title": "Name"
    },
    "colours": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Colours",
      "default": []
    },
    "heading_font": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 64
        },
        {
          "type": "null"
        }
      ],
      "title": "Heading Font"
    },
    "body_font": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 64
        },
        {
          "type": "null"
        }
      ],
      "title": "Body Font"
    },
    "notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Notes"
    }
  },
  "type": "object",
  "required": [
    "name"
  ],
  "title": "KitIn"
}

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/logo-editor/brand-kits/{kit_id} ​

Delete Kit

Parameters

NameInRequiredTypeDescription
kit_idpathyesinteger

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/logo-editor/render ​

Render

Request body

json
{
  "properties": {
    "svg": {
      "type": "string",
      "title": "Svg"
    },
    "format": {
      "type": "string",
      "title": "Format",
      "default": "pdf"
    },
    "width": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 8192,
          "minimum": 8
        },
        {
          "type": "null"
        }
      ],
      "title": "Width"
    },
    "name": {
      "type": "string",
      "title": "Name",
      "default": "logo"
    }
  },
  "type": "object",
  "required": [
    "svg"
  ],
  "title": "RenderIn"
}

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/logo-editor/export-pack ​

Export Pack

Request body

json
{
  "properties": {
    "name": {
      "type": "string",
      "title": "Name",
      "default": "logo"
    },
    "svg": {
      "type": "string",
      "title": "Svg"
    },
    "dark_svg": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dark Svg"
    },
    "png_sizes": {
      "items": {
        "type": "integer"
      },
      "type": "array",
      "title": "Png Sizes",
      "default": [
        256,
        512,
        1024,
        2048
      ]
    },
    "formats": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Formats",
      "default": [
        "svg",
        "png",
        "pdf",
        "favicon"
      ]
    }
  },
  "type": "object",
  "required": [
    "svg"
  ],
  "title": "PackIn"
}

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"
}

Lubb Business Documentation