# Getting Started with Hirize

Hirize uses API keys to authenticate your requests. You can securely interact with our API endpoints by including your <mark style="color:green;background-color:yellow;">api\_key</mark> as a query parameter.&#x20;

Our parser supports all document formats (PDF, JPG, PNG and more) it includes OCR capabilities, enabling precise data extraction across diverse workflows.

***

### Obtaining Your API Key

1. **Create an Account**\
   Register at <https://app.hirize.hr/> register by providing the necessary information. Upon registration, your organization is automatically created for you.
2. **Generate API Key**\
   After logging in, navigate to the <mark style="color:purple;">**\</> End Points**</mark> page on your dashboard. Next click the <mark style="color:purple;">**Generate a new API Key**</mark> button.&#x20;
3. **API Endpoint Key**\
   Once you're at the New End-point page; \
   1\. Give the Endpoint you want to create a name e.g Hirize HR parser\
   2\. <mark style="color:purple;">Webhook URL you can insert #</mark> \
   3\. Select the API end-point you would like to use from the dropdown. e.g Hirize Fin (invoice parser)\
   4\. <mark style="color:purple;">Hit create endpoint</mark> and copy the key\
   \
   Once generated, copy and securely store your API key, as it will be required for all API interactions.

<div data-full-width="false"><figure><img src="/files/OIr6grIQVL4Oth7Y77tl" alt="Go to End Points page"><figcaption><p><strong>Go to end-points page</strong></p></figcaption></figure></div>

<figure><img src="/files/4aLkLtpnM4Heg4V2lD6L" alt=""><figcaption><p>Create Key</p></figcaption></figure>

<figure><img src="/files/AJO7OT2IznqZtOjLVlNX" alt=""><figcaption></figcaption></figure>

### Using Your API Key

*<mark style="background-color:purple;">\*Make sure you have a Postman account if you do not have one create one here:</mark>* [*<mark style="color:purple;background-color:purple;">**POSTMAN**</mark>*](https://www.postman.com/)\
[*<mark style="background-color:purple;">https://www.postman.com/</mark>*](https://www.postman.com/)

Head to documentation, you can find the link here too: [<mark style="color:purple;background-color:purple;">**DOCUMENTATION**</mark> ](https://documenter.getpostman.com/view/25317643/2s8ZDSb5Ha#15a76c1f-766e-4f01-86d0-b210b54274f8)

1. Select Run in Postman and select Postman for Web, you will then select your workspace and hit import.&#x20;

<figure><img src="/files/ejEgRxtRvbmfUvuuLbF5" alt=""><figcaption><p>Run in postman and select postman for web</p></figcaption></figure>

<figure><img src="/files/knlB2X7DQw3oP5NLjBWU" alt=""><figcaption><p>Select workspace and hit import</p></figcaption></figure>

*<mark style="background-color:purple;">Make sure you've selected the public environment and authenticate your API requests!</mark>*<br>

2. To authenticate your API requests, include your API key as a query parameter in each request. <mark style="color:purple;background-color:purple;">Make sure you hit Save!</mark>

<figure><img src="/files/ouT7icLDykjQG7eTmspq" alt=""><figcaption></figcaption></figure>

3. Replace <mark style="color:green;background-color:yellow;">**\<Your\_API\_Key>**</mark> with the API key you generated in the previous step and hit **SEND** <mark style="color:purple;background-color:purple;">to finish your setup</mark>

<figure><img src="/files/kWLURU0R1q0FOiTbxHOT" alt=""><figcaption></figcaption></figure>

### **Best Practices**

* Use Environment Variables: Store your API keys in environment variables rather than hardcoding them in your applications.
* Keep It Secure: Treat your API key like a password. Do not share it publicly or expose it in client-side code.
* For each product add the KEY under each product
* If you want to integrate on code level <mark style="background-color:red;">Here's a basic example using curl</mark> Replace <mark style="color:green;background-color:yellow;">**\<Your\_API\_Key>**</mark> with the API key, for more on integrating on code level see: [Backend codes and tools under the Extraction details tab](/hirize/getting-started/publish-your-docs/backend-codes-and-tools.md)

{% code overflow="wrap" %}

```xml
curl -X GET "https://api.hirize.hr/parse?api_key=YOUR_API_KEY" -H"Content-Type: application/json"
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://hirize.gitbook.io/hirize/getting-started/quickstart.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.