Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Your key id, VFN_TEST_… or VFN_LIVE_…. Sent on every request.

x-secret-key
string
header
required

Your secret, VFN_SK_…. Not a real header, and never sent to the API. It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send x-api-key, x-timestamp and x-signature (see Authentication).

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the first answer (kept 24 h). Leave empty in Try it: a new one is made for every call.

Maximum string length: 255

Body

application/json
texts
string[]
required
Required array length: 1 - 20 elements
Required string length: 1 - 200
collar
enum<string>
Available options:
blue,
grey,
white
top_k
integer
default:3
Required range: 1 <= x <= 3

Response

One result per text, in the order sent

success
boolean
message
string
data
object