Skip to content
Crossmart Docs

Generate channel content with AI

POST
/api/v1/workspaces/{workspaceId}/ai/content-generations
curl --request POST \
  --url https://api.crossmart.io/api/v1/workspaces/example/ai/content-generations \
  --header 'Content-Type: application/json' \
  --data '{ "connectionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "productIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Queues the Content Generator for each product: it writes a title and description fitted to the store’s channel. The results arrive as pending suggestions to review; nothing changes until one is approved. Each product uses one AI credit: answers 402 when the plan’s credits this month do not cover them (while plans are enforced), 429 past the rate limit, and 503 while AI is not configured.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspaceId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
connectionId
required

The store to write for

string format: uuid
productIds
required
Array<string>
>= 1 items <= 100 items

Example generated

{
  "connectionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "productIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ]
}

Responses

Section titled “Responses”

202

Section titled “202”
Media typeapplication/json
object
queued
required

Products queued; their suggestions arrive in the inbox

number

Example generated

{
  "queued": 1
}

402

Section titled “402”

The organization’s plan does not allow this (ENTITLEMENTS_ENFORCED is on). code and feature say why; upgrading the plan resolves it.

Media typeapplication/json
object
statusCode
required
number
error
required
string
code
required
string
Allowed values: plan_limit_reached plan_feature_not_included
message
required
string
feature
required
string
Allowed values: active_listings channel_connections workspaces members api_keys ai_credits autonomous_agents bring_your_own_key
plan
required

The code of the organization’s plan

string
limit
required

Null is unlimited

number
nullable
usage
required
number
requested
required

How many more the request asked for

number

Example 

{
  "statusCode": 402,
  "error": "Payment Required",
  "code": "plan_limit_reached",
  "message": "The Free plan includes 2 connected channels, and 2 are in use. Upgrade the plan to add more.",
  "feature": "active_listings",
  "plan": "free"
}

429

Section titled “429”

Too many AI requests from you in this workspace. Wait a minute and try again.