Comma Summa API Documentation
API Overview
– We do not allow public API access.
– Agreement to the Small Footprint Media API Terms and Conditions is required.
– We authenticate on the server side using a simple API token key and password secret.
– Only we can generate and provide an API token and secret.
– A user can only have a single valid API token and secret per account.
– Rate limiting is done using a rolling 30 day ceiling for each API endpoint.
– A 200,000 character limit is applied to the entire submission.
– All submissions must be converted to JSON.
The /commentsummary/ Endpoint
* ‘api-token’ (posted in Header)
* ‘api-secret’ (posted in Header)
* ‘type’ = the comment summary method being requested (posted in Body)
– ‘pnn’ = fixed request for a summary containing positive, neutral and negative narrative components
– ‘general’ = fixed request for a general summary
– ‘custom’ = a custom request including the requested response format (e.g. plain text, HTML etc.)
* ‘comments’ = the content to be summarized (posted in Body)
– submissions must be in JSON format
– submissions are truncated at 100,000 characters for processing
* ‘request’ = the request to be used when ‘type’ = ‘custom’ (posted in Body)
– submissions must be in JSON format
– submissions are truncated at 2500 characters for processing
– if the response is requested in HTML format it is suggested to add the following to the ‘request’ string: ‘Format the response in basic HTML. Return raw HTML only. Do not wrap the response in markdown code blocks. Do not include “`html or “` markers. Do not include back slashes.’
The /commentsummary/ Endpoint Response Parameters Are The Following
* ‘status’ = see codes below
* ‘message’ = see codes below
* type pnn response
– ‘positive_summary’ = a summary of the positive content in the submission formatted in plain text
– ‘neutral_summary’ = a summary of the neutral content in the submission formatted in plain text
– ‘negative_summary’ = a summary of the negative content in the submission formatted in plain text
* type general response
– ‘general_summary’ = a general summary of the submitted content formatted in plain text
* type custom response
– ‘custom_summary’ = a response guided by the request submitted including the requested format (e.g. plain text, HTML etc.)
– the response is limited to 10,000 characters
The /commentsummary/ Endpoint Response Codes Are The Following
* 200 = “request success”
* 400 = “syntax failure” => bad request syntax
* 400 = “type required” => no type submitted
* 400 = “type invalid” => type submitted not recognized
* 400 = “comments required” => no comments submitted
* 400 = “request required” => no request submitted when type is ‘custom’
* 401 = “invalid credentials” => unrecognized API Token and/or Secret
* 403 = “forbidden” => not authorized to request endpoint
* 413 = “payload too large” => 200k character limit exceeded
* 429 = “exceeded rate limit” => exceeded per second, per day, per month or other limits
* 500 = “server error” => internal server or other error
/commentsummary/ Endpoint Pricing
– Contact us regarding your use case and volume needs.
How Do I Get API Support?
For support on using our API contact us.