Get Breakout Entity - Upriver API Docs

GET

entities

{entity_id}

breakout

Get Breakout Entity

curl --request GET \
  --url https://api.upriver.ai/v1/entities/{entity_id}/breakout \
  --header 'X-API-Key: <api-key>'

{
  "entity_id": "<string>",
  "name": "<string>",
  "entity_type": "<string>",
  "velocity": 123,
  "trend_direction": "<string>",
  "topics": [
    {
      "topic_id": "<string>",
      "name": "<string>",
      "citations": [
        {
          "title": "<string>",
          "url": "<string>",
          "source_type": "<string>"
        }
      ]
    }
  ],
  "timeline": [
    {
      "day": "<string>",
      "topic_count": 123
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Path Parameters

entity_id

string

required

Opaque entity identifier

Response

Successful Response

A single entity's current breaking topics and recent activity.

There is no ranking score here — that value is only meaningful in the ranked list context, not for a single-entity fetch.

entity_id

string

required

Opaque identifier for this entity

name

string

required

Entity display name

entity_type

string

required

Entity kind: 'player' or 'team'

velocity

number

required

Recent activity relative to the entity's own typical level

trend_direction

string

required

'rising', 'steady', or 'cooling'

topics

EntityTopicRef · object[]

The entity's current breaking topics

Show child attributes

timeline

EntityTimelineBucket · object[]

Recent daily activity for this entity

Show child attributes

List Breakout TopicsList 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)

⌘I

Get Breakout Entity

curl --request GET \
  --url https://api.upriver.ai/v1/entities/{entity_id}/breakout \
  --header 'X-API-Key: <api-key>'

{
  "entity_id": "<string>",
  "name": "<string>",
  "entity_type": "<string>",
  "velocity": 123,
  "trend_direction": "<string>",
  "topics": [
    {
      "topic_id": "<string>",
      "name": "<string>",
      "citations": [
        {
          "title": "<string>",
          "url": "<string>",
          "source_type": "<string>"
        }
      ]
    }
  ],
  "timeline": [
    {
      "day": "<string>",
      "topic_count": 123
    }
  ]
}