Echo Fine-tunes

Retrieve echo fine-tunes for the chatbot

GET https://api.sitespeak.ai/v1/{chatbot_id}/finetunes

Returns the echo fine-tunes for the chatbot. These are updated or text question and answers for your chatbot.

Path Parameters

Name	Type	Description
chatbot_id*	String	The ID of your chatbot. You can find the ID on the settings page for your chatbot.

Headers

Name	Type	Description
Accept*	String	application/json
Authorization*	String	Bearer {api_token}

200 Success

[
	{
		"id": "0d616a06-1dd4-4523-a741-20051c854938",
		"chatbot_id": "49d0204c-32f1-43c3-a1aa-6942f5737f43",
		"question": "What is SiteSpeakAI?",
		"suggested_answer": "SiteSpeakAI is a smart AI chatbot that can answer your visitors questions in realtime, saving you time and money on customer support costs.",
		"vector_id": "d18696f2-0142-4404-a362-96d542e3cb43",
		"created_at": "2024-06-26T13:09:22.000000Z",
		"updated_at": "2024-06-26T13:09:22.000000Z"
	},
	{
		...
	}
]

401 Permission denied

Create or update echo fine-tunes for the chatbot

POST https://api.sitespeak.ai/v1/{chatbot_id}/finetunes

Creates or updates an existing echo fine-tune for the chatbot.

Path Parameters

Name	Type	Description
chatbot_id*	String	The ID of your chatbot. You can find the ID on the settings page for your chatbot.

Headers

Name	Type	Description
Accept*	String	application/json
Authorization*	String	Bearer {api_token}

Body

Name	Type	Description
question*	String	Question that you would like to add an answer for.
suggested_answer*	String	The answer you would like your chatbot to respond with.

Response

200 Success

{
	"message": "Finetune created successfully",
	"finetune": {
		"question": "What is SiteSpeakAI?",
		"suggested_answer": "SiteSpeakAI is a smart AI chatbot that can answer your visitors questions in realtime, saving you time and money on customer support costs.",
		"vector_id": "d18696f2-0142-4404-a362-96d542e3cb43",
		"chatbot_id": "49d0204c-32f1-43c3-a1aa-6942f5737f43",
		"id": "0d616a06-1dd4-4523-a741-20051c854938",
		"updated_at": "2024-06-26T13:09:22.000000Z",
		"created_at": "2024-06-26T13:09:22.000000Z"
	}
}

Delete an echo fine-tune for the chatbot

DELETE https://api.sitespeak.ai/v1/{chatbot_id}/finetunes/{finetune_id}

Deletes an echo fine-tune for the chatbot.

Path Parameters

Name	Type	Description
chatbot_id*	String	The ID of your chatbot. You can find the ID on the settings page for your chatbot.
finetune_id*	String	The ID of the fine-tune you want to delete.

Headers

Name	Type	Description
Accept*	String	application/json
Authorization*	String	Bearer {api_token}

Response

200 Success

{
	"message": "Finetune deleted successfully"
}