Introduction

The Hopsule API serves as the programmatic gateway to your organization’s decision-first memory system, allowing teams to integrate governance and context preservation directly into their custom workflows. This article provides an exhaustive overview of the rate-limiting architecture, ensuring your integrations remain stable while upholding the integrity of your team’s organizational judgment and remembrance.

Understanding these limits is essential for engineering leaders and developers who wish to automate the enforcement of decisions across large-scale infrastructures. By following the best practices outlined here, you ensure that your team's most important commitments remain accessible and enforceable without interruption.

Prerequisites

Before you begin integrating with the Hopsule API, ensure you have satisfied the following requirements to maintain security and authority over your data:

  • An active Hopsule account with administrative or developer-level permissions.

  • A valid API Token generated from the Hopsule Dashboard.

  • Familiarity with the core entities: Decisions, Memories, and Context Packs (Capsules).

  • A secure environment for managing secrets, as Hopsule enforces end-to-end encryption (E2EE) and requires TLS 1.3 for all data in transit.

Understanding Rate Limit Tiers

Hopsule utilizes a tiered rate-limiting system designed to protect the availability of the memory layer. These limits are applied per organization and are determined by your current plan. Enforcement is not about control, but about ensuring that the system remains responsive for all users, preserving the "remembrance" that Hopsule provides.

1. Free Tier

The Free Tier is designed for solo developers and small teams exploring the power of decision-first memory. It provides a baseline of authority and governance for individual projects. Limits are typically set to 1,000 requests per hour, allowing for consistent interaction with the Hopsule CLI and basic Hopsule for VS Code usage.

2. Pro Tier

For growing engineering organizations, the Pro Tier offers increased throughput to support multiple projects and active AI sessions. This tier supports up to 10,000 requests per hour. This capacity is ideal for teams utilizing Hopsule MCP to connect various AI agents to their decision and memory layer simultaneously.

3. Enterprise Tier

Enterprise organizations require high-frequency access to preserve context across thousands of decisions. Rate limits for the Enterprise Tier are significantly higher and can be customized based on organizational needs. For teams using the Hopsule Enterprise (Self-Hosted) option, rate limits are managed internally by the customer’s infrastructure team, though Hopsule provides recommended configurations to maintain performance.

Monitoring Your Usage

To help your team stay within these boundaries, the Hopsule API includes metadata in every response header. Developers should programmatically monitor these headers to adjust the velocity of their integrations.

  • X-RateLimit-Limit: The maximum number of requests allowed within the current window.

  • X-RateLimit-Remaining: The number of requests remaining in the current window.

  • X-RateLimit-Reset: The time at which the current rate limit window resets, expressed in UTC epoch seconds.

Detailed Integration Steps

To build a reliable integration that respects Hopsule’s governance model, follow these steps for managing the lifecycle of Decisions and Memories via the API.

Step 1: Authenticating Your Integration

  1. Log in to the Hopsule Dashboard.

  2. Navigate to the Settings menu in the sidebar.

  3. Click on the API & Integrations tab.

  4. Click the Generate New Token button. Give your token a descriptive name, such as "CI/CD Enforcement Bot."

  5. Copy the token immediately. For security, Hopsule uses AES-256 for data at rest and does not store the plain-text token after initial display.

  6. Include this token in the Authorization header of your requests as a Bearer token.

Step 2: Creating and Managing Decisions

Decisions are first-class, enforceable entities. When creating them via the API, you must respect their lifecycle: Draft, Pending, Accepted, or Deprecated.

  1. To create a new decision, send a POST request to the /decisions endpoint.

  2. Include the title, category, and the initial status. By default, new decisions should start as Draft.

  3. To move a decision to Accepted status, use a PATCH request. Once a decision is accepted, it becomes an enforceable constraint that Hopsule for VS Code will use to surface warnings in the IDE.

  4. If a decision is no longer relevant, transition it to Deprecated. Hopsule never deletes decisions; it preserves them to ensure organizational history is never lost.

Step 3: Appending Memories for Context

Memories are the append-only entries that explain the "why" behind your decisions. They provide the historical reasoning and lessons learned.

  1. Identify the decision_id you wish to provide context for.

  2. Send a POST request to the /memories endpoint.

  3. Because memories are append-only, the API does not support PUT or DELETE operations on memory entries. This ensures that the history of a decision remains untampered and authoritative.

  4. Use Hopper, the built-in AI assistant, via the /hopper/suggest endpoint to help draft memory entries based on existing project context.

Step 4: Distributing Context via Capsules

Context Packs (Capsules) are portable bundles of decisions and memories. They are designed to survive time and system changes.

  1. To create a Capsule, use the /capsules endpoint.

  2. Select the specific decisions and memories that constitute the context you wish to share across projects.

  3. Set the lifecycle of the Capsule to Active for ongoing projects or Frozen for completed milestones.

  4. Generate a secure sharing token via the API to allow external teams or public stakeholders to view the Capsule through a read-only interface.

Tips and Best Practices

