API Key
Connect your application, backend, or automation workflow to Notex using an API key.
Integrate with Notex using an API key
An API key allows an application, script, or internal system to call the Notex API without requiring a user to sign in for every request.
You can use an API key to create notes, process files, and generate content such as flashcards, quizzes, mind maps, slides, podcasts, videos, and translations.
When should you use an API key?
API keys are designed for backend and server-to-server integrations.
Common use cases include:
- Creating a note automatically when a new document is added to your system.
- Adding Notex summarization to another product.
- Sending URLs or files from an internal system to Notex.
- Generating flashcards, quizzes, slides, or podcasts from existing notes.
- Connecting Notex to scripts and automation workflows.
An API key acts with the permissions of the account that created it. Data created through the API belongs to that account, and any applicable plan limits or Credits are charged to it.
Get an API key
To create an API key:
- Sign in to your Notex account.
- Open Settings.
- Select API Keys.
- Select Create API Key.
- Enter a name and, optionally, an expiration date.
- Copy and save the API key immediately.
A Notex API key looks like this:
ntx_live_xxxxxxxxxxxxxxxxxxxx
The complete key is displayed only once when it is created. You cannot view it again after closing the dialog.
Store your API key securely
Store the key in a secret manager or a server-side environment variable:
NOTEX_API_KEY=ntx_live_xxxxxxxxxxxxxxxxxxxx
Do not:
- Place the key in frontend source code.
- Commit the key to Git.
- Send the key through email or chat.
- Write the complete key to application logs.
- Share one key across unrelated systems.
Create a separate key for each application and environment, such as development, staging, and production.
If a key is exposed, revoke it immediately from Settings → API Keys, then create a replacement.
Send your first request
Base URL:
https://api.notexapp.com
Send the key through the X-API-Key request header:
curl https://api.notexapp.com/v1/user/profile \
-H "X-API-Key: $NOTEX_API_KEY"
Basic example
The following example creates a note from a YouTube URL:
curl -X POST https://api.notexapp.com/v9/create/note \
-H "X-API-Key: $NOTEX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"web_url": "https://youtu.be/xxxx",
"language_hints": ["en"]
}'
Most content-generation operations are asynchronous. The create endpoint returns a task_id, which you can poll through the Tasks API.
Create content
↓
Receive task_id
↓
Poll the task
↓
Receive the result
Features available through API keys
| Feature | Description | Documentation |
|---|---|---|
| Notes | Create notes from URLs or files and list existing notes | View documentation |
| Presigned URL | Upload local files for use with other APIs | View documentation |
| Tasks | Track asynchronous processing and retrieve results | View documentation |
| Flashcards | Generate flashcard sets from a note | View documentation |
| Quiz | Generate multiple-choice quizzes from a note | View documentation |
| Mind map | Generate a mind map from a note | View documentation |
| Slides | Generate a slide deck from a note | View documentation |
| Podcast | Generate a podcast from a note | View documentation |
| Shorts and quiz video | Generate short-form or quiz videos | View documentation |
| Translate | Translate a note into another language | View documentation |
| Credits | Read the current credit balance and account quota | View documentation |
| User | Read the current profile and note list | View documentation |
Important notes
- Keep API keys on a controlled backend or server.
- Do not expose API keys in browser or mobile application code.
- Plan restrictions and Credit usage still apply.
- Some operations consume Credits.
- Revoke keys that are no longer in use.
- Create separate keys for separate applications and environments.
Next step
Create an API key, store it in an environment variable, and try a request with the Notes API.