How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Depict.AI

Depict.AI Collections API

The Collections API from Depict.AI — 25 operation(s) for collections.

Documentation Provider Profile APIs.io OpenAPI GitHub

Depict.AI Collections API is one of 35 APIs that Depict.AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Collection. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 29 operations across 25 paths, and defines 92 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, /api/lite.

29 operations 25 paths 92 schemas 2 DELETE14 GET1 PATCH6 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.depict.ai
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Depict.AI Collections API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Auth0) using the authorizationCode flow, exposing 3 scopes.

Paths & Operations 29

Across 25 paths, the API surfaces 29 operations — 2 DELETE, 14 GET, 1 PATCH, 6 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Collections 29
GET
/collections
List Collections
list_collections_collections_get 1 param → 200422
GET
/collections/award-status
Get Award Status
get_award_status_collections_award_status_get 1 param → 200422
PUT
/collections/award-status
Update Award Status
update_award_status_collections_award_status_put 1 param body → 200422
GET
/collections/nbr-of-active-collections
Get Nbr Of Active Collections
get_nbr_of_active_collections_collections_nbr_of_active_collections_get 1 param → 200422
POST
/collections/data-sorted-by
Get Data Sorted Collections
get_data_sorted_collections_collections_data_sorted_by_post 1 param body → 200422
PUT
/collections/activation
Set Activation Status
set_activation_status_collections_activation_put 3 params → 200422
GET
/collections/{collection_id}
Get Collection
get_collection_collections__collection_id__get 3 params → 200422
PUT
/collections/{collection_id}
Update Collection
update_collection_collections__collection_id__put 2 params body → 200422
POST
/collections/{collection_id}/products
Get Collection Products
get_collection_products_collections__collection_id__products_post 4 params body → 200422
POST
/collections/{collection_id}/shopify/shopify-ordering
Get Db Shopify Ordering
get_db_shopify_ordering_collections__collection_id__shopify_shopify_ordering_post 2 params → 200422
GET
/collections/{collection_id}/initial-products
Get Initial Collection Products
get_initial_collection_products_collections__collection_id__initial_products_get 2 params → 200422
GET
/collections/{collection_id}/product-clicks
Get Collection Product Clicks
get_collection_product_clicks_collections__collection_id__product_clicks_get 4 params → 200422
GET
/collections/{collection_id}/product-orders
Get Collection Product Orders
get_collection_product_orders_collections__collection_id__product_orders_get 4 params → 200422
POST
/collections/{collection_id}/revert
Revert Collection
revert_collection_collections__collection_id__revert_post 2 params body → 200422
POST
/collections/{collection_id}/preview-url
Get Collection Preview Url
get_collection_preview_url_collections__collection_id__preview_url_post 3 params body → 200422
GET
/collections/{collection_id}/versions
Get Collection Versions
get_collection_versions_collections__collection_id__versions_get 2 params → 200422
PUT
/collections/{collection_id}/update_version
Update Collection Version
update_collection_version_collections__collection_id__update_version_put 2 params body → 200422
DELETE
/collections/{collection_id}/delete_version/{version}
Delete Collection Version
delete_collection_version_collections__collection_id__delete_version__version__delete 3 params → 200422
PUT
/collections/{collection_id}/publish_version/{version}
Publish Collection Version
publish_collection_version_collections__collection_id__publish_version__version__put 2 params body → 200422
GET
/api/v1/merchants/{merchant_id}/collections
List Collections Endpoint
list_collections_endpoint_api_v1_merchants__merchant_id__collections_get 9 params → 200404422
GET
/api/v1/merchants/{merchant_id}/collections/favourites
List Collection Favourites Endpoint
list_collection_favourites_endpoint_api_v1_merchants__merchant_id__collections_favourites_get 3 params → 200404422
PUT
/api/v1/merchants/{merchant_id}/collections/{collection_id}/favourite
Add Collection Favourite Endpoint
add_collection_favourite_endpoint_api_v1_merchants__merchant_id__collections__collection_id__favourite_put 2 params → 204404422
DELETE
/api/v1/merchants/{merchant_id}/collections/{collection_id}/favourite
Remove Collection Favourite Endpoint
remove_collection_favourite_endpoint_api_v1_merchants__merchant_id__collections__collection_id__favourite_delete 2 params → 204404422
GET
/api/v1/merchants/{merchant_id}/collections/{collection_id}
Get Collection Endpoint
get_collection_endpoint_api_v1_merchants__merchant_id__collections__collection_id__get 5 params → 200404422
PATCH
/api/v1/merchants/{merchant_id}/collections/{collection_id}
Save Collection Endpoint
save_collection_endpoint_api_v1_merchants__merchant_id__collections__collection_id__patch 3 params body → 200404422
GET
/api/v1/merchants/{merchant_id}/collections/{collection_id}/curation
Get Collection Curation Endpoint
get_collection_curation_endpoint_api_v1_merchants__merchant_id__collections__collection_id__curation_get 7 params → 200404422
GET
/api/v1/merchants/{merchant_id}/collections/{collection_id}/metrics
Get Collection Metrics Endpoint
get_collection_metrics_endpoint_api_v1_merchants__merchant_id__collections__collection_id__metrics_get 7 params → 200404422
GET
/api/v1/merchants/{merchant_id}/collections/{collection_id}/analytics
Get Collection Analytics Endpoint
get_collection_analytics_endpoint_api_v1_merchants__merchant_id__collections__collection_id__analytics_get 7 params → 200404422
POST
/api/v1/merchants/{merchant_id}/collections/{collection_id}/products
List Collection Products Endpoint
list_collection_products_endpoint_api_v1_merchants__merchant_id__collections__collection_id__products_post 3 params body → 200404422

