hyper

Perform HTTP requests to external REST APIs from ColdBox and BoxLang applications.

1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/ColdBox/skills --skill hyper
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: hyper
Source: https://github.com/ColdBox/skills/tree/main/modules/hyper
Command: npx skills add https://github.com/ColdBox/skills --skill hyper

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides a structured, testable way to perform HTTP requests from ColdBox and BoxLang applications, removing boilerplate around authentication, timeouts, response parsing, and error handling when integrating with external REST APIs.

Core Features & Use Cases

  • Injection & Fluent Builder: Inject HyperBuilder and compose requests with base URLs, headers, query params, and timeouts.
  • Request Shortcuts & Body Types: Simple GET/POST/PUT/PATCH/DELETE shortcuts plus JSON, form-encoded, and raw bodies.
  • Response Handling & Errors: Inspect status codes, parse JSON safely, map 4xx/5xx to typed exceptions, and implement retry/timeouts.
  • Production Patterns: Build reusable API client services, cache OAuth tokens, and log contextual errors for reliable integrations.
  • Use Case: Wrap a third-party payments or identity API in a service that handles auth, token caching, and consistent error mapping.

Quick Start

Inject HyperBuilder, set a base URL and headers, then call get or post to fetch or submit JSON to an external API.

Frequently Asked Questions about hyper

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I make HTTP requests to external REST APIs from a ColdBox application?

To make HTTP requests to external REST APIs from a ColdBox application, inject HyperBuilder to compose requests with base URLs, headers, and timeouts using fluent construction. It supports GET, POST, PUT, PATCH, and DELETE shortcuts for fetching or submitting JSON data.

What is the best way to handle authentication and cache OAuth tokens for API clients in ColdBox?

Handling authentication and caching OAuth tokens for API clients in ColdBox is done by building reusable API client services that manage auth configuration and cache tokens. This structured approach removes boilerplate around authentication when integrating with external REST APIs.

How do I parse JSON responses and map 4xx or 5xx errors to typed exceptions in BoxLang?

Parsing JSON responses and mapping 4xx or 5xx errors to typed exceptions in BoxLang is handled through structured response handling features. You can safely inspect status codes, parse response bodies, and map HTTP errors directly to typed exceptions for reliable integrations.

Can I configure retries and timeouts for HTTP requests to external services in ColdBox?

Yes, you can configure retries and timeouts for HTTP requests to external services in ColdBox. The fluent request builder allows you to set timeout limits and implement retry logic, ensuring reliable HTTP clients that handle transient failures gracefully.

Does this HTTP client support sending JSON, form-encoded, and multipart request bodies?

Yes, this HTTP client supports sending JSON, form-encoded, and raw multipart request bodies. You can use simple POST, PUT, and PATCH shortcuts to submit various body types to external REST APIs with configured headers.

Why use a fluent request builder instead of standard HTTP functions for external API integration in ColdBox?

Using a fluent request builder for external API integration in ColdBox provides a structured, testable way to perform HTTP requests. It removes boilerplate around authentication, timeouts, response parsing, and error handling, allowing you to build reusable API client services efficiently.