Common APIs

These are the APIs you’ll call most often when building your integration. The API reference documents every field and payload in full, including less commonly used endpoints not listed here. For the version endpoints together, with the call sequence and when to use each, see Versions and rollback.

Endpoint	When you need it
Create app	Create an app from a prompt.
Send chat message	Every prompt after the first.
Get app	Poll for the state of a build.
Read conversation messages	Get the transcript, and find a tool call that is waiting.
Submit tool-call input	Answer a waiting question and resume the turn.
Submit tool-call input (batch)	Answer several waiting questions with one decision.
Get preview URL	Let a builder see unpublished changes before you deploy.
Deploy an app	Publish an app.
Get published URL	Get a link to a live app.
Provision app user	Give an end user access to an app before embedding it.
Mint embed sign-in token	Open an embedded app signed in as the end user.
List apps	Show a builder the apps they already have.
Stop generation	Give the builder a cancel button.
Undo message	Roll the app back to before a message.
Edit and resend	Let a builder reword a prompt and run the turn again.
List checkpoints	Show saved versions, and pick one to preview, restore, or deploy.
Restore checkpoint	Return the editor to a saved version. Publishes nothing.
Retry checkpoint build	Rebuild a version’s preview after it failed.
Create checkpoint	Save a named version after changing an app outside a turn.
Update security headers	Lift the frame block on a remixed app you embed.
Set secret	Put your own API keys into an app’s backend functions.
Export app source code	Hand a builder the code, or keep your own copy.

Start here

Configure

Build an app