Console API
Photos
28 endpoints.
/api/v1/admin/businesses/{business_id}/generatedList generated photos for a business
List all generated photos across generation jobs. Pagination via cursor and limit.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
cursor | query | string | null | |
limit | query | integer | default 20 |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_list_GeneratedPhotoData__| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
success | true | default true | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
datarequired | GeneratedPhotoData[] | GeneratedPhotoData[] fields
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fields
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
meta | ResponseMeta | null | ResponseMeta fields
|
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/generated/{generated_photo_id}Serve generated photo file from GCS
Fetch generated photo bytes from GCS. generated_photo_id is 'job_id:index'.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
generated_photo_idrequired | path | string | |
authorization | header | string | null |
Responses
200Successful Responseimage/*string (binary)400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/photosGet business photo library
Get business library photos. Pagination via cursor (string) and limit.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
cursor | query | string | null | |
limit | query | integer | default 20 |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_list_PhotoData__| Field | Type | Description | |||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | ||||||||||||||||||||||||||||||||||
success | true | default true | |||||||||||||||||||||||||||||||||
datarequired | PhotoData[] | PhotoData[] fields
| |||||||||||||||||||||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | |||||||||||||||||||||||||||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/photos/{photo_id}Get photo metadata
Metadata (incl. ``public_url``) for one photo — the JSON counterpart of the byte-serving ``…/photos/get/{photo_id}``. 404 for missing, deleted, or cross-tenant photos. Declared after the literal ``/photos/*`` routes so it never shadows them.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
photo_idrequired | path | string (uuid) | |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_PhotoData_| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | PhotoData | PhotoData fieldsPhotoData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/photos/{photo_id}Delete photo from library
Soft-delete photo from business library. 404 if not found; 409 PHOTO_IN_USE (with per-module usage breakdown in ``details``) if still referenced by a module.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
photo_idrequired | path | string (uuid) | |
authorization | header | string | null |
Responses
204Successful Response400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/photos/generateGenerate photos
Generate photos from description/style. Returns job ID to poll for status.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
authorization | header | string | null |
Request bodyrequired
application/jsonGeneratePhotosBody| Field | Type | Description |
|---|---|---|
descriptionrequired | string | |
style | string | null | |
aspect_ratio | string | null |
Responses
202Successful Responseapplication/jsonSuccessResponse_GenerateJobResponse_| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
request_idrequired | string | |||||||
success | true | default true | ||||||
datarequired | GenerateJobResponse | GenerateJobResponse fields
| ||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | ||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/photos/generate/{job_id}Get photo generation job status
Get generation job status.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
job_idrequired | path | string | |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_GenerateJobStatusData_| Field | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | ||||||||||||||||
success | true | default true | |||||||||||||||
datarequired | GenerateJobStatusData | GenerateJobStatusData fields
| |||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | |||||||||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/photos/get/{photo_id}Serve photo file from GCS
Fetch photo bytes from GCS and return as binary response. Requires viewer role.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
photo_idrequired | path | string (uuid) | |
authorization | header | string | null |
Responses
200Successful Responseimage/*string (binary)400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/photos/import-from-galleryImport photos from industry gallery
Import selected industry gallery photos into business library.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
authorization | header | string | null |
Request bodyrequired
application/jsonImportFromGalleryBody| Field | Type | Description |
|---|---|---|
gallery_photo_idsrequired | string[] | min items 1string[] fields |
Responses
201Successful Responseapplication/jsonSuccessResponse_list_PhotoData__| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | PhotoData[] | PhotoData[] fieldsPhotoData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/photos/import-from-unsplashImport photos from Unsplash
Import photos from Unsplash by IDs or URLs (hotlinked; no upload). IDs require UNSPLASH_ACCESS_KEY.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
authorization | header | string | null |
Request bodyrequired
application/jsonImportFromUnsplashBody| Field | Type | Description |
|---|---|---|
unsplash_photo_ids | string[] | null | string[] | null fields |
unsplash_photo_urls | string[] | null | string[] | null fields |
Responses
201Successful Responseapplication/jsonSuccessResponse_list_PhotoData__| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | PhotoData[] | PhotoData[] fieldsPhotoData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/photos/import-generatedImport from generated photos
Import selected generated photos (by job_id:index) into business library.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
authorization | header | string | null |
Request bodyrequired
application/jsonImportGeneratedBody| Field | Type | Description |
|---|---|---|
generated_photo_ids | string[] | string[] fields |
Responses
201Successful Responseapplication/jsonSuccessResponse_list_PhotoData__| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | PhotoData[] | PhotoData[] fieldsPhotoData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/photos/industry-galleryGet industry gallery photos
Get photos from industry gallery. Optional industryId filter.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
industry_id | query | string | null | |
cursor | query | string | null | |
limit | query | integer | default 20 |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_list_IndustryGalleryPhotoData__| Field | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | |||||||||||||||||||||||||
success | true | default true | ||||||||||||||||||||||||
datarequired | IndustryGalleryPhotoData[] | IndustryGalleryPhotoData[] fields
| ||||||||||||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | ||||||||||||||||||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/photos/industry-gallery/get/{photo_id}Serve industry gallery photo file from GCS
Fetch industry gallery photo bytes from GCS and return as binary response.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
photo_idrequired | path | string (uuid) | |
authorization | header | string | null |
Responses
200Successful Responseimage/*string (binary)400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/photos/search-unsplashSearch Unsplash
Search Unsplash. Requires UNSPLASH_ACCESS_KEY.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
queryrequired | query | string | Search term |
page | query | integer | default 1 |
limit | query | integer | default 30 |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_UnsplashSearchData_| Field | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | |||||||||||||
success | true | default true | ||||||||||||
datarequired | UnsplashSearchData | UnsplashSearchData fields
| ||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | ||||||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/photos/uploadUpload photo to business library
Upload a photo (multipart/form-data). Requires GCS bucket configured.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
authorization | header | string | null |
Request bodyrequired
multipart/form-dataBody_upload_photo_api_v1_admin_businesses__business_id__photos_upload_post| Field | Type | Description |
|---|---|---|
filerequired | string | Image file |
Responses
201Successful Responseapplication/jsonSuccessResponse_PhotoData_| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | PhotoData | PhotoData fieldsPhotoData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/industries/{industry_id}/generatedList generated photos for an industry
List all generated photos across generation jobs for an industry.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
industry_idrequired | path | string | |
cursor | query | string | null | |
limit | query | integer | default 20 |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_list_IndustryGeneratedPhotoData__| Field | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | |||||||||||||||||||||||||
success | true | default true | ||||||||||||||||||||||||
datarequired | IndustryGeneratedPhotoData[] | IndustryGeneratedPhotoData[] fields
| ||||||||||||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | ||||||||||||||||||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/industries/{industry_id}/generated/{generated_photo_id}Serve generated photo file from GCS
Fetch generated photo bytes from GCS. generated_photo_id is 'job_id:index'.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
industry_idrequired | path | string | |
generated_photo_idrequired | path | string | |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonany400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/industries/{industry_id}/photosList photos for an industry
List photos scoped to a single industry with cursor pagination.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
industry_idrequired | path | string | |
cursor | query | string | null | |
limit | query | integer | default 20 |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_list_IndustryGalleryPhotoData__| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | IndustryGalleryPhotoData[] | IndustryGalleryPhotoData[] fieldsIndustryGalleryPhotoData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/industries/{industry_id}/photosDelete industry gallery photos by id
Remove gallery rows whose ids are listed and belong to this industry (JSON body).
Body may be a JSON array of id strings or ``{"ids": [...]}`` (legacy ``gallery_photo_ids`` also accepted).
If you get 422 with an empty/missing body, some clients or proxies drop bodies on **DELETE**; use ``POST .../photos/delete`` with the same JSON instead.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
industry_idrequired | path | string | |
authorization | header | string | null |
Responses
204Successful Response400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/industries/{industry_id}/photos/deleteDelete industry gallery photos (POST; use if DELETE body is stripped)
Same behavior as ``DELETE /industries/{industry_id}/photos``; POST keeps the JSON body on strict proxies.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
industry_idrequired | path | string | |
authorization | header | string | null |
Responses
204Successful Response400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/industries/{industry_id}/photos/generateGenerate photos
Generate photos from description/style for an industry. Returns job ID to poll for status.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
industry_idrequired | path | string | |
authorization | header | string | null |
Request bodyrequired
application/jsonGeneratePhotosBodyGeneratePhotosBody, expanded above.
Responses
202Successful Responseapplication/jsonSuccessResponse_GenerateJobResponse_| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | GenerateJobResponse | GenerateJobResponse fieldsGenerateJobResponse, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/industries/{industry_id}/photos/generate/{job_id}Get photo generation job status
Get generation job status for an industry.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
industry_idrequired | path | string | |
job_idrequired | path | string | |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_GenerateJobStatusData_| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | GenerateJobStatusData | GenerateJobStatusData fieldsGenerateJobStatusData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/industries/{industry_id}/photos/import-from-unsplashImport photos from Unsplash into industry gallery
Import photos from Unsplash by IDs or URLs (hotlinked; no upload). IDs require UNSPLASH_ACCESS_KEY.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
industry_idrequired | path | string | |
authorization | header | string | null |
Request bodyrequired
application/jsonImportFromUnsplashBodyImportFromUnsplashBody, expanded above.
Responses
201Successful Responseapplication/jsonSuccessResponse_list_IndustryGalleryPhotoData__| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | IndustryGalleryPhotoData[] | IndustryGalleryPhotoData[] fieldsIndustryGalleryPhotoData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/industries/{industry_id}/photos/import-generatedImport from generated photos
Import selected generated photos (by job_id:index) into industry gallery.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
industry_idrequired | path | string | |
authorization | header | string | null |
Request bodyrequired
application/jsonImportGeneratedBodyImportGeneratedBody, expanded above.
Responses
201Successful Responseapplication/jsonSuccessResponse_list_IndustryGalleryPhotoData__| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | IndustryGalleryPhotoData[] | IndustryGalleryPhotoData[] fieldsIndustryGalleryPhotoData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/industries/{industry_id}/photos/search-unsplashSearch Unsplash
Search Unsplash for industry gallery workflows. Requires UNSPLASH_ACCESS_KEY.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
industry_idrequired | path | string | |
queryrequired | query | string | Search term |
page | query | integer | default 1 |
limit | query | integer | default 30 |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_UnsplashSearchData_| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | UnsplashSearchData | UnsplashSearchData fieldsUnsplashSearchData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/industries/{industry_id}/photos/template-defaultsList template default photos per website slot
Return each slot from the default website_photos_config with optional linked gallery photo.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
industry_idrequired | path | string | |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_dict_str__TemplateDefaultSlotData__| Field | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | |||||||||||||||||||||||||
success | true | default true | ||||||||||||||||||||||||
datarequired | object | object fieldsMap of string to TemplateDefaultSlotData
| ||||||||||||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | ||||||||||||||||||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/industries/{industry_id}/photos/template-defaultsSet or clear one template default photo slot
Set one slot key to an industry gallery photo id, or null to clear it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
industry_idrequired | path | string | |
authorization | header | string | null |
Request bodyrequired
application/jsonPutTemplateDefaultsBody| Field | Type | Description |
|---|---|---|
keyrequired | string | |
photo_id | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_dict_str__TemplateDefaultSlotData__| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | object | object fieldsMap of string to TemplateDefaultSlotData TemplateDefaultSlotData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/industries/{industry_id}/photos/uploadUpload photo to industry gallery
Upload an industry gallery photo (multipart/form-data). Requires GCS bucket configured.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
industry_idrequired | path | string | |
authorization | header | string | null |
Request bodyrequired
multipart/form-dataBody_upload_industry_photo_api_v1_admin_industries__industry_id__photos_upload_post| Field | Type | Description |
|---|---|---|
filerequired | string | Image file |
Responses
201Successful Responseapplication/jsonSuccessResponse_IndustryGalleryPhotoData_| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | IndustryGalleryPhotoData | IndustryGalleryPhotoData fieldsIndustryGalleryPhotoData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.