Schemas 92

The contract defines 92 schemas that model the data the API accepts and returns. The most detailed are CollectionDetail (21 properties), LiteCollectionProductDto (18 properties), LiteDashboardCollectionDto (18 properties), LiteCollectionListDto (17 properties). Each schema is shown below with its type and property counts.

VideoContent
object
3 properties 2 required
CollectionProductMode
string
AnalyticsInventoryBreakdown
object
Inventory health for the in-scope products. hidden is the count of manually-hidden products. lowstock counts visible products with 0 LOWSTOCKUNITS. Fully out-o…
9 properties
GetDataSortedPaginatedCollectionsRequest
object
8 properties 2 required
CollectionDetail
object
21 properties 7 required
LiteCollectionUpdateInput
object
7 properties 7 required
CollectionFavouritesResponse
object
1 property 1 required
CollectionCurationOverrides
object
2 properties
BestsellerMetadata
object
3 properties 2 required
CollectionAnalyticsDetail
object
Rich payload for the Collection Analytics drawer. scrolldepth is always None for now -- there is no scroll tracking, documented as a data gap. summary reuses t…
12 properties 5 required
LiteVariant
object
3 properties 3 required
CollectionAutoLift
object
Derived "Auto Lift" score: how the click-through rate of auto-sorted (non-pinned) products compares to the merchant's manually pinned products. score is normal…
4 properties
AnalyticsAttentionProduct
object
A worst-performing product plus why it was flagged. nosales means it had stock but sold nothing; lowctr means its CTR is in the bottom quartile of the collecti…
10 properties 3 required
RevertCollectionRequest
object
2 properties 2 required
LiteCollectionDto
object
17 properties 16 required
GetPaginatedDataCollectionsResponse
object
3 properties 3 required
HiddenVisibilityLocation
object
4 properties 2 required
NewInProductBadge
object
2 properties 2 required
LimitedAvailabilityMetadata
object
3 properties 2 required
SlowMoverMetadata
object
3 properties 2 required
CollectionSummary
object
13 properties 6 required
TagBoostBuryRule
object
3 properties 2 required
CollectionPermissions
object
8 properties 8 required
CollectionCurationResponse
object
3 properties 3 required
CollectionProductsRequest
object
12 properties
GetCollectionPreviewUrlSuccessResponse
object
2 properties 2 required
AnalyticsPinnedVsAutoItem
object
Per-pinned-product comparison against the collection's auto-cohort CTR. pinnedctr is the product's own CTR; autoctr is the aggregate CTR of all non-pinned prod…
6 properties 2 required
FewVariantsAvailableProductBadge
object
3 properties 3 required
CollectionChild
object
4 properties 4 required
CollectionSortOrder
string
OutOfStockProductBadge
object
1 property 1 required
HTTPValidationError
object
1 property
BadgeBoostBuryRule
object
3 properties 2 required
AnalyticsProductRef
object
A single product row for the analytics drawer's product lists. ctr is a percentage (0-100), computed as clicks / views 100 to match the rest of the collection-…
9 properties 2 required
Award
object
2 properties 2 required
GetCollectionProductClicksResponse
object
1 property 1 required
CollectionBoostBuryRule
object
3 properties 2 required
InactiveMetadata
object
1 property
LiteCollectionVersionTableUpdateInput
object
7 properties 7 required
CollectionRevenueMetric
object
3 properties
CollectionDataOrderBy
string
AnalyticsTierStr
object
Sell-through for one of three contiguous tiers of the sorted collection (tier 1 = top of sort). strvalue is a percentage (0-100).
3 properties 1 required
AwardStatusConfig
object
2 properties 2 required
CollectionProduct
object
13 properties 2 required
CollectionMarketContext
object
3 properties 1 required
TrendingProductBadge
object
3 properties 3 required
BestsellerProductBadge
object
3 properties 3 required
LowStockMetadata
object
3 properties 2 required
PortalSearchFilter
object
5 properties 2 required
OutOfStockMetadata
object
1 property
SortOptionItem
object
3 properties 3 required
VariantOption
object
2 properties 2 required
ProductListingStats
object
13 properties 13 required
CollectionRateMetric
object
2 properties
ProductMetrics
object
16 properties
CollectionListResponse
object
3 properties 1 required
LiteDashboardCollectionData
object
5 properties 5 required
CollectionType
string
OnSaleProductBadge
object
2 properties 2 required
GetCollectionPreviewUrlRequest
object
4 properties 2 required
ContentPosition
string
LiteCollectionSortOrder
string
GetCollectionPreviewUrlWrongPasswordErrorResponse
object
1 property 1 required
ProductStatus
string
CollectionMetricsSummary
object
14 properties 7 required
NewInMetadata
object
2 properties
OnSaleMetadata
object
3 properties 2 required
LiteCollectionListDto
object
17 properties 15 required
ContentBlock
object
5 properties 5 required
CollectionProductsResponse
object
5 properties 1 required
LiteCollectionPublishVersionInput
object
4 properties 4 required
ChunkType
string
ProductBadgeType
string
CollectionMetricValue
object
2 properties
CollectionSaveRequest
object
17 properties
TrendingMetadata
object
3 properties 2 required
GetCollectionProductClicksRow
object
4 properties 4 required
CollectionListSortBy
string
SlowMoverProductBadge
object
3 properties 3 required
ImageContent
object
3 properties 2 required
ShopifyVideo
object
2 properties 2 required
LiteCollectionVersionDto
object
10 properties 10 required
LiteDashboardCollectionDto
object
18 properties 16 required
CollectionMetricsPeriod
object
2 properties 2 required
CollectionTopProduct
object
The highest-revenue product in a collection, for the overview table's "Top Product" column. imageurl is the product's first image (or None).
4 properties 1 required
StarProductMetadata
object
3 properties 2 required
ValidationError
object
3 properties 3 required
AnalyticsPositionBand
object
Aggregate click-through performance for a contiguous band of positions in the collection's sort order (pinned first, then auto). Bands are fixed by 1-based pos…
5 properties 2 required
ShopifyImage
object
5 properties 2 required
CollectionRankingType
string
CollectionFilterBy
string
LiteCollectionProductDto
object
18 properties 18 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

depictai-collections-api-openapi.yml Raw ↑

Other APIs Depict.AI publishes across the network.

Depict.AI Ab Test API
AE Profile APIs.io
Depict.AI Analytics API
AE Profile APIs.io
Depict.AI Boost Bury API
AE Profile APIs.io
Depict.AI Brand Features API
AE Profile APIs.io
Depict.AI Catalog Push API (v0) API
AE Profile APIs.io
Depict.AI Dashboard API
AE Profile APIs.io
Depict.AI Events (v2) API
AE Profile APIs.io
Depict.AI Instagram API
AE Profile APIs.io
Depict.AI Listing (v2) API
AE Profile APIs.io
Depict.AI Listing (v3) API
AE Profile APIs.io
Depict.AI Media API
AE Profile APIs.io
Depict.AI merchant API
AE Profile APIs.io
#Collection
← Back to D APIs
API Details
ID
depictai:depictai-collections-api
Base URL
https://api.depict.ai
Docs
https://docs.depict.ai/api-reference/headless/overview
Provider
Depict.AI
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=depictai-collections-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/depictai-collections-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Depict.AI Collections API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.