Skip to main content
In the Unit API menu, you can run Unit API calls and see the results without writing code, and manage all Unit API call history and the key for your project. For integration details, see Get Started with Unit API.

​
Opening the menu

Open your project and select Unit API at the bottom of the left menu.

​
Permissions by role

  • For Guests, the run button is disabled, and the key panel shows a notice that only Members and above can view the API key instead of the key. If you need to run calls, ask a project Owner or Leader for the Member role or higher.
  • For roles, see Admin roles and permissions.

​
Project status

The project status and what it allows are shown at the top of the screen.
  • The trial limit of 10 calls per month includes calls that ended in an error and calls rejected for exceeding the limit.
  • The limit resets at 00:00 UTC on the first day of each month.

​
API Test

Pick an API, enter values, and run it to see a result processed exactly like a real integration call.
  1. In API Test, pick an API. The price per API and the expected credit deduction are shown.
  2. Before running, you can see the endpoint, a request example (cURL), and a link to the developer guide. The key and images appear as placeholders.
  3. Enter values and select Run. The previous result is cleared from the screen at that moment.
  4. Check the result.
    • Processed: result values, credits deducted, TX ID
    • Error: an error message and code, a “not deducted” label, TX ID
  5. Copy the request example (cURL) and integrate it into your service with the Unit API key.
  • For ID-OCR, choosing an issuing country leaves only the ID types supported in that country.
  • Each image can be up to 3 MB.
Calls run from API Test are billed the same way as real calls, and the user who ran them is recorded in the call history. For trial projects, they also count toward the 10-calls-per-month limit.
Even for testing, you need a lawful basis, such as the data subject’s consent, to use real personal information. Results are not stored, so copy any result you need right away.

​
Call history

Live calls (made directly with the API key) and API Test calls are listed together, newest first. It can take a few tens of seconds for a call to appear.

​
Filters

​
List columns

​
Downloading CSV

Download the call history matching the current filters as CSV. Large results are split into multiple files.
  • Times in the CSV are raw UTC values, so you can match them against your logs down to the millisecond.
  • The CSV has a referenceId column. You cannot search by referenceId on screen, so download the CSV to find a call by referenceId.
When a customer contacts you, paste the TX ID from your logs into the call history to check the result, processing time, and credits right away. If errors are concentrated on one API and were not deducted, the source may be under maintenance.

​
Unit API key

The project key used for Unit API calls. It is issued automatically when the project is created, and there is no separate issuance screen.
  • Copy: The key is shown masked; use the copy button to copy the full key. Only Members and above can view it.
  • Key history: For each key, the status (active or revoked), issue time, who issued it, reason, and revocation time are shown. The issuer of the first key may appear as SYSTEM.
  • Reissue: Only an Owner or Leader can reissue. Reissuing revokes the previous key immediately, and calls with that key are rejected with 401 INVALID_API_KEY. The reissue is also recorded in the Event Log.
Right after reissuing, every server still using the previous key will fail. Prepare to deploy the new key to all servers before reissuing.
The emergency stop in project settings does not apply to Unit API calls. If the key is exposed or misuse is suspected, reissue the key.

​
Statistics

In the Unit API tab of the Statistics menu, you can see call counts, the success rate, credits deducted, usage by API, and usage by user over a period.

​
Good to know

  • Only calls that return a result are billed. A MISMATCH from a source is still a result, so it is billed. Calls that end in an error are not billed. Billing
  • Request and response contents are not stored. Call records (time, result, credits, and so on) are kept for 3 years.
  • Only scores and measurements are returned. You decide the pass threshold.
  • Every Unit API is available in every region.