The Apps API is in beta. Its endpoints and responses may change.
Setup steps
Setup moves through steps, and the agent waits at each one for your approval. To set up the Marketing Agent:- Call Start Marketing Agent setup. The work runs in the background.
- Poll Get Marketing Agent state until
statusisreadyorerror. Setup then waits at asetup_stageofchannels. - Approve each step with Answer Marketing Agent setup step, or ask for changes with Send Marketing Agent message. The steps are
channels,kpis, andbudget. - After the budget step, the agent writes the strategy. Poll the state again until
statusisready.
Endpoints
- Start Marketing Agent setup: Start setup, which drafts channels and KPIs.
- Answer Marketing Agent setup step: Approve the step the agent is waiting on.
- Get Marketing Agent state: Read the agent’s plan and the state of its latest run.
- Send Marketing Agent message: Send a message and start the turn that answers it.