# ProRata Documentation

> Documentation for ProRata

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Welcome to the Gist Developer Hub](https://platform.gist.ai/docs/about-gist-services.md)
- [Overview](https://platform.gist.ai/docs/ga-overview.md)
- [Quick Start To Install](https://platform.gist.ai/docs/quick-start-using-widgets.md)
- [Widget Usage Options](https://platform.gist.ai/docs/widget-usage-guidelines.md): How and where to display the Gist AI search box and Gist AI answers
- [Ads within Gist Answers](https://platform.gist.ai/docs/ads-within-gist-answers.md)
- [Customizing Look and Feel](https://platform.gist.ai/docs/customizing-look-and-feel.md)
- [Displaying search results on new page](https://platform.gist.ai/docs/displaying-search-results-on-new-page.md)
- [Ingestion Summary](https://platform.gist.ai/docs/ingestion-summary.md): Welcome to your comprehensive publication monitoring hub! The Ingestion Summary dashboard provides you with a complete, real-time overview of all publications currently connected to your Gist Console. This powerful tool allows you to effortlessly monitor ingestion activity, verify update schedules, and ensure all your valuable data sources remain fresh, accurate, and readily accessible.
- [Publications Management](https://platform.gist.ai/docs/publications-management.md): The Publications section allows users to view, edit, and add publications connected to the platform. Each publication represents a content source that can be ingested for AI Search or analytics purposes.
- [Analytics](https://platform.gist.ai/docs/analytics.md): Welcome to the Analytics section — your central hub for tracking content performance and engagement across all connected publications. Below you’ll find three dedicated analytics views, each focusing on a different level of insight.
- [Partner Summary Analytics](https://platform.gist.ai/docs/partner-summary.md): The Partner Summary dashboard provides a unified overview of performance metrics across all publications under a partner group. It helps publishers quickly assess engagement trends and content effectiveness across their network.
- [Publication Detail Analytics](https://platform.gist.ai/docs/publication-detail-analytics.md): The Publication Detail dashboard provides a focused view of performance metrics for a single publication, allowing teams to track engagement trends and content effectiveness over time.
- [Article Detail Analytics](https://platform.gist.ai/docs/article-detail-analytics.md): The Article Detail dashboard provides performance insights at the individual article level, making it easy to evaluate how specific stories resonate with audiences.
- [Analytics Pages Overview](https://platform.gist.ai/docs/analytics-pages-overview.md): The Analytics module provides insights into performance across partners, publications, and articles.
- [Overview](https://platform.gist.ai/docs/gcn-overview.md)
- [RSS Content Feeds](https://platform.gist.ai/docs/rss-feed-setup.md)
- [CMS Integration](https://platform.gist.ai/docs/cms-integration.md)
- [Gist Content API](https://platform.gist.ai/docs/gist-content-api.md): This document describes how publisher partners can push articles to ProRata using our ingest API. It supports both real-time article delivery and bulk ingestion for archived content.
- [File Transfer](https://platform.gist.ai/docs/file-transfer.md)
- [Gist Answers Content Policy](https://platform.gist.ai/docs/content-policy-for-gist-answers.md)
- [Gist Crawler Bot](https://platform.gist.ai/docs/prorata-ai-crawler-bot.md)

## API Reference
- [Get detailed service health status](https://platform.gist.ai/reference/get_v1-health.md): **Public Endpoint**: This endpoint is publicly accessible and does not require authentication. Returns detailed health status of the service and its dependencies.
- [Get publisher information](https://platform.gist.ai/reference/get_v1-publishers.md): **Authentication Required**: This endpoint requires a valid API key.  Returns information about the publisher group associated with your organization, including the publisher group ID, name, description, and a list of publisher IDs.  **Caching**: This endpoint uses Redis caching with a TTL of 1 hour. - First request fetches from the external service and caches the response - Subsequent requests within 1 hour return the cached data - Cache headers are included in the response
- [Get specific publisher details](https://platform.gist.ai/reference/get_v1-publishers-id.md): **Authentication Required**: This endpoint requires a valid API key.  Returns detailed information about a specific publisher identified by its ID. The publisher must be part of the publisher group associated with your organization.  **Caching**: This endpoint uses Redis caching with a TTL of 1 hour. - First request fetches from the external service and caches the response - Subsequent requests within 1 hour return the cached data - Cache headers are included in the response
- [Get recommended questions](https://platform.gist.ai/reference/get_v1-questions-recommended.md): **Authentication Required**: This endpoint requires a valid API key.  Returns a list of recommended questions for users to ask.  **Rate Limiting**: This endpoint is subject to rate limiting based on your organization's settings. The response headers will include: - `X-RateLimit-Limit`: Maximum requests allowed in the current time window - `X-RateLimit-Remaining`: Number of requests remaining - `X-RateLimit-Reset`: Unix timestamp when the rate limit resets
- [Get related questions](https://platform.gist.ai/reference/post_v1-questions-related.md): **Authentication Required**: This endpoint requires a valid API key.  Returns a list of questions related to the provided query.  **Rate Limiting**: This endpoint is subject to rate limiting based on your organization's settings. The response headers will include: - `X-RateLimit-Limit`: Maximum requests allowed in the current time window - `X-RateLimit-Remaining`: Number of requests remaining - `X-RateLimit-Reset`: Unix timestamp when the rate limit resets
- [Get service information](https://platform.gist.ai/reference/get_.md): **Public Endpoint**: This endpoint is publicly accessible and does not require authentication. Returns basic service status.
- [List all chat threads (Advanced)](https://platform.gist.ai/reference/get_v1-threads.md): **Authentication Required**: This endpoint requires a valid API key.  Returns a list of chat threads with optional pagination.  **Rate Limiting**: This endpoint is subject to rate limiting based on your organization's settings. The response headers will include: - `X-RateLimit-Limit`: Maximum requests allowed in the current time window - `X-RateLimit-Remaining`: Number of requests remaining - `X-RateLimit-Reset`: Unix timestamp when the rate limit resets
- [Get a specific thread (Advanced)](https://platform.gist.ai/reference/get_v1-threads-threadid.md): **Authentication Required**: This endpoint requires a valid API key.  Returns detailed information about a specific chat thread.  **Rate Limiting**: This endpoint is subject to rate limiting based on your organization's settings. The response headers will include: - `X-RateLimit-Limit`: Maximum requests allowed in the current time window - `X-RateLimit-Remaining`: Number of requests remaining - `X-RateLimit-Reset`: Unix timestamp when the rate limit resets
- [Delete a thread (Advanced)](https://platform.gist.ai/reference/delete_v1-threads-threadid.md): **Authentication Required**: This endpoint requires a valid API key.  Permanently deletes a chat thread and all its associated turns.  **Rate Limiting**: This endpoint is subject to rate limiting based on your organization's settings. The response headers will include: - `X-RateLimit-Limit`: Maximum requests allowed in the current time window - `X-RateLimit-Remaining`: Number of requests remaining - `X-RateLimit-Reset`: Unix timestamp when the rate limit resets
- [Create document summarization](https://platform.gist.ai/reference/post_v1-summaries.md): **Authentication Required**: This endpoint requires a valid API key (public or secret).  Creates a summarization request for the content found at the provided URL. The summary can be customized in terms of length, medium, and style.  **Domain Validation**: The URL domain must exactly match one of the publisher domains associated with your organization's publisher group. Subdomains are not automatically allowed - the exact domain must be authorized. This ensures that you can only summarize content from authorized publishers.  Use the returned summaryId with the /v1/summaries/{summaryId} endpoint to retrieve the streaming summary.  **Rate Limiting**: This endpoint is subject to rate limiting based on your organization's settings. The response headers will include: - `X-RateLimit-Limit`: Maximum requests allowed in the current time window - `X-RateLimit-Remaining`: Number of requests remaining - `X-RateLimit-Reset`: Unix timestamp when the rate limit resets
- [Stream a document summary](https://platform.gist.ai/reference/get_v1-summaries-summaryid.md): **Authentication Required**: This endpoint requires a valid API key (public or secret).  Streams the summary for a previously created summarization request. Use this with EventSource in browsers for easy streaming.  **Rate Limiting**: This endpoint is subject to rate limiting based on your organization's settings. The response headers will include: - `X-RateLimit-Limit`: Maximum requests allowed in the current time window - `X-RateLimit-Remaining`: Number of requests remaining - `X-RateLimit-Reset`: Unix timestamp when the rate limit resets