Endpoint outils IA
POST /v1/tools/{name} exécute directement un outil de SmartChat AI, sans modèle IA entre les deux. Les textes envoyés sont repris mot pour mot. GET /v1/tools liste tous les outils avec leur schéma et si ta clé peut les utiliser.
La référence technique ci-dessous est en anglais, exactement comme les noms et champs apparaissent dans l'API et dans Claude.
curl -X POST https://api.smartchat.marketing/v1/tools/update_landing \
-H "Authorization: Bearer sk_live_..." \
-H "Content-Type: application/json" \
-d '{"arguments": {"headline": "Fresh bread every morning"}}'
{"tool": "update_landing", "ok": true, "result": { ... }}
Actions en deux étapes
Les outils qui envoient, planifient, soumettent ou suppriment renvoient d'abord un aperçu et un confirm_token. Rappelle le même outil avec confirm_token pour exécuter. Rien ne se passe au premier appel.
59 tools
POST/v1/tools/get_overview · Get account overview
stats:readReturns an overview of the account: landing page, templates, follow-ups, newsletters, automations and contacts with their IDs and states.
Données (body): {"arguments": { ... }}
Aucun champ d'entrée.
POST/v1/tools/list_media · List media
media:readLists the images and videos in the media library with id, number, type and description.
Données (body): {"arguments": { ... }}
Aucun champ d'entrée.
POST/v1/tools/save_to_library · Save to media library
media:writeSaves an uploaded file permanently to the media library. Argument: media_id.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
media_id | string | oui |
POST/v1/tools/update_landing · Change landing page texts
landing:writeUtilise des crédits comme un message à SmartChat AIChanges texts and settings of the landing page. Texts are used word for word.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
headline | string | non | |
subheadline | string | non | |
cta_text | string | non | |
success_message | string | non | |
texte | object | non | |
steps_title | string | non | |
steps_intro | string | non | |
faq_title | string | non | |
proof_title | string | non | |
problem | object | non | |
solution | object | non | |
offer | object | non | |
steps | array of object | non | |
faq | array of object | non | |
reviews | array of object | non | |
color | string | non | |
heading_color | any | non | |
background_color | any | non | |
button_color | any | non | |
font | string | non | |
design_mood | string | non | |
font_pair | string | non | |
hero_image | string | non | |
hero_media | object | non | |
images | array of string | non | |
verbatim | array of string | non | Namen der Felder, deren Text der Nutzer WÖRTLICH vorgegeben hat (z.B. ["headline"]). Diese Texte werden exakt so gespeichert - ohne Kritiker, ohne Politur. Setze das IMMER, wenn du einen Text übernimmst, den der Nutzer selbst geschrieben hat. |
POST/v1/tools/swap_landing_image · Change landing page image
landing:writeReplaces an image on the landing page with an image or video from the media library.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
position | any | oui | |
query | string | non |
POST/v1/tools/get_landing_blocks · Get landing page blocks
landing:readReturns all blocks of the landing page with their ids and content.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
position | any | non |
POST/v1/tools/add_landing_block · Add landing page block
landing:writeUtilise des crédits comme un message à SmartChat AIAdds a block (section) to the landing page.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
type | string | oui | |
data | object | non | |
variant | string | non | |
ton | string | non | |
position | any | non | |
stil | array of object | non |
POST/v1/tools/remove_landing_block · Remove landing page block
landing:writeRemoves a block from the landing page.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
position | any | oui |
POST/v1/tools/move_landing_block · Move landing page block
landing:writeMoves a block to another position on the landing page.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
from | any | oui | |
to | any | oui |
POST/v1/tools/set_landing_style · Change landing page style
landing:writeChanges colors, fonts and background of the landing page or of one block.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
radius | any | non | |
shadow | any | non | |
spacing | any | non | |
width | any | non | |
button | any | non | |
image | any | non | |
stil | array of object | non |
POST/v1/tools/update_landing_block · Change landing page block
landing:writeUtilise des crédits comme un message à SmartChat AIChanges the content or design of one block. Texts are used word for word.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
position | any | oui | |
karte | any | non | |
data | object | non | |
variant | string | non | |
ton | string | non | |
stil | array of object | non |
POST/v1/tools/publish_landing · Publish landing page
landing:writePublishes the landing page so the changes are live.
Données (body): {"arguments": { ... }}
Aucun champ d'entrée.
POST/v1/tools/create_followup_sequence · Create follow-up sequence
followups:writeUtilise des crédits comme un message à SmartChat AICreates a follow-up sequence (messages after sign-up).
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | |
steps | array of object | oui | |
activate | boolean | non | |
verbatim | array of string | non |
POST/v1/tools/update_followup_step · Change follow-up step
followups:writeUtilise des crédits comme un message à SmartChat AIChanges text, image or timing of one follow-up message. Texts are used word for word.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
step_id | string | oui | |
content | string | non | |
subject | string | non | |
delay_hours | number | non | |
verbatim | array of string | non |
POST/v1/tools/add_followup_step · Add follow-up step
followups:writeUtilise des crédits comme un message à SmartChat AIAdds a message to a follow-up sequence.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
sequence_id | string | oui | |
channel | string | non | |
delay_hours | number | non | |
content | string | oui | |
button | any | non | |
media | object | non | |
verbatim | array of string | non |
POST/v1/tools/delete_followup_step · Delete follow-up step
followups:writeDeletes one message from a follow-up sequence.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
step_id | string | oui |
POST/v1/tools/rename_followup_sequence · Rename follow-up sequence
followups:writeRenames a follow-up sequence.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
sequence_id | string | oui | |
name | string | oui |
POST/v1/tools/set_followup_status · Pause or start follow-ups
followups:writePauses or starts a follow-up sequence.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
sequence_id | string | oui | |
status | string ("active", "paused") | oui |
POST/v1/tools/create_newsletter · Create newsletter
newsletters:writeUtilise des crédits comme un message à SmartChat AICreates a WhatsApp newsletter as draft. Texts are used word for word; media_id adds an image or video from the media library.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
subject | string | oui | |
content | string | oui | |
channel | string | non | |
media | object | non | |
cta | object | non | |
segment | object | non |
POST/v1/tools/update_newsletter · Change newsletter
newsletters:writeUtilise des crédits comme un message à SmartChat AIChanges text, image, video or button of a newsletter. Texts are used word for word.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
newsletter_id | string | oui | |
subject | string | non | |
content | string | non | |
media | any | non | |
cta | any | non | |
segment | any | non |
POST/v1/tools/send_newsletter · Send newsletter now
newsletters:scheduleSends a newsletter to all confirmed contacts. First call returns the number of recipients and a confirm_token; the second call with confirm_token sends.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
newsletter_id | string | oui | |
confirm_token | string | non |
POST/v1/tools/test_newsletter · Send test newsletter
newsletters:scheduleSends a newsletter to the test phone number only.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
newsletter_id | string | oui | |
to | string | non |
POST/v1/tools/schedule_newsletter · Schedule newsletter
newsletters:scheduleSchedules a newsletter. First call returns a preview and confirm_token; the second call with confirm_token schedules.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
newsletter_id | string | oui | |
scheduled_at | string | oui | |
confirm_token | string | non |
POST/v1/tools/cancel_newsletter · Cancel newsletter
newsletters:scheduleCancels a scheduled newsletter.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
newsletter_id | string | oui |
POST/v1/tools/get_newsletter · Get newsletter
newsletters:readReturns one newsletter with text, media, state and recipients.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
newsletter_id | string | oui |
POST/v1/tools/create_template · Create template
templates:writeUtilise des crédits comme un message à SmartChat AICreates a WhatsApp template as draft. Texts are used word for word.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | |
channel | string | non | |
content | string | oui | |
subject | string | non | |
buttons | array of any | non | |
media | object | non | |
verbatim | array of string | non |
POST/v1/tools/update_template · Change template
templates:writeUtilise des crédits comme un message à SmartChat AIChanges text, image or buttons of a template. Texts are used word for word.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
template_id | string | oui | |
name | string | non | |
content | string | non | |
subject | string | non | |
buttons | any | non | |
media | any | non | |
verbatim | array of string | non |
POST/v1/tools/delete_template · Delete template
templates:deleteDeletes a template.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
template_id | string | oui |
POST/v1/tools/submit_all_templates · Submit all templates
templates:submitSubmits all open templates to WhatsApp. First call returns the list and confirm_token; the second call with confirm_token submits.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
confirm_token | string | non |
POST/v1/tools/submit_template · Submit template to WhatsApp
templates:submitSubmits a template to WhatsApp for approval. First call returns a check and confirm_token; the second call with confirm_token submits.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
template_id | string | oui | |
confirm_token | string | non |
POST/v1/tools/get_stats · Get statistics
stats:readReturns the key figures of the account.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
range | string ("7d", "30d", "90d") | non |
POST/v1/tools/list_contacts · List contacts
contacts:readLists contacts with their opt-in state and tags.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
type | string | non | |
search | string | non |
POST/v1/tools/add_contact · Add contact
contacts:writeAdds a contact. A new contact still has to confirm the sign-up.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
name | string | non | |
email | string | non | |
phone | string | non |
POST/v1/tools/resend_optin_confirmation · Resend confirmation
messages:writeSends the sign-up confirmation to a contact again. First call returns a preview and confirm_token.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
contact_id | string | oui | |
confirm_token | string | non |
POST/v1/tools/tag_contacts · Tag contacts
contacts:writeAdds tags to one or more contacts.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
tag | string | oui | |
contact_ids | array of any | oui | |
grund | string | non |
POST/v1/tools/untag_contacts · Remove tags
contacts:writeRemoves tags from one or more contacts.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
tag | string | oui | |
contact_ids | array of any | oui |
POST/v1/tools/export_contacts · Export contacts
contacts:readExports the contacts as CSV text.
Données (body): {"arguments": { ... }}
Aucun champ d'entrée.
POST/v1/tools/update_brand · Change brand
settings:writeChanges brand data: name, colors, logo, tone.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
color | string | non | |
tonality | string | non |
POST/v1/tools/set_landing_tracking · Set tracking pixel
landing:writeSets tracking pixels (Meta, Google, TikTok) on the landing page.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
meta_pixel_id | string | non | |
meta_capi_token | string | non | |
google_id | string | non | |
gtm_id | string | non | |
tiktok_id | string | non | |
tiktok_events_token | string | non |
POST/v1/tools/find_text · Find text
landing:readFinds where a text appears: landing page, popup, templates, follow-ups and newsletters. Argument: text.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
text | string | oui |
POST/v1/tools/set_legal_urls · Set legal pages
settings:writeSets the addresses of imprint and privacy policy.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
imprint_url | string | non | |
privacy_url | string | non |
POST/v1/tools/update_website_popup · Change website popup
landing:writeUtilise des crédits comme un message à SmartChat AIChanges texts, look and timing of the sign-up popup on the business website.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
headline | string | non | |
text | string | non | |
button | string | non | |
thanks_headline | string | non | |
thanks_text | string | non | |
image | any | non | |
triggers | array of string ("time", "exit", "scroll") | non | |
delay_seconds | number | non | |
scroll_percent | number | non |
POST/v1/tools/scan_website · Scan website
settings:writeUtilise des crédits comme un message à SmartChat AIScans the business website again and updates the stored data. Argument: url (optional).
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
url | string | oui |
POST/v1/tools/set_constraint · Set a content rule
settings:writeStores a rule for all content, for example a topic that must never be mentioned.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
value | string | oui | |
kind | string | non |
POST/v1/tools/search_knowledge · Search business knowledge
settings:readSearches the stored knowledge about the business (website, documents). Argument: query.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
query | string | oui | |
limit | number | non |
POST/v1/tools/refresh_brain · Rebuild business knowledge
settings:writeUtilise des crédits comme un message à SmartChat AIRebuilds the stored knowledge about the business from its website and documents.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
force | boolean | non |
POST/v1/tools/get_growth_plan · Get growth plan
settings:readUtilise des crédits comme un message à SmartChat AIReturns a growth plan for the business based on its data.
Données (body): {"arguments": { ... }}
Aucun champ d'entrée.
POST/v1/tools/get_next_step · Get next step
settings:readReturns the most useful next step for the account.
Données (body): {"arguments": { ... }}
Aucun champ d'entrée.
POST/v1/tools/refresh_reviews · Reload reviews
landing:writeUtilise des crédits comme un message à SmartChat AILoads the latest Google reviews for the landing page.
Données (body): {"arguments": { ... }}
Aucun champ d'entrée.
POST/v1/tools/web_research · Research on the web
settings:readUtilise des crédits comme un message à SmartChat AIResearches a question on the web and returns sources. Argument: query.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
query | string | oui | |
language | string | non |
POST/v1/tools/list_automations · List automations
automations:readLists the automations with state and trigger.
Données (body): {"arguments": { ... }}
Aucun champ d'entrée.
POST/v1/tools/create_automation · Create automation
automations:writeUtilise des crédits comme un message à SmartChat AICreates an automation (trigger and actions).
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | |
trigger_type | string | oui | |
trigger_config | object | non | |
actions | array of object | oui | |
contact_fields | array of string | non | |
activate | boolean | non |
POST/v1/tools/update_automation · Change automation
automations:writeUtilise des crédits comme un message à SmartChat AIChanges an automation, or pauses and activates it.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
automation_id | string | oui | |
name | string | non | |
status | string | non | |
actions | any | non | |
trigger_config | any | non |
POST/v1/tools/test_automation · Test automation
automations:writeRuns an automation once with test data.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
automation_id | string | oui | |
sample_payload | object | non |
POST/v1/tools/get_automation_setup · Get automation setup
automations:readReturns how an automation is connected (webhook address, fields).
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
automation_id | string | oui |
POST/v1/tools/connect_calendar · Connect calendar
automations:writeConnects a calendar (private iCal address) to an automation.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
automation_id | string | oui | |
calendar_url | string | non | |
provider | string | non | |
lead_minutes | number | non |
POST/v1/tools/get_automation_runs · Get automation runs
automations:readReturns the latest runs of an automation.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
automation_id | string | oui | |
limit | number | non |
POST/v1/tools/delete_automation · Delete automation
automations:deleteDeletes an automation. First call returns a summary and confirm_token.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
automation_id | string | oui | |
confirm_token | string | non |
POST/v1/tools/create_free_automation · Create custom automation
automations:writeUtilise des crédits comme un message à SmartChat AICreates an automation from a custom rule. First call returns a preview; the second call with confirmed: true creates it.
Données (body): {"arguments": { ... }}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | |
regel | object | oui | |
actions | array of object | oui | |
contact_fields | array of string | non | |
activate | boolean | non | |
confirmed | boolean | non |
Des questions ?
Écris-nous à support@smartchat.marketing