Configuration API
Configuration API
Customize your Squiggle experience
Configuration API
The Configuration API allows you to customize how Squiggle generates insights for your conversations.
Endpoint
POST https://api.squiggle.ai/api/configure
Request Body
| Parameter | Type | Description |
|---|---|---|
| apiKey | string | Your OpenAI API key |
| configuration | object | Configuration options |
Configuration Object
| Parameter | Type | Description | Default |
|---|---|---|---|
| insightFrequency | number | Minimum number of conversation items before generating new insights | 5 |
| flagAbusiveContent | boolean | Flag potentially abusive or inappropriate content | false |
| flagAISafetyRisks | boolean | Identify potential AI safety risks or concerning AI behaviors | false |
| customHighlightInstructions | string | Custom instructions for extracting conversation highlights | "" |
Example Request
{
"apiKey": "your-squiggle-api-key",
"configuration": {
"insightFrequency": 10,
"flagAbusiveContent": true,
"flagAISafetyRisks": true,
"customHighlightInstructions": "Extract quotes related to customer pain points"
}
}
Response
A successful request will return a 200 OK status with a JSON object containing a success message.
{
"message": "Configuration updated successfully",
}
Error Responses
| Status Code | Description |
|---|---|
| 400 | Invalid request body |
| 401 | Invalid API key |
| 500 | Server error |
Notes
- The
insightFrequencycannot be set lower than the default value of 5. - Changes to the configuration will take effect on the next conversation or insight generation.