Skip to content

Fill gaps from assistant conversations: API key one-time visibility #313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mintlify merged 1 commit into from
Aug 3, 2026
Merged

Fill gaps from assistant conversations: API key one-time visibility #313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/api-docs/api-reference/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,19 @@ https://api.terminal49.com/v2

## Authentication

Include your API key in the `Authorization` header, prefixed with `Token`:
Include your API key in the `Authorization` header, prefixed with `Token` (not `Bearer`):

```bash
curl https://api.terminal49.com/v2/shipments \
-H "Authorization: Token YOUR_API_KEY"
```

Replace `YOUR_API_KEY` with the raw key value from the [developer portal](https://app.terminal49.com/developers/api-keys) — no quotes, no `Bearer` prefix, and no extra whitespace. A `401 Unauthorized` response with `"Terminal49 API key could not be verified"` means the key is missing, malformed, revoked, or truncated when it was copied.

<Warning>
The full API key value is only shown once, right after you create it. Copy the complete token from that screen and store it in a secret manager before navigating away — after that, the value is masked and cannot be revealed again. If you lost the full value, create a new key, copy it immediately, then delete the older key.
</Warning>

## Request and response format

- The API follows the [JSON:API](https://jsonapi.org/) specification
Expand Down
6 changes: 6 additions & 0 deletions docs/api-docs/getting-started/start-here.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ You can use any HTTP client. [Postman](https://www.postman.com/) is useful for a

Sign in to your Terminal49 account and go to the [developer portal](https://app.terminal49.com/developers/api-keys) to get your API key.

<Warning>
The full API key value is only shown once, right after you create it. Copy the complete token from that screen and store it somewhere safe (for example, a password manager or your deployment's secret manager) before you navigate away. Once you leave the page, the key is masked and cannot be revealed again.

If you did not capture the full value, create a new key and copy it immediately. You can then delete the older key from the [developer portal](https://app.terminal49.com/developers/api-keys).
</Warning>

## Send the Authorization header

The API uses a Token-prefixed API key in the `Authorization` header. Send it with every request:
Expand Down
Loading