๐คAPI Endpoints
POST /analyze/prompt
Analyze a prompt
POST
/analyze/prompt
Submit a prompt text for analysis and receive the scan results
Query Parameters
Name | Type | Description |
---|---|---|
prompt* | String | Prompt text to analyze |
POST /analyze/response
Analyze a prompt and response pair
POST
analyze/response
Submit a prompt and its LLM response for analysis
Query Parameters
Name | Type | Description |
---|---|---|
prompt* | String | Prompt text to analyze |
response* | String | Response text to analyze |
POST /canary/add
Add a canary token to a prompt
POST
canary/add
Add canary token to prompt to later check against /canary/check
Query Parameters
Name | Type | Description |
---|---|---|
prompt* | String | Prompt to add canary to |
always | Bool | Add prefix to prompt to always include canary in responses |
length | int | Canary token length (default: 16) |
header | String | Format string header for canary (default: |
POST /canary/check
Check response for presence of canary token
POST
canary/check
Query Parameters
Name | Type | Description |
---|---|---|
prompt* | String | Prompt to check for canary token |
POST /add/texts
Add new text to the vector database
POST
/add/texts
Submit text to the vector database (embedded at index time per config file)
Query Parameters
Name | Type | Description |
---|---|---|
texts* | List | List of text strings |
metadatas | List | List of metadata dictionaries |
GET /settings
View application settings
GET
/settings
Returns configuration file (excluding OpenAI API key)
Last updated