Skip to navigation

Walk a label tree

Runs classify once per level of a nested label tree, on the same text, descending into the winning label each time. Returns the path, the deepest label, the compound probability and confidence (products over the levels), and one entry per level with its scores, the input it sent to the model and its inference time.

Send text for one result, texts for a batch wrapped as { results: [...] }, or image (one image, at most 5 MB decoded, optionally with text; never with texts). The response carries x-input-chars (input characters) and x-input-tokens (input tokens billed for this call) headers. Each item of texts (and each of statements or questions) counts as one request against the requests-per-minute limit. Each level re-sends the text, so latency grows with depth.

Authentication

AuthorizationBearer

A milliseconds API key, test_sk-{namespace}-{entropy} or prod_sk-{namespace}-{entropy}. Every /v1 route requires it.

Request

This endpoint expects an object.
treestring or objectRequired
textstringOptional1-20000 characters
The text to decide about.
textslist of stringsOptional

Batch form: one result per text.

imagestringOptional>=1 character

One image: a data:image/(jpeg|png|webp);base64, URL, or bare base64 of a JPEG, PNG or WebP. 5 MB decoded at most. URLs are never fetched. May travel with text (extra context), never with texts.

detailenumOptional

Image resolution: low 512 px, medium 768 px (default), high 1024 px longest edge. Higher sees more and bills more.

Allowed values:
questionstringOptional1-2000 characters

The question the model answers by choosing one label or level. Defaults to a generic one; a real rubric (what to look for, how to treat missing evidence) improves hard cases.

Response

Result, or { results } for a batch

ClassifyTreeResultobject
OR
object

Errors

400
Bad Request Error
502
Bad Gateway Error