# llms.txt Source: https://docs.upriver.ai/ai/llmstxt Documentation index for LLMs and AI tools The [llms.txt file](https://llmstxt.org) is an industry standard that helps LLMs index content more efficiently, similar to how a sitemap helps search engines. AI tools can use this file to understand the Upriver documentation structure and find content relevant to user queries. Upriver hosts an `llms.txt` file at the root of the documentation site that lists all available pages. This file is always up to date and requires no maintenance. View the Upriver llms.txt at: [docs.upriver.ai/llms.txt](https://docs.upriver.ai/llms.txt) ## llms.txt structure An `llms.txt` file is a plain Markdown file that contains: * **Site title** as an H1 heading. * **Structured content sections** with links and a description of each page in the documentation. ```md Example llms.txt theme={null} # Upriver API Docs ## API Reference - [Brands](https://docs.upriver.ai/api-reference/brands): Search and retrieve brand data - [Creators](https://docs.upriver.ai/api-reference/creators): Look up creator profiles - [Audiences](https://docs.upriver.ai/api-reference/audiences): Analyze audience insights ``` This structured approach allows LLMs to efficiently process the documentation at a high level and locate relevant content for user queries. ## llms-full.txt The `llms-full.txt` file combines the entire Upriver documentation site into a single file as context for AI tools. View the Upriver llms-full.txt at: [docs.upriver.ai/llms-full.txt](https://docs.upriver.ai/llms-full.txt) # skill.md Source: https://docs.upriver.ai/ai/skillmd Give your AI agent the Upriver API reference The [`skill.md`](https://docs.upriver.ai/skill.md) file is a structured, machine-readable API reference that tells AI agents what they can do with the Upriver API. It follows the [skill.md specification](https://agentskills.io/specification) and includes endpoint descriptions, required parameters, and usage guidance in a format LLMs can reliably work with. View the Upriver skill.md at: [docs.upriver.ai/skill.md](https://docs.upriver.ai/skill.md) Both `skill.md` and `llms.txt` help agents work with the Upriver API, but they serve different purposes. * `skill.md` is a **capability summary**. It tells agents what actions are available, what inputs they need, and what constraints apply. * `llms.txt` is a **documentation index**. It lists available pages with descriptions so agents know where to find information. Use `skill.md` when you want agents to call the API directly. Use `llms.txt` when you want agents to browse the docs. ## Use skill.md with agents ### Skills CLI Agents can process the skill.md with the [skills CLI](https://www.npmjs.com/package/skills). ```bash theme={null} npx skills add https://docs.upriver.ai ``` ### Claude Code / OpenClaw Add the URL to your project context or reference it in a prompt: ```bash theme={null} curl -s https://docs.upriver.ai/skill.md >> AGENTS.md ``` ``` Use the Upriver API as described in https://docs.upriver.ai/skill.md ``` ### Cursor / Windsurf Add it as a doc in your project settings: 1. Go to **Settings → Docs** 2. Add `https://docs.upriver.ai/skill.md` ### ChatGPT / Claude.ai Paste the URL or file contents into your conversation: ``` Here's the API reference: https://docs.upriver.ai/skill.md Use it to help me call the Upriver API. ``` ### Any agent or framework Fetch it at build time or runtime: ```bash theme={null} curl -s https://docs.upriver.ai/skill.md ``` The file is plain Markdown. Works anywhere that accepts text context. ## What's in the file The skill.md includes: * **Metadata**: API name, description, and base URL. * **Authentication**: How to authenticate requests. * **Endpoints**: Available actions organized by resource (brands, creators, audiences, trends, etc). * **Parameters**: Required and optional inputs for each endpoint. * **Usage guidance**: Tips on how to chain endpoints and handle responses. # Dimensions Source: https://docs.upriver.ai/api-reference/audience/dimensions api-reference/openapi.json post /v1/audience_dimensions Extract atomic audience dimensions for a brand. Dimensions are the building blocks of personas. Returns granular behavioral, motivational, and lifestyle dimensions about relevant audiences for a specified brand. Each fact can be used for embedding-based matching with user profiles. **Verbosity** controls fact phrasing (applies only to the `fact` field): - `verbose`: Full sentences with subject (e.g., 'This audience seeks healthy recipes') - `standard` (default): Phrases without subject (e.g., 'seeks healthy recipes') - `compact`: Keywords only (e.g., 'healthy recipes') - for embeddings **Response includes:** - Audience dimensions with classification and confidence scores - Supporting evidence snippets (optional) # Personas Source: https://docs.upriver.ai/api-reference/audience/personas api-reference/openapi.json post /v2/audience_insights Get detailed audience personas with psychographics, behaviors, motivators, and barriers. Ideal for creative strategy, targeting, and understanding your audience at a psychological level. **Input:** Provide brand info, products, and industry context. Can chain output from Brand Research endpoint. **Output:** 3-5 distinct personas with personality traits, behavioral patterns, motivations, and barriers. **Citations Mode:** - `async` (recommended): Fast response, fetch citations separately via continuation token - `sync`: Include citations in response (slower) - `none`: No citations (fastest) # Personas - Citations Source: https://docs.upriver.ai/api-reference/audience/personas--citations api-reference/openapi.json get /v2/audience_insights/{continuation_token}/citations Retrieve citations and behavioral evidence for audience personas. Use the continuation token from the `v2/audience_insights` response. **Recommended Usage:** Set `citations_mode=async` in the audience insights request, then call this endpoint to retrieve citations separately. This keeps the initial response fast while allowing deep citation analysis. # Brand Details Source: https://docs.upriver.ai/api-reference/brands/brand-details api-reference/openapi.json post /v1/brand/research Provides details for a brand including identity, target audience, and brand language. Returns structured data optimized for chaining into the Audience Insights endpoint. **Input Options:** - Provide `brand_name` and/or `brand_url` - Use `auto` field for automatic brand extraction from natural text # Find Similar Topics Source: https://docs.upriver.ai/api-reference/breakout-topics/find-similar-topics api-reference/openapi.json post /v1/topics/breakout/similar Find topics similar to a given topic by embedding similarity. # Get Breakout Topic Source: https://docs.upriver.ai/api-reference/breakout-topics/get-breakout-topic api-reference/openapi.json get /v1/topics/breakout/{topic_id} Get a single breakout topic by ID. # Get Breakout Topics Metadata Source: https://docs.upriver.ai/api-reference/breakout-topics/get-breakout-topics-metadata api-reference/openapi.json get /v1/topics/breakout/metadata Get metadata about available verticals and categories for filtering. Returns the taxonomy of verticals and their associated categories, with human-readable display names for building filter UIs. # Get Meta-Topic Detail Source: https://docs.upriver.ai/api-reference/breakout-topics/get-meta-topic-detail api-reference/openapi.json get /v1/topics/breakout/meta/{meta_topic_id} Get a single meta-topic with member topics and direct citations. # List Breakout Topics Source: https://docs.upriver.ai/api-reference/breakout-topics/list-breakout-topics api-reference/openapi.json get /v1/topics/breakout List breakout topics with optional filters. Returns topics sorted by the specified sort order: - 'relevance' (default): Dynamic score with time decay, momentum, and confidence - 'importance': Static base importance score (no temporal factors) Args: status: Filter by status. - "active" (default): emerging, trending, declining - "all": all statuses including detected and archived - specific status: "detected", "emerging", "trending", "declining", "archived" # List Meta-Topics Source: https://docs.upriver.ai/api-reference/breakout-topics/list-meta-topics api-reference/openapi.json get /v1/topics/breakout/meta List meta-topics ranked by composite score. # Search Breakout Topics Source: https://docs.upriver.ai/api-reference/breakout-topics/search-breakout-topics api-reference/openapi.json post /v1/topics/breakout/search Search breakout topics using hybrid vector + keyword search. Supports three search modes: - vector: Semantic similarity search using embeddings - keyword: Full-text search using PostgreSQL tsvector - hybrid: Combined vector and keyword search (default) # Batch Creator Details Source: https://docs.upriver.ai/api-reference/creators/batch-creator-details api-reference/openapi.json post /v1/creators/batch Provides creator profile information for multiple creators in a single request. Returns associated channels and labels for each URL. **Input:** Provide 1-10 social media profile URLs (e.g., https://youtube.com/@handle) **Note:** Engagement metrics are not available for batch requests. # Creator Details Source: https://docs.upriver.ai/api-reference/creators/creator-details api-reference/openapi.json get /v1/creators Provides creator profile information including associated channels, labels (categories and tags), engagement metrics, and bio. **Optional Expansions (include parameter):** - `engagement_metrics`: Average views, likes, comments from recent content - `video_metrics`: Video duration and upload frequency for ad inventory - `bio`: Biographical summary and key facts about the creator # Get Creator by ID Source: https://docs.upriver.ai/api-reference/creators/get-creator-by-id api-reference/openapi.json get /v1/creators/{creator_id} Get a creator's profile using their stable Upriver creator ID. If the ID has been merged into another creator, the response includes redirect information and the X-Creator-Redirect header. # Product Details Source: https://docs.upriver.ai/api-reference/products/product-details api-reference/openapi.json post /v1/brand/product Provides details for a specific product including description, features, and pricing. **Input Options:** - **product_url**: The most accurate way to identify the product. - **brand_name + product_name**: Will attempt to find the official page automatically. **Effort Levels:** - **low**: fast extraction from the product page. - **high**: includes competitive research (alternatives). # Products Source: https://docs.upriver.ai/api-reference/products/products api-reference/openapi.json post /v1/brand/products Returns a list of products associated with a brand. Supports various input methods: - **auto**: Provide raw text for automatic brand/URL extraction - **brand_url + brand_name**: Provide both explicitly - **brand_url only**: Will attempt to determine brand name - **brand_name only**: Will search for official website first Response format: - **json**: Returns structured data with product list (default) - **text**: Returns natural language report The service prioritizes prominent and popular products from the brand's website. # Sponsors Source: https://docs.upriver.ai/api-reference/sponsorships/sponsors api-reference/openapi.json get /v1/sponsors Search for sponsors that recently advertised in media channels or publications. Can search by industry category or by publication URL. # Sponsorships Source: https://docs.upriver.ai/api-reference/sponsorships/sponsorships api-reference/openapi.json get /v1/sponsorships Return individual sponsored placements (content-level rows), filterable by brand or publication. # Media Categories Source: https://docs.upriver.ai/api-reference/taxonomy/media-categories api-reference/openapi.json get /v1/media_categories Returns the media categories split into L1 (top-level) and L2 (second-level) lists. These categories can be used as a filter for sponsors, sponsorships. and other endpoints which support filtering by categories. # Media Categories Search Source: https://docs.upriver.ai/api-reference/taxonomy/media-categories-search api-reference/openapi.json post /v1/categories/search Find the most relevant categories from the taxonomy for a given freeform text. Useful for discovering the best category for brand industries, target audiences, etc. Returns ordered matches with confidence scores. # Audio Playback Source: https://docs.upriver.ai/api-reference/trends/audio-playback api-reference/openapi.json get /v2/trends/{trend_id}/playback Return a playback URL for a trend's audio media # Media Samples Source: https://docs.upriver.ai/api-reference/trends/media-samples api-reference/openapi.json get /v2/trends/{trend_id}/media Returns video and audio url samples for a trend # Overview Source: https://docs.upriver.ai/api-reference/trends/overview api-reference/openapi.json post /v2/trends/broad Get the latest trending formats. # Search Source: https://docs.upriver.ai/api-reference/trends/search api-reference/openapi.json post /v1/trends/search Search TikTok trends for a given brand or category context. Supports brand_url classification similar to sponsors/search. # Trend Details Source: https://docs.upriver.ai/api-reference/trends/trend-details api-reference/openapi.json get /v2/trends/{trend_id} Get a specific trend by its id. **Optional Expansions (include parameter):** - `playback`: Include a playback URL for the trend's audio # Changelog Source: https://docs.upriver.ai/changelog Recent updates to the Upriver API # Changelog Stay up to date with the latest changes to the Upriver API. *** ## February 2026 ### Breakout Topics: Improved Grouping Related breakout topics are now grouped together, making it easier to follow a story across multiple angles. ### Creator API: Brand Safety Brand safety analysis is now available for creators. ### Creator API: Terminated Account Filtering Terminated creator accounts are now automatically excluded from API responses. ### Creator API: Engagement Metrics Latency Engagement metrics now return significantly faster. ### Trends API: Sound Duration Fields Trend responses now include a `sound_duration` field. ### Agent Skill & llms.txt Upriver docs now include [`skill.md`](/ai/skillmd) and [`llms.txt`](/ai/llmstxt) for AI agents and coding assistants. These files provide structured API guidance, endpoint descriptions, and recommended workflows so your AI tools can integrate Upriver more effectively. ### Creator API: YouTube Data Freshness Fixed an issue where YouTube creator follower counts could become stale and fail to refresh automatically. ### Audience Dimensions: Rate Limiting Added per-user rate limiting to the `/v1/audience_dimensions` endpoint to ensure fair usage and system stability. ### Creator API: Enhanced Video Metrics Creator video metrics now include `pct_over_8m` field showing the percentage of videos exceeding 8 minutes, useful for identifying long-form content creators. Also improved gaming category classification accuracy. ### Creator API: Real-Time Follower Counts Creator API now refreshes stale subscriber and follower counts at request time, ensuring you always get current audience size data. ### Creator API: Video Metrics Enrichment Added `include=video_metrics` parameter to creator endpoints. Get video duration and upload frequency data to estimate ad inventory opportunities. ### Audience Insights v3 New `/v3/audience_insights` endpoint with improved audience segmentation, simplified calling (just pass a `brand_url` instead of chaining endpoints), and a configurable `effort` parameter for faster or deeper analysis. ### Creator API: Twitch Metadata Improved Twitch metadata in API responses. ### TikTok Trends: Enhanced Metadata Trends API responses now include `tags` and `trend_type` fields for better trend categorization and filtering. ### Trends API: Duration Filtering Added duration filtering to trends endpoints. Filter TikTok trends by video length to find content that matches your target format. ### Breakout Topics: Politics Vertical Added Politics vertical to breakout topics filtering. Use the `/v1/breakout/metadata` endpoint to discover available verticals including the new Politics category. ### Trends API: Expanded Trend Types Trends endpoints now support additional trend type classifications for more granular filtering and discovery. ### Trends API: Individual Trend Lookup New GET `/v1/trends/{trend_id}` endpoint to retrieve a specific trend by ID with full trend details. ### Trends API: Optional Playback URLs Added `include=playback` parameter to trend endpoints. Audio playback URLs are now fetched on demand rather than included by default, reducing response times when playback data isn't needed. ### Trends Search: Enhanced Metadata Trends search results now include complete trend metadata (engagement stats, example videos, audio details) for richer context without requiring additional API calls. ### Breakout Topics: Citation Quality Improved citation quality with better deduplication of wire service articles across topics. ### Breakout Topics: Improved Sorting Control Replaced `use_dynamic_scoring` boolean with `sort_by` enum parameter. Choose `'relevance'` for time-sensitive trending topics or `'importance'` for stable base scores. ### Breakout Topics: Metadata Endpoint New `/v1/breakout/metadata` endpoint for discovering available verticals and categories to filter breakout topics. ### Breakout Topics: Field Rename Renamed `canonical_name` to `topic_name` in breakout topics responses. The old `canonical_name` field remains available but is deprecated. ### Creator API: Bio Enrichment Creator profiles now include biographical summaries. Use `include=bio` to get a concise summary of the creator's background and content focus. ```bash theme={null} GET /v1/creators?url=https://youtube.com/@MrBeast&include=bio ``` *** ## January 2026 ### Creator API: Enhanced Profile Data Creator API responses now include enriched profile metadata and primary publication identifiers for better creator identification and categorization. ### TikTok Trends: Improved Video Relevance Better video relevance scoring for more accurate trend recommendations. ### API Performance Improvements * 3x speed improvement to the `/v1/audience_dimensions` endpoint * Faster response times for `/v1/trends/broad` endpoint * Improved YouTube channel resolution performance ### Creator API: Duplicate Profiles Fixed an issue where the same YouTube channel could appear multiple times in search results. ### Breakout Topics: Multi-Label Classification Topics can now be tagged with multiple labels simultaneously, enabling more nuanced topic categorization and filtering. ### Breakout Topics: Relevance and Momentum Tracking Renamed `dynamic_score` to `relevance_score` for clarity. Added `trend` object to topic responses showing momentum indicators like velocity and acceleration for better understanding of topic trajectory. ### Breakout Topics: Enhanced Signal Quality * Improved Reddit signal filtering to exclude routine discussion threads * Added engagement scores to topic responses for better signal assessment * Expanded sports coverage in topic monitoring ### Breakout Topics: Volume-Aware Momentum Topic momentum scoring now adapts to conversation volume, providing more accurate trending signals across topics of different scales. ### Creator API: Labels and Tags Added `labels` field to Creator API responses with stable category classifications. Labels use the same taxonomy as `media_categories` for consistent categorization across the platform. The existing `tags` field continues to provide flexible, free-form tagging. ### Breakout Topics: Improved Scoring Better topic scoring with improved decay functions that adapt to the nature and popularity of each topic. ### Breakout Topics: Citations Added `include_citations` parameter to the breakout topics endpoint. When enabled, returns source URLs for each detected topic. ### Breakout Topics: Quality Improvements * More accurate topic deduplication * More accurate citation attribution * Added engagement scoring for better signal quality ### Brand Research API Brand research endpoints consolidated to the v1 API path. ### Creator API: Performance Major API performance improvements, especially for creators not previously tracked in our database. ### Breakout Topics API New API for discovering emerging trending topics across news and social media. ### Audience Dimensions API New `/v1/audience_dimensions` endpoint for structured audience profiling. ### Creator Batch Endpoint New `/v1/creators/batch` endpoint for bulk creator lookups. ### Creator API: GET Endpoint New GET `/v1/creators` endpoint for simplified creator lookups. ### Creator API: Engagement Metrics Creator responses now include engagement metrics such as average views, likes, and comments across platforms. Metrics are computed from recent content and cached for performance. ### Creator API: Categories Creator search results now include media categories and taxonomy classification. *** ## December 2025 ### Trends Search API New trend search endpoint for finding relevant TikTok trends by keyword. ### Sponsors Search API New `/v1/sponsors/search` and `/v1/sponsorships/search` endpoints. Search by brand URL for sponsorship data. ### Per-Result Pricing Flexible per-result billing for products, sponsors, and trends endpoints. ### Trends: Audio Playback Added `playback_url` for audio trend samples. *** ## November 2025 ### Product Research API Improved product deduplication and filtering. Brand name search support for sponsors. ### Products API: Enhanced Search Parallel search mode using multiple data providers. Response caching for faster lookups. ### Products API: Pagination Added cursor-based pagination for products endpoint. Improved product result ranking. ### Categories Search API New `/v1/categories/search` endpoint to explore media categories. ### Trends Matching API New `/v1/trends/match` endpoint to find relevant TikTok trends for brands. ### Creator Search API New `/v1/creators/search` endpoint to discover creators. Cross-platform profile resolution for YouTube, Instagram, TikTok, Twitter, and Twitch. Includes subscriber counts and profile metadata. ### Brand Research API New `/v1/brand/research` endpoint for comprehensive brand intelligence. Returns brand overview, target audience, and positioning. *** ## October 2025 ### Audience Insights v2: Personas New `/v2/audience_insights` endpoint with improved persona generation. Includes personality traits and behavioral insights. Separate citations endpoint for source attribution. ### Sponsors API: Enhanced Data Added brand domain and LinkedIn URL to sponsor responses. ### Sponsors API: Categories Filter sponsorships by media categories. ### Categories API New `/v1/categories` endpoint to browse the media category taxonomy. ### Sponsors API: Performance Major performance improvements for sponsor and sponsorship lookups. ### TikTok Trends: Scoring Enhanced trend scoring with engagement metrics. Audio and video quality scoring. *** ## September 2025 ### Products API New `/v1/brand/products` endpoint to discover products from brand websites. ### TikTok Trends API New `/v1/trends/broad` endpoint for discovering trending TikTok content. Audio and video trend samples with usage instructions. Pagination support. ### Sponsor Discovery API New `/v1/sponsors` endpoint to discover brands sponsoring content. New `/v1/sponsorships` endpoint for detailed sponsorship data. Industry and URL-based filtering. ### Audience Insights: Citations Added citation finding capability with source URLs. Enhanced creative guidance with citations. ### Audience Insights: Schema Improvements Simplified response schema with cleaner field naming. Updated personality and psychology field structures. # Introduction Source: https://docs.upriver.ai/index Structured social context for AI applications ## What is Upriver? [Upriver](https://upriver.ai/?ref=docs) provides an API that turns what's happening online into real-time, reliable context for AI applications. ## Core Features Upriver specializes in evidence-backed analysis on norms, influences, and aesthetics that come from online communities. * Brands: brands and how they're being discussed * Products: product mentions and use cases * Creators: relevant creators and social profiles * Audiences: personas, interests, language, and humor * Trends: topics and formats gaining attention * Sponsorships: Brand-creator relationships and placements ## Popular Use Cases Developers blend Upriver's external data with internal data for uses cases like: Ground AI outputs in what people actually care about Power discovery and recommendations using relevance signals Identify relevant brands, creators, or audiences Surface our insights directly to end users ## For Agents + LLMs Building with agents or coding assistants? Give them the skill.md and they can use the API directly. Structured capabilities file for agents Documentation index for LLMs ## Get Started To get an API key, schedule an intro call: 20-minute intro call to discuss your use case and learn how Upriver can help.