Skip to main content
GET
/
v1
/
topics
/
breakout
List Breakout Topics
curl --request GET \
  --url https://api.upriver.ai/v1/topics/breakout \
  --header 'X-API-Key: <api-key>'
{
  "topics": [
    {
      "topic_id": "<string>",
      "canonical_name": "<string>",
      "vertical": "<string>",
      "status": "<string>",
      "importance_score": 123,
      "discovered_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "category": "<string>",
      "tags": [
        "<string>"
      ],
      "confidence_score": 123,
      "relevance_score": 123,
      "source_summary": {},
      "citations": [
        {
          "source_category": "<string>",
          "source_url": "<string>",
          "title": "<string>",
          "snippet": "<string>",
          "source_authority": 123,
          "engagement_score": 123,
          "published_at": "2023-11-07T05:31:56Z"
        }
      ],
      "entities": [
        {
          "raw_mention": "<string>",
          "canonical_name": "<string>",
          "entity_type": "<string>",
          "confidence": 123,
          "resolution_tier": "<string>",
          "entity_id": "<string>"
        }
      ],
      "engagement": {
        "percentile_score": 123
      },
      "trend": {
        "momentum": 1.15,
        "direction": "rising"
      }
    }
  ],
  "total_count": 123,
  "next_cursor": "<string>"
}

Authorizations

X-API-Key
string
header
required

Query Parameters

tags
string[] | null

Filter by tags (OR by default). Examples: tags=tech, tags=ai&tags=nvidia

require_all_tags
boolean
default:false

If true, require ALL tags to match (AND logic)

vertical
string | null

Filter by vertical (legacy, prefer tags)

category
string | null

Filter by category (legacy, prefer tags)

status
string
default:active
min_importance
number | null
limit
integer
default:20
cursor
string | null
include_citations
boolean
default:false
use_dynamic_scoring
boolean
default:true

Response

Successful Response

Response for listing breakout topics.

topics
BreakoutTopicResponse · object[]
required

List of topics

total_count
integer
required

Total matching topics

next_cursor
string | null

Cursor for next page, if more results