From 193fcca6c2b37dcbae12dbce5724caefda2e5f85 Mon Sep 17 00:00:00 2001 From: Jono Prest Date: Wed, 2 Apr 2025 10:55:27 +0200 Subject: [PATCH 1/6] Add info about timelines and usage --- docs/HyperSync/api-tokens.mdx | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/HyperSync/api-tokens.mdx b/docs/HyperSync/api-tokens.mdx index 5c636586..858307d0 100644 --- a/docs/HyperSync/api-tokens.mdx +++ b/docs/HyperSync/api-tokens.mdx @@ -14,6 +14,8 @@ import TabItem from "@theme/TabItem"; 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. +**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. + ## Table of Contents - [Benefits of Using API Tokens](#benefits-of-using-api-tokens) @@ -78,6 +80,13 @@ let client = Client::new(ClientConfig { +## Understanding Usage + +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: + +- **Number of Requests**: The total count of API requests made. +- **Credits**: A calculation based on the endpoint used and the size of the query. + ## Security Best Practices When working with API tokens: From 9ac3b6fc6079860ee504eae43b934f3f8f253574 Mon Sep 17 00:00:00 2001 From: Jono Prest Date: Wed, 2 Apr 2025 15:02:29 +0200 Subject: [PATCH 2/6] Add api token info to hyperindex docs --- docs/HyperIndex/overview.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/HyperIndex/overview.md b/docs/HyperIndex/overview.md index 6e251ca7..f1045838 100644 --- a/docs/HyperIndex/overview.md +++ b/docs/HyperIndex/overview.md @@ -49,6 +49,20 @@ While HyperIndex gives you a complete indexing solution with schema management a --- +## Hypersync API Token Requirements + +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: + +- **Local Development**: No API token is required for local development, though requests will be rate limited +- **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 +- **Hosted Service**: Indexers deployed to our hosted service will have special access that doesn't require a custom API token +- **Free Usage**: The service remains free to use until the end of May 2024 +- **Future Pricing**: From June 2024 onwards, we will introduce tiered packages based on usage + +For more details about API tokens, including how to generate and implement them, see our [API Tokens documentation](/docs/HyperSync/api-tokens). + +--- + ## Feature Roadmap Upcoming features on our development roadmap: From 45e231cfacab5f48b0848125dbbf8f2e7d717b89 Mon Sep 17 00:00:00 2001 From: Jono Prest <65739024+JonoPrest@users.noreply.github.com> Date: Wed, 2 Apr 2025 15:46:43 +0200 Subject: [PATCH 3/6] Add note about placement in .env Co-authored-by: Jason Smythe --- docs/HyperIndex/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/HyperIndex/overview.md b/docs/HyperIndex/overview.md index f1045838..624be065 100644 --- a/docs/HyperIndex/overview.md +++ b/docs/HyperIndex/overview.md @@ -54,7 +54,7 @@ While HyperIndex gives you a complete indexing solution with schema management a 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: - **Local Development**: No API token is required for local development, though requests will be rate limited -- **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 +- **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. - **Hosted Service**: Indexers deployed to our hosted service will have special access that doesn't require a custom API token - **Free Usage**: The service remains free to use until the end of May 2024 - **Future Pricing**: From June 2024 onwards, we will introduce tiered packages based on usage From 8ce200d90bc32bd43c4cb5967f92fca812a31915 Mon Sep 17 00:00:00 2001 From: Jono Prest <65739024+JonoPrest@users.noreply.github.com> Date: Wed, 2 Apr 2025 15:57:01 +0200 Subject: [PATCH 4/6] Add full stops Co-authored-by: Jason Smythe --- docs/HyperIndex/overview.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/HyperIndex/overview.md b/docs/HyperIndex/overview.md index 624be065..3ae9b032 100644 --- a/docs/HyperIndex/overview.md +++ b/docs/HyperIndex/overview.md @@ -53,11 +53,11 @@ While HyperIndex gives you a complete indexing solution with schema management a 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: -- **Local Development**: No API token is required for local development, though requests will be rate limited +- **Local Development**: No API token is required for local development, though requests will be rate limited. - **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. -- **Hosted Service**: Indexers deployed to our hosted service will have special access that doesn't require a custom API token -- **Free Usage**: The service remains free to use until the end of May 2024 -- **Future Pricing**: From June 2024 onwards, we will introduce tiered packages based on usage +- **Hosted Service**: Indexers deployed to our hosted service will have special access that doesn't require a custom API token. +- **Free Usage**: The service remains free to use until the end of May 2024. +- **Future Pricing**: From June 2024 onwards, we will introduce tiered packages based on usage. For more details about API tokens, including how to generate and implement them, see our [API Tokens documentation](/docs/HyperSync/api-tokens). From 5734e2538fa1744de6021110153cb632dc24d715 Mon Sep 17 00:00:00 2001 From: Jono Prest Date: Wed, 2 Apr 2025 16:02:06 +0200 Subject: [PATCH 5/6] Add note about reaching out to us for introductory pricing --- docs/HyperIndex/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/HyperIndex/overview.md b/docs/HyperIndex/overview.md index 3ae9b032..f0d14502 100644 --- a/docs/HyperIndex/overview.md +++ b/docs/HyperIndex/overview.md @@ -57,7 +57,7 @@ Starting from **9 May 2024**, HyperSync (the data engine powering HyperIndex) wi - **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. - **Hosted Service**: Indexers deployed to our hosted service will have special access that doesn't require a custom API token. - **Free Usage**: The service remains free to use until the end of May 2024. -- **Future Pricing**: From June 2024 onwards, we will introduce tiered packages based on usage. +- **Future Pricing**: From June 2024 onwards, we will introduce tiered packages based on usage. For preferred introductory pricing based on your specific use case, reach out to us on [Discord](https://discord.gg/Q9qt8gZ2fX). For more details about API tokens, including how to generate and implement them, see our [API Tokens documentation](/docs/HyperSync/api-tokens). From 63173168a463d72d7b6b4418ed412f5b45d1ee4b Mon Sep 17 00:00:00 2001 From: Jono Prest Date: Wed, 2 Apr 2025 16:12:37 +0200 Subject: [PATCH 6/6] Expand on credit calculation --- docs/HyperIndex/overview.md | 2 +- docs/HyperSync/api-tokens.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/HyperIndex/overview.md b/docs/HyperIndex/overview.md index f0d14502..43564048 100644 --- a/docs/HyperIndex/overview.md +++ b/docs/HyperIndex/overview.md @@ -57,7 +57,7 @@ Starting from **9 May 2024**, HyperSync (the data engine powering HyperIndex) wi - **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. - **Hosted Service**: Indexers deployed to our hosted service will have special access that doesn't require a custom API token. - **Free Usage**: The service remains free to use until the end of May 2024. -- **Future Pricing**: From June 2024 onwards, we will introduce tiered packages based on usage. For preferred introductory pricing based on your specific use case, reach out to us on [Discord](https://discord.gg/Q9qt8gZ2fX). +- **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). For more details about API tokens, including how to generate and implement them, see our [API Tokens documentation](/docs/HyperSync/api-tokens). diff --git a/docs/HyperSync/api-tokens.mdx b/docs/HyperSync/api-tokens.mdx index 858307d0..b39d3fac 100644 --- a/docs/HyperSync/api-tokens.mdx +++ b/docs/HyperSync/api-tokens.mdx @@ -85,7 +85,7 @@ let client = Client::new(ClientConfig { 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: - **Number of Requests**: The total count of API requests made. -- **Credits**: A calculation based on the endpoint used and the size of the query. +- **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. ## Security Best Practices