| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://subdomain.imagerelay.com/ | link | — | — | — |
Actions (43)
Library API · 23
- Check upload job statusGET /api/v2/upload_jobs/{upload_job_id}
Check status of an upload job.
documented - Complete uploadPOST /api/v2/files/{file_id}/versions/{v4_uuid}/complete
Indicate that the file is ready for processing.
documented - Create folderPOST /api/v2/folders/{parent_folder_id}/children
Create a new subfolder under the specified parent folder.
documented - Create synced filePOST /api/v2/{file_id}/synced_file
Create a Synced File that exists in multiple folders.
documented - Create upload jobPOST /api/v2/upload_jobs
Start an upload job which will create a single asset.
documented - Delete fileDELETE /api/v2/files/{file_id}
Delete a specific file.
documented - Delete folderDELETE /api/v2/folder/{folder_id}
Delete a specific folder.
documented - Duplicate filePOST /api/v2/files/{file_id}/dupicate
Create a duplicate of a specific file in a destination folder.
documented - Get fileGET /api/v2/files/{file_id}
Retrieve a specific file.
documented - Get folderGET /api/v2/folders/{folder_id}
Retrieve a specific folder.
documented - Get root folderGET /api/v2/folders/root
Retrieve the root folder for the current user.
documented - List child foldersGET /api/v2/folders/{parent_folder_id}/children
Retrieve a paginated array of child folders for the specified parent.
documented - List files in folderGET /api/v2/folders/{folder_id}/files
Retrieve a paginated array of files within a folder.
documented - List foldersGET /api/v2/folders
Retrieve a paginated array of top-level folders.
documented - Move filePOST /api/v2/files/{file_id}/move
Move a file to a different folder.
documented - Obtaining a v4 UUIDPOST /api/v2/files/{file_id}/versions
Obtain a v4 UUID to be used when uploading the new file in chunks.
documented - Update asset thumbnailPOST /api/v2/files/{file_id}/thumbnail
Update a specific file's asset thumbnail.
documented - Update file metadata termsPOST /api/v2/files/{file_id}/terms
Update the metadata terms of a specific file.
documented - Update file tagsPOST /api/v2/files/{file_id}/tags
Update the tags/keywords of a specific file.
documented - Update folderPUT /api/v2/folders/{folder_id}
Update the name (and metadata) of a folder.
documented - Update versionPOST /api/v2/files/{file_id}/versions
Upload a new version of a file using chunked upload.
documented - Upload file chunkPOST /api/v2/files/{file_id}/versions/{v4_uuid}/chunk/{chunk_number}
Upload a single chunk of a file version.
documented - Upload file from URLPOST /api/v2/files
Upload a file from a provided URL.
documented
Products API · 20
- Create catalogPOST /api/v2/catalogs
Create a new catalog.
documented - Create productPOST /api/v2/products
Create a new product.
documented - Create product variantPOST /api/v2/products/{product_id}/variants
Create a new product variant.
documented - Delete catalogDELETE /api/v2/catalogs/{catalog_id}
Delete a catalog.
documented - Delete productDELETE /api/v2/products/{product_id}
Delete a product.
documented - Delete product variantDELETE /api/v2/products/{product_id}/variants/{variant_id}
Delete a product variant.
documented - Get Channel Template MappingsGET /api/v2/product_templates/{product_template_id}/channel_template_mappings
Retrieve channel template mappings for a product template.
documented - Get catalogGET /api/v2/catalogs/{catalog_id}
Retrieve a specific catalog.
documented - Get catalog productsGET /api/v2/catalogs/{catalog_id}/products
Retrieve products in a catalog.
documented - Get productGET /api/v2/products/{product_id}
Retrieve a specific product.
documented - Get product templateGET /api/v2/product_templates/{product_template_id}
Retrieve a specific product template.
documented - Get product variantGET /api/v2/products/{product_id}/variants/{variant_id}
Retrieve a specific product variant.
documented - List catalogsGET /api/v2/catalogs
Retrieve a paginated array of catalogs.
documented - List product templatesGET /api/v2/product_templates
Retrieve a paginated array of product templates.
documented - List product templates altGET /api/v2/product_templates
Alternate listing path for product templates (if documented under this section).
documented - List product variantsGET /api/v2/products/{product_id}/variants
Retrieve the variants for a product.
documented - List productsGET /api/v2/products
Retrieve a paginated array of products.
documented - Update catalogPUT /api/v2/catalogs/{catalog_id}
Update a catalog.
documented - Update productPUT /api/v2/products/{product_id}
Update an existing product.
documented - Update product variantPATCH /api/v2/products/{product_id}/variants/{variant_id}
Update a product variant.
documented