Skip to main content
POST
Upload a library image

Authorizations

Authorization
string
header
required

Personal access token (izap_pat_…) sent as Authorization: Bearer ; dashboard session JWTs are also accepted.

Headers

business-id
string | null
required

Business UUID whose library is targeted. Required when the user has more than one business.

Body

multipart/form-data
file
file
required
description
string | null
tags
string | null
title
string | null

Response

Successful Response

Metadata for an image stored in the business library.

Backed by the :class:aizap.models.documents.Document model, filtered to image document types.

business_id
string<uuid> | null
required
content_type
string
required
created
string<date-time>
required
document_type
string
required
file_size
integer
required
filename
string
required
id
string<uuid>
required
original_filename
string
required
url
string
required
description
string | null
tags
string[] | null
title
string | null
uploaded_by_user_id
string<uuid> | null