Messaging

POST `/api/v1/messages`

Send and receive messages from your chatbot.

Params

JSON request body.

clientId string required
Your client ID from your dashboard.

message string required
Prompt message to your chatbot.

stream boolean (default: false)
Whether to stream the response or respond with JSON.

messages message

Message history that can be used for context.

Response

Response can be in one of the following status codes:

Success 200

For immiediate responses.

{
  "success": true,
  "content": "Chatbot's response"
}

For stream responses use the stream parameter and listen to the response stream. Example

Forbidden 403

This code is returned if the request is coming from a domain that is not set up as your website. This does not apply to requests coming from localhost.
If you didn’t provide a website url in your dashboard, all requests will be accepted.

{
    "success": false,
    "message": "Invalid origin"
}

Set up your website url in your dashboard.

Invalid data 422

{
    "success": false,
    "issues": []
}

💡

The issues array contains validation errors reported by Valibot. For more details on the format and types of issues, refer to Valibot’s documentation.

Example validation error

{
	"success": false,
	"issues": [
		{
			"kind": "schema",
			"type": "custom",
			"input": "test",
			"expected": "unknown",
			"received": "\"test\"",
			"message": "Invalid clientId",
			"path": [
				{
					"type": "object",
					"origin": "value",
					"input": {
						"clientId": "test",
						"message": "Hello world"
					},
					"key": "clientId",
					"value": "test"
				}
			]
		}
	]
}

For invalid clientId.

Rate limit 429

{
    "success": false,
}

Learn more about rate limits here.

Example

Examples which can be used in the browser.

const response = await fetch('http://chatfolio.me/api/v1/messages', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        message: 'Hello.',
        clientId: 'CLIENT_ID',
    })
});
const { content } = await response.json();
 
console.log(content);

Message

Message type used for history.

interface Message {
    role: 'user' | 'assistant' | 'system';
    content: string;
}

Get Started Rate Limits