Hirak Site Hirak FaceAPI

What authentication does the Hirak FaceAPI use?

Hirak FaceAPI is distributed via RapidAPI and authenticated with the X-RapidAPI-Key header. Through Jentic, the key is held in your Jentic One instance and injected at execution time so the raw RapidAPI key never enters the agent context.

Can I compare two faces for similarity?

Yes. POST /compare accepts two images and returns a similarity score that can be thresholded to decide if they are the same person. Combine with POST /detect first if you need to confirm both inputs contain a face before comparison.

What are the rate limits for the Hirak FaceAPI?

RapidAPI plan tiers govern throughput; the OpenAPI spec does not declare specific limits. Check your RapidAPI subscription for monthly quotas and queue large image-batch jobs to stay within plan limits.

How do I run face detection through Jentic?

Run pip install jentic, then await client.search('detect faces in an image'), load the POST /detect schema, and execute with the image payload. The response contains bounding boxes for any faces found.

Does Hirak FaceAPI store the face encodings I generate?

No. POST /encode returns a vector to the caller; storage is the integrator's responsibility. Persist encodings in your own vector store and call /encode again on each new candidate image to get a comparable vector.

Can I limit what my agent is allowed to do with the Hirak FaceAPI?

Yes. Because you run Jentic One yourself, your own rules decide which of the five Hirak FaceAPI operations the agent may call. The API takes image data in the request body rather than exposing scopable resource ids, so scoping happens at the operation level: you can allow only POST /detect and POST /compare for a verification flow, for example, and leave POST /landmarks, POST /analyze, and POST /encode unavailable. The agent can call an operation only if you include it in that set, and your X-RapidAPI-Key stays in your own instance and is injected at execution time.