REST Library

@rewritetoday/rest is the low-level Rewrite API client for teams that need direct control over HTTP behavior. Repository: github.com/RewriteToday/rest

When to use it

You want explicit request/response control.
You need custom retry or timeout behavior.
You run in serverless/edge workers and need strict execution budgets.
You already have your own abstraction layer and only need transport primitives.

Key capabilities

Route helpers

Use route builders from @rewritetoday/types to avoid path construction mistakes.

Retry controls

Handle transient failures and rate-limit responses with custom backoff logic.

Timeout strategy

Configure request timeout budgets that fit your runtime constraints.

Hooks

Add observability, custom logging, or request/response instrumentation.

Install

npm install @rewritetoday/rest @rewritetoday/types

pnpm add @rewritetoday/rest @rewritetoday/types

yarn add @rewritetoday/rest @rewritetoday/types

bun add @rewritetoday/rest @rewritetoday/types

Basic example

import { REST } from '@rewritetoday/rest';
import { Routes, type RESTGetWebhookData } from '@rewritetoday/types';

const rewrite = new REST({
  timeout: 12_000,
  secret: process.env.REWRITE_API_KEY,
});

const { data } = await rewrite.get<RESTGetWebhookData>(Routes.webhooks.get('123'));

console.log({ data });

Resilience example

import { REST } from '@rewritetoday/rest';
import { Routes } from '@rewritetoday/types';

const rewrite = new REST({
  timeout: 12_000,
  secret: process.env.REWRITE_API_KEY,
  retry: {
    max: 5,
    delay(attempt) {
      return Math.min(8_000, 2 ** attempt * 250);
    },
  },
  onRateLimit(context) {
    console.log({ context });
  },
});

await rewrite.post(Routes.messages.create(), 
  {
    to: '+5511999999999',
    content: 'Seu codigo de verificacao e 382991',
  },
  {
  	headers: {
    	'Idempotency-Key': 'msg_382991',
   	}
  }
);

Best practices

Keep API keys server-side only

Never expose Rewrite API keys in frontend bundles, mobile binaries, or public repositories.

Use idempotency for write operations

Include idempotency keys for create/send actions to avoid accidental duplicates during retries.

Align routes with @rewritetoday/types

Pair @rewritetoday/rest with @rewritetoday/types to keep paths and payload contracts synchronized.

Add observability early

Log latency, status classes, and retry counts to detect saturation and provider instability.

Types library

Route builders, shared contracts, and enums used together with REST.

Errors and retries

Retry guidance, timeout strategy, and failure-handling patterns.

Overview

Adapters

Themes

Packages

When to use it

Key capabilities

Route helpers

Retry controls

Timeout strategy

Hooks

Install

Basic example

Resilience example

Best practices

Types library

Errors and retries

​When to use it

​Key capabilities

Route helpers

Retry controls

Timeout strategy

Hooks

​Install

​Basic example

​Resilience example

​Best practices

​Related docs

Types library

Errors and retries

When to use it

Key capabilities

Install

Basic example

Resilience example

Best practices

Related docs