The FIY API can change over time as we release updates to our services.
There are two key components to the API, Authentication and Querying. Every customer message that requires a response should be posted to the API as a Query.
FIY uses API keys to authenticate your requests. You can obtain an API key when you complete onboarding onto the platform.
Your key will look like fiy_key_4eC39HqLyjWDarjtT1zdp7dc
Your customer's messages can be passed to the FIY API as queries. Every conversation should include a uniquely generated conversation_id. We recommend using uuid v4 to generate this value.
Include the brand and product number if you have that information. It will improve the quality of the generated response.
The product manufacturer. This should represent that value you define as brand in your index.
A unique alphanumeric value to distinctly classify the conversations that are tied to a single conversation thread.
This takes an alphanumeric string, corresponds to whatever you define as product number in your index.
The customer's message or question.