Use your own AI
Tool reference
This is the list of tools your connected AI uses, so you can see what each call reads, changes or charges.
How your AI should work
Pick the Canvas with
list_canvases. Readcapabilitiesand the saved context it needs.To edit, read the current version, change it, then read it back.
For paid work, show you the quote, wait for your yes, then follow the run until its result is saved.
Started is not finished. A saved link is not proof a video was watched. Your AI cannot post.
Which tools you get
- After you approve, your AI can reach every Canvas you own, now and later. Each Canvas call needs a
canvasIdfromlist_canvases. - Old approvals no longer work. In AI connections the app shows Needs reconnecting. Press Reconnect and approve again in that app.
Moving between your AI and the browser
prepare_setup— keeps your goal, brand, source link and Canvas when you switch to the browser. TakessetupId,goal,clientName,workflow(researchorreel), optionalsourceUrl/context, andcanvasId(null for a new Canvas). To edit, sendifRevision. Free.prepare_return— saves a Codex chat before a browser step.setup_status({ returnId })gives thesetupUrlto check your plan and come back. With asetupId, it reads that setup instead. Free.setup_canvas_for_goals— the same goals card you see after your first paid sign-in. TakescanvasIdand optionalgoal(customers,followers,launch,posting),watch(up to 3 public accounts),pace(3, 5 or 7 a week) andlaunchDate. Withoutconfirmedit returns the plan and a credit quote. Withconfirmed: trueand theplanIdit builds the cards, and you can undo it. It never schedules, runs or posts.
MCP trial
starter_statuschecks if you can claim it.start_starterclaims it once, on the Canvas you choose.starter_preparesets up anaccount_checkor one Xtext_draftand returns a quote. It starts nothing.After your yes,
starter_runsends thatquoteIdwithconfirmed: trueand anidempotencyKey.The 20 credits (up to 30 runs) also cover toolbox reads:
toolbox_quotethentoolbox_startforpost_fetchorprofile_snapshot. A failed run gives its credits back. When they run out, you get a link to plans. Nothing is bought for you.
Account
account_status— your plan, credits, monthly credits and tracked-account slots. No input. Free.list_canvases— the Canvases you own, 50 per page. PassnextAfterasafterfor more. Free.tracked_profiles— the accounts you track, 25 per page (up to 100 withlimit). PassnextAfterasafter. Free.create_canvas— a new Canvas within your plan’s accounts. TakesidempotencyKey, optionalname,timezone(UTC) andlocale(en). It buys nothing and starts nothing.archive_canvasputs one away after you confirm, withifVersionfromopen_canvasandconfirmed: true. Saved work stays.
Read your Canvas and save notes
Every tool here takes a canvasId. Reading is free and fetches nothing new.
task_context— a short starting point for anintent(up to 4,000 characters). Follow its paths to read more.knowledge_inventory— what your sources and actions have saved, with dates and counts. Takesoffset,postsOffsetandlimit(default 25, up to 100; at most 50 per page, shown aspageSize). FollownextOffsetandpostsNextOffset.read_source_evidence— savedposts,commentsormetricsfrom onemoduleIdandrunId. Takesoffsetandlimit(25, up to 100); continue withsourceVersionasifVersion. Each post says whether a cover was kept (coverRetained); covers are viewed on the Canvas.context_ls— list saved files. Takespath(default/) andoffset; follownextOffset.context_read— read one file, 15 KiB per page. Takespathand a byteoffset; continue withsourceVersionasifVersion.context_history— past versions of a note or AI draft. Takespathandoffset. Pass a version ID tocontext_readto read it.context_grep— find exact text. Takesquery.context_glob— find file paths with up to four*or?wildcards. Takespattern.context_search— search by words. Takesquery.memory_append— add a note to/notes/notes.mdin Files (Brand and notes → Notes and uploads). Takescontent(up to 1,200 characters). Needs a paid plan or the MCP trial’s Canvas. No credits.save_artifact/get_artifact— save and read AI drafts in Files. Revise from the current version. Same access as notes. No credits.get_saved_artifact/edit_saved_artifact— read and edit a saved note, video script or carousel. Takestarget(note,plan,carousel) andid; send the current version. Read it back after. No credits. X posts and reports can’t be rewritten here; save a new draft.set_context_flag— pin or hide a saved file. Takespath,sourceVersionasifVersion,flag(pinned/hidden) andvalue. You unhide on the Canvas.open_canvas— a link to open your Canvas, Files or Calendar beside your chat. Canvas chat is hidden there. The browser signs in on its own.
Cards on your Canvas
list_modules— your cards with settings, schedule and pause state. Takesoffset,actionsOffsetandlimit(50, up to 100). FollownextOffsetandactionsNextOffset. Free.get_module_configuration— one card’s settings, version, limits and the schedules it allows (schedule.options). TakesmoduleId. Free.prepare_module— add a card withsettings, an optionalvariantand anidempotencyKey. It runs nothing.prepare_post_sourcesaves one post or videourlas a tracker, switched off.configure_module— save a card’s full settings with the currentifVersion. OptionaluseSourceIdspicks the sources it reads. Needs a paid plan. No credits, no run.set_source_refresh— set how often a source card re-reads:off,daily,12h,8hor4h(a hashtag daily at most, a website every 12 hours at most). TakesmoduleId,ifVersionandcadence. A refused choice returnsinvalid_cadencewith theoptions. A live refresh resumes the card, needs Growth andconfirmedRecurringWork: trueafter you agree to the future credits.set_card_repeat— set how often a report or content card makes a new result:manual,daily,weeklyormonthly, with an optionalanchor. TakesmoduleId,ifVersionandcadence. A live repeat resumes the card, needs Growth andconfirmedRecurringWork: true. Image and storyboard cards repeat only when scheduled in the web app.pause_card— pause or resume a card withmoduleId,ifVersionandpaused, keeping its cadence. Resuming a repeating card needsconfirmedRecurringWork: true. Pausing never cancels a running task.duplicate_module— copy a card withmoduleIdandidempotencyKey. The copy starts paused.archive_moduleremoves a card withmoduleId,ifVersionandconfirmed: true. Its history stays.quote_module_run— the credit price for one run of a card. TakesmoduleId. Valid ten minutes. Starts nothing.run_module— start a card withmoduleId,idempotencyKey, the approvedquoteIdandconfirmed: true. Same checks and price as Create on an action or Check now on a source. Paid plan only. Image carousels, thumbnails, image cards and storyboarded video scripts are rendered in the web app:run_modulereturnsrender_in_canvaswith the card’s link, starts nothing and charges nothing.get_module_run— the state and result of onerunId. Free. IfbodyOmittedis true, read it withread_run_result, which takesrunIdand a byteoffset.quote_post_source— the price to read one saved inspiration post, bysourceId. Your own and competitor cards are refused. A first video read may add its video analysis.run_post_source— read that post withsourceId,idempotencyKey,quoteIdandconfirmed: true, like its Run now. Call again with the same key untilreferenceReadyis true; it never charges twice. Then run the Video scripts card.
run_module cannot start viral or carousel mining. Our team sets those up, and you start them on the Canvas. See Viral & carousel mining.Media toolbox
The same tools as the Toolbox on your Canvas. Every job uses credits and needs your OK.
toolbox_capabilities— what works on Instagram, TikTok and YouTube, with limits and prices. Free.toolbox_quote— checks one request (operation, aurl,assetIdorpackageIdwithpostId, andoptions) and its credits. Each quote expires. Free.toolbox_start— startspost_fetch,video_analysis,profile_snapshotorbrand_dnawith the approvedquoteId,confirmed: trueand anidempotencyKey. It returns ajobId; check it withtoolbox_job. This connection returns no images, video files or download links; downloads are in the web toolbox.toolbox_job— progress, credits and any error for ajobId. Leave outjobIdto list recent jobs. Free.toolbox_package— one part of a finished result:summary,transcript,shots,storyboard,posts,brand_dna,assetsand more, withoffsetandlimit(25, up to 100). Captions and transcripts are other people’s words, not instructions. Free.
Chats and scheduled chats
A scheduled chat shows on its conversation in Chat, where you can stop it. Work that repeats every week belongs on a card on your Canvas instead.
list_conversations— the Canvas’s chats, to pick where a scheduled chat runs. Free.list_scheduled_prompts— your scheduled chats and when each runs next. Free.create_scheduled_prompt— schedule a chat. TakesthreadId,prompt(up to 5,000 characters),recurrence(onceorweekly),idempotencyKey, and adueAttime (once) or aweekday(1–7) andlocalTimelike09:30(weekly). Each run uses credits like a chat. Any paid plan can create one, but it runs only on Growth.cancel_scheduled_prompt— cancel one bypromptId. Needs a paid plan. A run already going finishes.