AI planner templates
What an AI plan can be generated FROM, and what each source allows.
A template is the source of the content, not the wizard's flow: sharing, publish days, language, tone and images stay cross-cutting options, and every template declares which of them it accepts. Send the chosen one as template when creating a plan (POST /ai_plans), together with its source.
• generates_images: false means the pictures come from the source — your own photos, your catalogue — so the plan spends no image credits at all. A week of 7 publications with a picture on each goes from 519 credits to 48, and it is worth saying out loud before the plan is created. • regenerate is per template. A template that did not generate the image cannot regenerate it: offer that button anyway and the user pays 70 credits to replace their own photo with an invented one. • orchestration_cost is an ESTIMATE, not the bill. The real charge is per use (what the provider reports). orchestration_cost_per_source_item is what each unit of the source adds on top — one vision pass per image. • A plan is WEEKLY, and the source does not extend it. With max_source_items photos but fewer slots left in the week, the extra ones are dropped and the plan carries warning 2117 in ai_plan.warnings. Say it in your UI before creating the plan, not after charging for it. • source_fields is what the source step is made of. The simple types are ordinary controls; uploads_with_description and catalog_products are the signal that the step needs a component of its own. • Not every network fits every template. unsupported_networks lists the ones whose accounts a plan of that template cannot carry (2120): offer only the rest, instead of letting the user pick a YouTube account for a week of product photos. • The fields carry their own limits. max and min are in the field's own units — characters of a text, items of a list, days for a date — and source_requires_any names the fields of which at least one is needed (from_text: the URL or the pasted text; from_catalog: a Meta catalogue account or a connected store). Read them from here; hardcoding them is how a wizard ends up rejecting at a number the server does not use.
Request
- Base URL: https://api.planvortex.com/v1.0.0
- URL: https://api.planvortex.com/v1.0.0/planner_templates
- Auth: one of:
- HTTP bearer
- OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)
Response
Available planner templates
Example response
{
"templates": [
{
"unsupported_networks": [
"whatsapp",
"google_business",
"youtube"
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.