Skip to content

Commit db667cb

Browse files
JonoPrestJasoonS
andauthored
Add info about timelines and usage (#609)
* Add info about timelines and usage * Add api token info to hyperindex docs * Add note about placement in .env Co-authored-by: Jason Smythe <[email protected]> * Add full stops Co-authored-by: Jason Smythe <[email protected]> * Add note about reaching out to us for introductory pricing * Expand on credit calculation --------- Co-authored-by: Jason Smythe <[email protected]>
1 parent 46c3822 commit db667cb

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

docs/HyperIndex/overview.md

+14
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,20 @@ While HyperIndex gives you a complete indexing solution with schema management a
4949

5050
---
5151

52+
## Hypersync API Token Requirements
53+
54+
Starting from **9 May 2024**, HyperSync (the data engine powering HyperIndex) will implement rate limits for requests without API tokens. Here's what you need to know:
55+
56+
- **Local Development**: No API token is required for local development, though requests will be rate limited.
57+
- **Self-Hosted Deployments**: API tokens are required for unlimited HyperSync access in self-hosted deployments. The token can be set via the `ENVIO_API_TOKEN` environment variable in your indexer configuration. This can be read from the `.env` file in the root of your HyperIndex project.
58+
- **Hosted Service**: Indexers deployed to our hosted service will have special access that doesn't require a custom API token.
59+
- **Free Usage**: The service remains free to use until the end of May 2024.
60+
- **Future Pricing**: From June 2024 onwards, we will introduce tiered packages based on usage. Credits are calculated based on comprehensive metrics including data bandwidth, disk read operations, and other resource utilization factors. For preferred introductory pricing based on your specific use case, reach out to us on [Discord](https://discord.gg/Q9qt8gZ2fX).
61+
62+
For more details about API tokens, including how to generate and implement them, see our [API Tokens documentation](/docs/HyperSync/api-tokens).
63+
64+
---
65+
5266
## Feature Roadmap
5367

5468
Upcoming features on our development roadmap:

docs/HyperSync/api-tokens.mdx

+9
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ import TabItem from "@theme/TabItem";
1414

1515
API tokens provide authenticated access to HyperSync services, enabling enhanced capabilities and usage tracking. While currently optional, they will become mandatory in the future and offer significant advantages for serious usage.
1616

17+
**Starting from 9 May**, you will still be able to use HyperSync without API tokens, but **rate limits will be applied**. The service will remain **free to use until the end of May**. From **June onwards**, we will introduce a set of **tiered packages based on usage**. Indexers deployed to our hosted service will have special access to HyperSync that does not require a custom API token.
18+
1719
## Table of Contents
1820

1921
- [Benefits of Using API Tokens](#benefits-of-using-api-tokens)
@@ -78,6 +80,13 @@ let client = Client::new(ClientConfig {
7880
</TabItem>
7981
</Tabs>
8082

83+
## Understanding Usage
84+
85+
To understand your current month's usage, visit [https://envio.dev/app/api-tokens](https://envio.dev/app/api-tokens). Usage is composed of two main components:
86+
87+
- **Number of Requests**: The total count of API requests made.
88+
- **Credits**: A comprehensive calculation that takes into account multiple factors including data bandwidth, disk read operations, and other resource utilization metrics. This provides the most accurate representation of actual service usage. We're happy to provide more detailed breakdowns of the credit calculation upon request.
89+
8190
## Security Best Practices
8291

8392
When working with API tokens:

0 commit comments

Comments
 (0)