Building a robust integration requires more than just staying under the rate limit; it requires a deep understanding of Hopsule’s philosophy that "enforcement is remembrance."

  • Implement Exponential Backoff: If your integration receives a 429 Too Many Requests response, implement a retry strategy that waits progressively longer between attempts. This prevents overwhelming the governance system.

  • Leverage Caching: Frequently accessed Decisions and Context Packs should be cached locally. Use the ETag headers provided by the Hopsule API to determine if your local version is still authoritative.

  • Use Hopsule MCP for Read-Only Access: If you are building an AI-driven tool that only needs to read decisions to provide context, use Hopsule MCP. It is optimized for AI agent connectivity and reduces the load on the primary REST API.

  • Batch Memory Appends: Instead of sending a request for every minor observation, group related context entries into a single memory append where appropriate to preserve the narrative flow of the decision history.

  • Monitor the Knowledge Graph: Use the Knowledge Graph (also known as the Brain) in the Hopsule Dashboard to visualize how your API-created decisions are linking together. This helps identify fragmented context.

  • Respect the Human Element: Remember that Hopper is advisory. Ensure your API workflows include a step for human review before moving a decision from Pending to Accepted.

Troubleshooting

When integrating with a decision and memory layer, issues often arise from state transitions or authentication. Use the table below to resolve common API challenges.

Issue

Cause

Solution

429 Too Many Requests

Your organization has exceeded the hourly rate limit for your plan tier.

Check X-RateLimit-Reset header, implement exponential backoff, or upgrade to a higher tier in the Hopsule Dashboard.

401 Unauthorized

The API token is missing, invalid, or has expired.

Verify the Authorization header. Generate a new token in the Settings tab of the dashboard if necessary.

403 Forbidden

The token lacks the necessary permissions for the requested action (e.g., trying to Accept a decision with a read-only token).

Update the token permissions in the Hopsule Dashboard or use a token with administrative authority.

422 Unprocessable Entity

The requested lifecycle transition is invalid (e.g., moving a Deprecated decision back to Draft).

Consult the decision lifecycle documentation. Ensure the decision is in a valid state for the transition you are attempting.

503 Service Unavailable

The Hopsule memory layer is undergoing maintenance or the self-hosted instance is unreachable.

Check the Hopsule status page. For self-hosted users, verify your internal network and database connectivity.

Security and Data Sovereignty

Hopsule is built on the principle that your team's decisions are your most valuable intellectual property. Therefore, security is a baseline guarantee, not a premium feature. All API communications are protected by TLS 1.3. Data at rest is encrypted using AES-256. For organizations with strict compliance requirements, Hopsule Enterprise (Self-Hosted) ensures that your decisions and memories never leave your infrastructure, providing full data sovereignty while maintaining the power of the Hopsule API.

When using Hopsule for VS Code or the Hopsule CLI, remember that local processing is prioritized. No source code is ever sent to Hopsule servers; the API only interacts with the decision and memory metadata required to enforce your team's commitments.

Conclusion

The Hopsule API is more than a technical interface; it is the conduit through which your organization’s collective intelligence is preserved and enforced. By respecting rate limits and following these best practices, you ensure that your team's memory remains a persistent, authoritative source of truth. Organizations forget. Hopsule remembers.

Related Articles

  • Managing Decision Lifecycles: From Draft to Deprecated

  • Setting up Hopsule MCP for AI Agent Context-Awareness

  • Using the Hopsule CLI for CI/CD Governance Enforcement

  • Best Practices for Creating Portable Context Packs

SHARE ON SOCIAL MEDIA

Frequent questions

These questions are asked by many of our users

Customer Centric

Frequent questions

These questions are asked by many of our users

Frequent questions

These questions are asked by many of our users

How do I change my billing information?

You can update your billing details from your account settings. Just go to the “Billing” section, click “Edit” next to your payment method, and follow the prompts to update your information securely.

What happens after my free trial ends?

When your free trial ends, your account will automatically move to the free version (if available) or pause until you choose a paid plan. You’ll receive a reminder before the trial expires so you can decide what works best for you.

Do you offer refunds?

We generally don’t offer refunds once a payment has been processed. However, if you experience any billing issues or believe there’s been a mistake, reach out to our support team and we’ll be happy to review your case.

Can I switch plans later?

Absolutely. You can upgrade or downgrade your plan at any time from your account dashboard. Changes usually take effect immediately, and any price difference will be adjusted automatically.

Will I lose my data if I cancel my subscription?

No, your data will remain stored safely. You’ll retain access to your content, but some premium features may be locked after cancellation. You can always upgrade again to regain full access.

How do I upgrade or downgrade my plan?

Go to your account settings, then to the “Subscription” section. There, you can choose a different plan that better suits your needs. Changes are applied right away, and any billing adjustments are handled automatically.

Is there a free plan available?

Yes, we offer a free plan with limited features for users who want to try things out or don’t need the full suite of tools. You can stay on the free plan as long as you’d like.

What payment methods do you accept?

We accept major credit and debit cards, including Visa, Mastercard, American Express, and others. Depending on your location, additional payment options like PayPal may also be available.

Can't find an answer?

Trusted by creators and innovators alike, our tools power growth, streamline workflows, and drive real impact across every industry.

Man pointing finger top

Can't find an answer?

Trusted by creators and innovators alike, our tools power growth, streamline workflows, and drive real impact across every industry.

Man pointing finger top

Can't find an answer?

Trusted by creators and innovators alike, our tools power growth, streamline workflows, and drive real impact across every industry.

Man pointing finger top