POST
/
smart

Before You Get Started

To register for usage of our Smart API, please reach out via email at api@you.com.

Authorizations

X-API-Key
string
header
required

Body

application/json
chat_id
string

A hexadecimal UUID to maintain continuity within the conversation. This can be a randomly generated string that uniquely identifies the session.

instructions
string

Custom commands that allow you to tailor the responses to meet specific requirements or preferences. By providing detailed instructions, you can control the assistant’s tone, style, format, depth of information, and other response characteristics. This enables you to customize responses for different audiences, contexts, or purposes. Instructions up to 2.5K characters are supported by default. For longer instructions—up to 25K characters—custom pricing is available upon request at api@you.com.

query
string

The main question or statement to be answered. This input directs the scope and context of the response.

Response

200 - application/json
answer
string

The main response generated by the API based on the provided query and instructions.

search_results
object[]