# Obtaining API Token

An API (Application Programming Interface) token is a unique identifier used for authentication when accessing an API. It is necessary because it allows secure communication between different software applications and ensures that only authorized users can access the API. In summary, an API token is important because it helps maintain security and control access to sensitive data and functionalities within an application.

<details>

<summary>Step 1: Click on your avatar at the bottom left corner and select Profile Settings.</summary>

<img src="/files/ArOEyB5zb1Yya81hfmtA" alt="" data-size="original">

</details>

<details>

<summary>Step 2: Navigate to "Access Tokens" from the top menu on the Profile Settings page. Click on the "Generate Token" button to create a new token.</summary>

<img src="/files/nqmjJ5n5S9aKPgc53DXf" alt="" data-size="original">

</details>

<details>

<summary>Step 3: In the modal that shows up, enter a name for your token and choose what it can do.</summary>

If you choose "read", it will only do download actions; if you choose "write", it will also do upload actions via API and CLI. Both scopes can be used together.

Having a meaningful name for your token will allow you to easily find out which token is the computer, the server, the CI/CD, or the token you accidentally expose. Yeah. It sounds bad, but it happens.

<img src="/files/mdbwZUJ1h1ZzNrIadz72" alt="" data-size="original">

</details>

<details>

<summary>Step 4: Copy the issued token. Done, and that's all.</summary>

Tokens can only be seen once generated. So do not forget to save it to be able to use it. You can also edit the name and scope or revoke your token here.

<img src="/files/MHcms1mFn2b3dot6ErrT" alt="" data-size="original">

</details>


---

# 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://docs.transiyzi.com/developers/obtaining-api-token.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.