What APIs does Scrunch offer and how do they work?
- Also asked as:
- Does Scrunch support API integration?
- How do I connect to Scrunch via API?
Scrunch offers two APIs: a query API and a responses API. The query API captures aggregated metrics related to brand presence, sentiment, citations, and more from prompts across AI platforms. The responses API captures raw AI responses, including full text, citations, and brand presence data for each prompt.
Example
For example, if a Scrunch user wants to create an API key, they would use the “Add API key” button in the API keys section of the Settings menu.
If experiencing authentication errors: Scrunch uses bearer token authentication, wherein tokens can be scoped to single brands or multiple brands within an organization:
curl -H "Authorization: Bearer ${SCRUNCH_API_TOKEN}" \
https://api.scrunchai.com/v1/${BRAND_ID}/query?fields=brand_presence_percentage
Make sure your bearer token is active in the API keys section of the Settings menu and hasn't expired or been revoked.
If data collection is delayed: Scrunch automatically begins collecting responses after a user creates a brand and adds prompts. Smaller organizations should wait 20-60 minutes before retrieving data. Larger organizations may need to wait up to 12 hours for initial collection.
Follow-up question: How does Scrunch bill for API usage?
Scrunch charges based on the number of AI responses collected, not the number of API calls made. This means costs only increase when you add more brands, prompts, or AI platforms to track in Scrunch.