Needle API
Welcome to the Needle API documentation. This API is used to interact with the Needle platform programmatically. You can create, update, delete, and search collections, files, and more.
To get familiar with the core concepts in Needle you can read our getting started guide.
If you want to see an example how you can use this API to build custom RAG applications, you can check our 4 min Needle RAG tutorial.
If you have any questions or need help, don't hesitate to contact us in our Discord channel.
Thank you for flying with us. 🚀
Authentication​
- API Key: ApiKeyAuth
Needle API is accessible via API keys.
You can obtain an API key in the settings page.
The API key should be passed in the header as x-api-key. Please always remember to keep your API key secret and secure.
In case your API key is compromised, you can revoke and regenerate a new one in the settings page.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | x-api-key |