> For the complete documentation index, see [llms.txt](https://bhashini.gitbook.io/bhashini-apis/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bhashini.gitbook.io/bhashini-apis/pre-requisites-and-onboarding.md).

# Pre-requisites and Onboarding

## Account Creation

Integrator shall onboard themselves on Bhashini via the link below:\
\
Registration: <https://bhashini.gov.in/ulca/user/register#>

<figure><img src="/files/5aLprdnQrBzjWO3IQZuj" alt=""><figcaption><p><a href="https://bhashini.gov.in/ulca/user/register#">https://bhashini.gov.in/ulca/user/register#</a></p></figcaption></figure>

Once an Integrator reaches the Integrator Registration Page, Integrator has to fill the required details as shown below:<br>

<figure><img src="/files/Ml9XJF0FhW8HeHm84nYj" alt=""><figcaption><p><a href="https://bhashini.gov.in/ulca/user/register#">https://bhashini.gov.in/ulca/user/register#</a></p></figcaption></figure>

{% hint style="info" %}
Please check the spam folder for authentication email too.
{% endhint %}

Integrator will be able to do an email authentication after which login will be enabled for them. Integrators will be able to login and create their respective API Keys.\
\
Login: <https://bhashini.gov.in/ulca/user/login><br>

<figure><img src="/files/XgJFgj1m09e5nEeu0RvF" alt=""><figcaption><p><a href="https://bhashini.gov.in/ulca/user/login">https://bhashini.gov.in/ulca/user/login</a></p></figcaption></figure>

Once the Integrators are able to login, Integrators shall be able to reach their profile using **My Profile** section as shown below:

<figure><img src="/files/qqLWtiu9bDevS94eTdiV" alt=""><figcaption><p><a href="https://bhashini.gov.in/ulca/profile">https://bhashini.gov.in/ulca/profile</a></p></figcaption></figure>

## API Key Creation

Once an Integrator reaches **My Profile** section, Integrators shall be able to create API Keys for different projects.&#x20;

{% hint style="info" %}
Currently, one Integrator will only be able to create 5 keys.
{% endhint %}

Integrators will be able to a create the API Key using **Generate** Button under their **My Profile** section.<br>

<figure><img src="/files/UbTEIGlzeQMJ7BLzlSre" alt=""><figcaption><p>Generate Button to create API Key</p></figcaption></figure>

Integrator, after clicking on **Generate** Button, shall fill the name of the application for which they want to use the key for.<br>

{% hint style="info" %}
**App Name** should contain lower-case words only and may contain underscores.
{% endhint %}

<figure><img src="/files/iilBIF4xjMnl8jx3wWC6" alt=""><figcaption><p>Application Name for which this API Key will be used for</p></figcaption></figure>

Once the Integrator has created the required number of Keys, they will be able to view the same as well as able to Revoke any particular key by clicking the **Revoke** Button.<br>

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

## Obtaining User ID

Integrators will need to also have User ID along with the API Key which shall be used to make the Pipeline Config Call. As shown above, the User ID can be obtained from the **My Profile** section of ULCA as well.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://bhashini.gitbook.io/bhashini-apis/pre-requisites-and-onboarding.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
