Skip to main content
Use this endpoint to have a synchronous back-and-forth conversation with your Botsify AI agent. You identify the user session with an fbId, optionally provide prior message history for context, and the API returns the agent’s complete reply in a single response. This is the standard choice when you need a full answer before rendering anything to the user.

Request

POST https://app.botsify.com/api/v1/converse Authorization: Bearer token — include your token in the Authorization: Bearer <token> header.

Body Parameters

string
required
The unique key that identifies your bot. You can find this in your Botsify dashboard under bot settings.
string
required
A unique identifier for the user’s session. This is used to maintain conversation context across multiple turns. You can use any stable string that uniquely identifies the user (e.g. a Facebook user ID, an internal user ID, or a UUID).
string
A serialized string representing the current conversation context to be used for this turn. Useful when you maintain context state on your own side.
object[]
An array of message objects representing the conversation history to provide as context. Each object should include a role ("user" or "assistant") and a content string.
string
Additional text to append to the prompt before it is sent to the agent. Useful for injecting dynamic context such as user attributes or retrieved data.

Example

Response

A successful request returns 200 OK with the agent’s reply and updated session metadata.