Media analysis schemas
What the workspace adds to media analysis — the fields the vision model extracts from every analyzed image, over and above the built-in analysis.
List schemas
Returns the workspace's analysis schemas, including the field definitions of each. At most one is in use at a time: the one the imageAnalysisFormId workspace setting names.
Requires the module-custom-analysis license feature. Without it the request is refused with 403 license_required — see plans and modules.
query Parameters
cursor^[A-Za-z0-9_-]+$form_activeform_createdform_descriptionform_idform_managed_byform_nameform_updatedlimitoffsetsort^-?[a-z0-9_]+$Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List schemas › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Create a schema
Creating a schema does not put it in use — point the imageAnalysisFormId workspace setting at it to have analysis apply it.
Requires the module-custom-analysis license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Create a schema › Request Body
form_nameform_descriptionform_configform_metadataCreate a schema › Responses
Created
form_idform_nameform_descriptionform_configform_metadataform_managed_byform_activeform_createdform_updatedGet a schema
Returns the schema with its field definitions.
Requires the module-custom-analysis license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a schema › Responses
Success
form_idform_nameform_descriptionform_configform_metadataform_managed_byform_activeform_createdform_updatedDelete a schema
Deactivates the schema. Files already analyzed keep the values they were analyzed with.
Requires the module-custom-analysis license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a schema › Responses
Success. No content.
Update a schema
Applies the form_-prefixed fields present in the body. Changes reach future analysis runs; files already analyzed keep the values they were analyzed with.
Requires the module-custom-analysis license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update a schema › Request Body optional
form_nameform_descriptionform_activeform_configform_metadataUpdate a schema › Responses
Success
form_idform_nameform_descriptionform_configform_metadataform_managed_byform_activeform_createdform_updated