Markdown Typography
Demonstrates how all markdown elements render inside the .api-layout prose container. This is the styling applied to all documentation pages.
Headings
Heading 1
Heading 2
Heading 3
Heading 4
Paragraphs & Inline Styles
This is a standard paragraph with bold text, italic text, and inline code. You can also combine them: bold italic.
Here is a paragraph with a internal link and an external link. Links inside prose inherit the accent color and underline on hover.
Lists
Unordered List
- First item
- Second item with
inline code - Third item
- Nested item A
- Nested item B
- Fourth item
Ordered List
- Create your API key in the dashboard
- Install the SDK
- Run
npm install @aress/sdk - Import and configure the client
- Run
- Make your first request
- Handle the response
Tables
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Unique identifier for the resource |
email | string | Yes | Customer email address |
name | string | No | Display name for the customer |
metadata | object | No | Arbitrary key-value pairs attached to the resource |
Code Blocks
Code blocks use the CodeBlock component with optional title and language.
const response = await fetch('/api/v1/customers', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer sk_test_xxx'
},
body: JSON.stringify({
email: 'jane@example.com',
name: 'Jane Doe'
})
});
const customer = await response.json();{
"id": "cus_abc123",
"email": "jane@example.com",
"name": "Jane Doe",
"created_at": "2025-01-15T09:30:00Z"
}curl -X GET https://api.example.com/v1/customers \\\n -H 'Authorization: Bearer sk_test_xxx'Blockquotes
This is a standard blockquote. It can contain bold, italic, and
inline code.
Callout Variants
Callouts are styled blockquotes with type annotations. Four variants are available:
Horizontal Rules
Horizontal rules create visual separation between sections:
Content continues after the rule.
Combined Example
When building an integration, start by creating an API key in the dashboard. Then install the SDK:
npm install @aress/sdkConfigure the client with your credentials:
import { AressClient } from '@aress/sdk';
const client = new AressClient({
apiKey: process.env.ARESS_API_KEY,
environment: 'sandbox'
});Then list your customers:
- Call
client.customers.list()to fetch all customers - Use
limitandoffsetfor pagination - Filter by
emailorcreated_atrange
| Status | Meaning |
|---|---|
200 | Success |
401 | Invalid or missing API key |
429 | Rate limit exceeded |