Classification

Classify entities

Fetch classification on demand for up to 100 entities (by twitter_user_ids and/or usernames, combined max 100): AI classification with your custom rules and custom tags merged in. Served from the classification cache; entities not in the cache are silently omitted. Costs 16 credits per entity actually returned, so zero results cost 0 credits.

post/classify

Request

  • Base URL: https://frontrun.vc/v1
  • URL: https://frontrun.vc/v1/classify
  • Auth: API key in header X-API-Key

Request body

twitter_user_idsstring[]

Entity X user IDs.

usernamesstring[]

Entity X usernames.

handlesstring[]

Alias for usernames.

max_creditsinteger

Ceiling on what this single call may cost, in credits. FAILS CLOSED: checked against the maximum the call could cost before any billable work runs, so if it would exceed the ceiling nothing is computed and nothing is charged (400, error_code max_credits_exceeded, with max_cost_credits telling you the real number). You are still billed only for what was actually computed, so a call that clears the ceiling usually lands under it. Relevant here because cost is 16 credits per entity found and the ceiling is 100 entities (1,600 credits).

Response

Classified entities.

totalinteger
cost_creditsinteger

Credits charged for this call.

balance_creditsinteger

Remaining credit balance after this call.

max_cost_creditsinteger

The most this call could have cost with the parameters you sent. Budget the next call against it. cost_credits is what you were actually charged.

Changes

No recorded changes to this operation across all 2 revisions of this API.