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

ParameterTypeDescription
apiKeystringYour OpenAI API key
configurationobjectConfiguration options

Configuration Object

ParameterTypeDescriptionDefault
insightFrequencynumberMinimum number of conversation items before generating new insights5
flagAbusiveContentbooleanFlag potentially abusive or inappropriate contentfalse
flagAISafetyRisksbooleanIdentify potential AI safety risks or concerning AI behaviorsfalse
customHighlightInstructionsstringCustom 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 CodeDescription
400Invalid request body
401Invalid API key
500Server error

Notes

  • The insightFrequency cannot be set lower than the default value of 5.
  • Changes to the configuration will take effect on the next conversation or insight generation.