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

Depict.AI Settings API

The Settings API from Depict.AI — 12 operation(s) for settings.

Depict.AI Settings 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 Settings. The published artifact set on APIs.io includes an OpenAPI specification.

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

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

14 operations 12 paths 14 schemas 1 DELETE3 GET7 POST3 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 Settings API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Auth0) using the authorizationCode flow, exposing 3 scopes.

Paths & Operations 14

Across 12 paths, the API surfaces 14 operations — 1 DELETE, 3 GET, 7 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Settings 14
POST
/settings/subscription/basic
Create Subscription Basic
create_subscription_basic_settings_subscription_basic_post 4 params body → 200422
POST
/settings/subscription/essentials
Create Subscription Essentials
create_subscription_essentials_settings_subscription_essentials_post 4 params body → 200422
POST
/settings/subscription/pro
Create Subscription Pro
create_subscription_pro_settings_subscription_pro_post 4 params body → 200422
DELETE
/settings/subscription
Cancel Subscription
cancel_subscription_settings_subscription_delete 3 params → 200422
GET
/settings/subscription/status
Subscription Status
subscription_status_settings_subscription_status_get 1 param → 200422
POST
/settings/track/{merchant_id}/install
Track Install
track_install_settings_track__merchant_id__install_post 1 param → 200422
POST
/settings/{merchant_id}/wizard-complete
Mark Wizard As Complete
mark_wizard_as_complete_settings__merchant_id__wizard_complete_post 1 param → 200422
POST
/settings/track/insight-widget-seen
Insight Widget Seen
insight_widget_seen_settings_track_insight_widget_seen_post 2 params → 200422
GET
/settings/dynamic-status
Get Dynamic Status
get_dynamic_status_settings_dynamic_status_get 1 param → 200422
PUT
/settings/dynamic-status
Update Dynamic Status
update_dynamic_status_settings_dynamic_status_put 1 param body → 200422
POST
/settings/sync-data
Trigger Sync
trigger_sync_settings_sync_data_post 1 param → 200422
GET
/api/v1/settings/{merchant_id}/auto-hide
Get Auto Hide Settings Endpoint
get_auto_hide_settings_endpoint_api_v1_settings__merchant_id__auto_hide_get 1 param → 200404422
PUT
/api/v1/settings/{merchant_id}/auto-hide
Update Auto Hide Settings Endpoint
update_auto_hide_settings_endpoint_api_v1_settings__merchant_id__auto_hide_put 1 param body → 200404422
PUT
/api/v1/settings/{merchant_id}/auto-hide/exclude-products
Update Auto Hide Exclude Products Endpoint
update_auto_hide_exclude_products_endpoint_api_v1_settings__merchant_id__auto_hide_exclude_products_put 1 param body → 200404422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are SubscriptionStatus (12 properties), ActiveSubscriptionDTO (8 properties), DynamicStatusConfig (6 properties), ValidationError (3 properties). Each schema is shown below with its type and property counts.

UpdateExcludeProductsRequest
object
2 properties 2 required
UpdateExcludeProductsResult
object
1 property 1 required
SubscriptionStatus
object
12 properties 12 required
ActiveSubscriptionDTO
object
8 properties 8 required
ShopifyAppSubscriptionCreatePayload
object
1 property 1 required
SubscriptionName
string
GetAutoHideSettingsResult
object
2 properties 2 required
UpdateAutoHideSettingsResult
object
2 properties 2 required
DynamicStatusConfig
object
6 properties 5 required
AppPricingInterval
string
ValidationError
object
3 properties 3 required
SubscriptionDiscount
object
2 properties 2 required
UpdateAutoHideSettingsRequest
object
1 property 1 required
HTTPValidationError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

depictai-settings-api-openapi.yml Raw ↑

Other APIs Depict.AI publishes across the network.

Depict.AI Ab Test API
Depict.AI Analytics API
Depict.AI Boost Bury API
Depict.AI Brand Features API
Depict.AI Catalog Push API (v0) API
Depict.AI Collections API
Depict.AI Dashboard API
Depict.AI Events (v2) API
Depict.AI Instagram API
Depict.AI Listing (v2) API
Depict.AI Listing (v3) API
Depict.AI Media API
Where this information came from

This is an independent, third-party profile of Depict.AI Settings 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.