API Documentation
Overview
The v1 Knowatoa API provides read access to your AI search visibility data, including topics, series, and rankings information.
Authentication
All API requests require authentication using an API key. Include your API key as a query parameter in all requests:
?api_key=YOUR_API_KEY
API keys can be generated and managed from your account settings.
Base URL
All API endpoints are relative to: https://knowatoa.com/api/v1/
Response Format
All responses are returned in JSON format.
Error Handling
The API uses standard HTTP status codes to indicate success or failure:
200 OK
- Request successful401 Unauthorized
- Invalid or missing API key403 Forbidden
- Access denied to the requested resource404 Not Found
- Resource not found500 Internal Server Error
- Server error
Error responses include a JSON object with an error
field: json { "error": "Error message description" }
Rate Limiting
API requests are subject to reasonable rate limits. Please contact support if you have issues.
Available Endpoints
- GET /topics - List all topics for your account
- GET /series - List all series available to your account
- GET /topics/:topic_id/series/:series_id/latest - Get latest rankings for a topic and series