v1

latestOpenAPI 3.0.12026-07-269427.8 KB

Assistant message

Generates a response message from the assistant for the specified domain. Compatible with AI SDK v5+.

Authenticate with an assistant API key.

post/v2/assistant/{domain}/message

Path parameters

domainstring required

The domain identifier from your domain.mintlify.site URL. Can be found at the end of your dashboard URL. For example, app.mintlify.com/organization/domain has a domain identifier of domain.

Request body

fpstring required

Fingerprint identifier for tracking conversation sessions. Use anonymous for anonymous users or provide a unique user identifier.

threadIdstring

An optional identifier used to maintain conversation continuity across multiple messages. When provided, it allows the system to associate follow-up messages with the same conversation thread. The threadId is returned in the response as event.threadId when event.type === 'finish'.

retrievalPageSizenumber

Number of documentation search results to use for generating the response. Higher values provide more context but may increase response time. Recommended: 5.

currentPathstring

The path of the page the user is currently viewing. When provided, the assistant uses this context to provide more relevant answers. Maximum length: 200 characters.

Response

Message generated successfully

object required

Streaming response compatible with AI SDK v5. Use the useChat hook from @ai-sdk/react to handle the response stream.