Docs/API Reference

API Reference

Complete API documentation for programmatic link management

Authentication

All API requests require authentication using an API key. Generate your API key in the Dashboard.

# Include your API key in the Authorization header

Authorization: Bearer sk_your_api_key_here

Base URL

https://edgeurl.io/api

Rate Limits

Rate limits are enforced per endpoint category using a sliding window algorithm.

API Endpoints (Links CRUD, Analytics)

20 requests per 10 seconds per IP

Link Creation

5 requests per minute per user

Redirects

100 requests per 10 seconds per IP

QR Code Generation

10 requests per minute per IP

Public Tracking

30 requests per 10 seconds per IP

Rate limit headers are included in all responses: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

API Access by Plan

Important: This page covers the traditional REST API (sk_* tokens), which requires a Pro plan or higher. The AI-Agent API (ai_* tokens) is open to every plan -- Free, Creator, and above -- subject to per-agent rate limits and optional AI credit packs.

Plan	API Access	Daily Limit	API Keys
Free	No	--	--
Creator	No	--	--
Pro ($39/mo)	Yes	10,000 req/day	10 keys
Business ($149/mo)	Yes	500,000 req/day	50 keys
Enterprise	Yes	Unlimited	Unlimited

Generate API keys from your Dashboard > Settings > API Keys page.

POST

/api/links

Create a new short link.

Request Body

{ "target_url": "https://example.com/page", "custom_slug": "my-link", // Optional "expires_at": "2024-12-31T23:59:59Z", // Optional "meta": { // Optional "campaign": "summer-sale" } }

Response (201 Created)

{ "id": "uuid", "slug": "my-link", "short_url": "https://0gr.me/my-link", "target_url": "https://example.com/page", "created_at": "2024-01-01T00:00:00Z" }

cURL Example

curl -X POST https://edgeurl.io/api/links \ -H "Authorization: Bearer sk_your_api_key" \ -H "Content-Type: application/json" \ -d '{ "target_url": "https://example.com/page", "custom_slug": "my-link" }'

GET

/api/links

Retrieve all links for your organization.

Query Parameters

page - Page number (default: 1)
limit - Results per page (default: 50, max: 100)

Response (200 OK)

{ "links": [ { "id": "uuid", "slug": "abc123", "short_url": "https://0gr.me/abc123", "target_url": "https://example.com/page", "is_active": true, "total_clicks": 42, "created_at": "2024-01-01T00:00:00Z", "expires_at": null } ], "pagination": { "page": 1, "limit": 50, "total": 100, "total_pages": 2 } }

cURL Example

curl https://edgeurl.io/api/links?page=1&limit=10 \ -H "Authorization: Bearer sk_your_api_key"

GET

/api/links/:id

Retrieve a specific link by ID.

Response (200 OK)

{ "id": "uuid", "slug": "abc123", "short_url": "https://0gr.me/abc123", "target_url": "https://example.com/page", "is_active": true, "total_clicks": 42, "created_at": "2024-01-01T00:00:00Z", "expires_at": null }

PATCH

/api/links/:id

Update a link's target URL or metadata.

Request Body

{ "target_url": "https://example.com/new-page", // Optional "is_active": false // Optional }

Response (200 OK)

{ "id": "uuid", "slug": "my-link", "short_url": "https://0gr.me/my-link", "target_url": "https://example.com/new-page", "is_active": false, "total_clicks": 42, "updated_at": "2024-01-02T00:00:00Z" }

Note: The slug cannot be changed after creation.

DELETE

/api/links/:id

Permanently delete a link.

Response (200 OK)

{ "message": "Link deleted successfully" }

Warning: This action is irreversible. All analytics data for this link will be preserved but the short link will stop working immediately.

POST

/api/edge-verify/generate

Generate a verification token for entity identity verification. Supports creator, partner, and profile entity types.

Request Body

{ "entity_type": "creator", // "creator" | "partner" | "profile" "entity_id": "uuid", // ID of the entity to verify "platform": "twitter", // Social platform name "handle": "username" // Social media handle }

Response (200 OK)

{ "success": true, "verification_url": "https://edgeurl.io/v/...", "token": "abc123...", "platform": "twitter", "handle": "username", "instructions": "Post this link on your profile...", "expires_at": "2025-01-16T10:30:00Z", "existing": false }

Note: Verification tokens expire after 24 hours. If a pending verification already exists for the same entity/platform/handle, the existing token is returned.

GET

/api/edge-verify/status

Check the status of a verification by token or by entity and platform.

Query Parameters

token - Verification token (primary lookup)
entity_type - Entity type: creator, partner, or profile
entity_id - Entity ID
platform - Social platform name

Provide either token alone, or entity_type + entity_id + platform together. Providing only entity_type + entity_id returns all verifications for that entity.

Response (200 OK)

{ "success": true, "verification": { "id": "uuid", "entity_type": "creator", "entity_id": "uuid", "platform": "twitter", "handle": "username", "status": "pending", "display_name": null, "profile_pic_url": null, "created_at": "2025-01-15T10:30:00Z", "verified_at": null, "expires_at": "2025-01-16T10:30:00Z" } }

Error Responses

Common Error Codes

400 Bad Request

Invalid request body or parameters

401 Unauthorized

Missing or invalid API key

403 Forbidden

Plan limit exceeded or insufficient permissions

404 Not Found

Resource not found

429 Too Many Requests

Rate limit exceeded

Next Steps

→ Generate an API Key → Learn Core Concepts → Quick Start Guide → Webhook Events Reference → Developer Resources

Docs/API Reference

API Reference

Complete API documentation for programmatic link management

Authentication

All API requests require authentication using an API key. Generate your API key in the Dashboard.

# Include your API key in the Authorization header

Authorization: Bearer sk_your_api_key_here

Base URL

https://edgeurl.io/api

Rate Limits

Rate limits are enforced per endpoint category using a sliding window algorithm.

API Endpoints (Links CRUD, Analytics)

20 requests per 10 seconds per IP

Link Creation

5 requests per minute per user

Redirects

100 requests per 10 seconds per IP

QR Code Generation

10 requests per minute per IP

Public Tracking

30 requests per 10 seconds per IP

Rate limit headers are included in all responses: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

API Access by Plan

Plan	API Access	Daily Limit	API Keys
Free	No	--	--
Creator	No	--	--
Pro ($39/mo)	Yes	10,000 req/day	10 keys
Business ($149/mo)	Yes	500,000 req/day	50 keys
Enterprise	Yes	Unlimited	Unlimited

Generate API keys from your Dashboard > Settings > API Keys page.

POST

/api/links

Create a new short link.

Request Body

{ "target_url": "https://example.com/page", "custom_slug": "my-link", // Optional "expires_at": "2024-12-31T23:59:59Z", // Optional "meta": { // Optional "campaign": "summer-sale" } }

Response (201 Created)

{ "id": "uuid", "slug": "my-link", "short_url": "https://0gr.me/my-link", "target_url": "https://example.com/page", "created_at": "2024-01-01T00:00:00Z" }

cURL Example

GET

/api/links

Retrieve all links for your organization.

Query Parameters

page - Page number (default: 1)
limit - Results per page (default: 50, max: 100)

Response (200 OK)

cURL Example

curl https://edgeurl.io/api/links?page=1&limit=10 \ -H "Authorization: Bearer sk_your_api_key"

GET

/api/links/:id

Retrieve a specific link by ID.

Response (200 OK)

PATCH

/api/links/:id

Update a link's target URL or metadata.

Request Body

{ "target_url": "https://example.com/new-page", // Optional "is_active": false // Optional }

Response (200 OK)

{ "id": "uuid", "slug": "my-link", "short_url": "https://0gr.me/my-link", "target_url": "https://example.com/new-page", "is_active": false, "total_clicks": 42, "updated_at": "2024-01-02T00:00:00Z" }

Note: The slug cannot be changed after creation.

DELETE

/api/links/:id

Permanently delete a link.

Response (200 OK)

{ "message": "Link deleted successfully" }

Warning: This action is irreversible. All analytics data for this link will be preserved but the short link will stop working immediately.

POST

/api/edge-verify/generate

Generate a verification token for entity identity verification. Supports creator, partner, and profile entity types.

Request Body

Response (200 OK)

Note: Verification tokens expire after 24 hours. If a pending verification already exists for the same entity/platform/handle, the existing token is returned.

GET

/api/edge-verify/status

Check the status of a verification by token or by entity and platform.

Query Parameters

token - Verification token (primary lookup)
entity_type - Entity type: creator, partner, or profile
entity_id - Entity ID
platform - Social platform name

Provide either token alone, or entity_type + entity_id + platform together. Providing only entity_type + entity_id returns all verifications for that entity.

Response (200 OK)

Error Responses

Common Error Codes

400 Bad Request

Invalid request body or parameters

401 Unauthorized

Missing or invalid API key

403 Forbidden

Plan limit exceeded or insufficient permissions

404 Not Found

Resource not found

429 Too Many Requests

Rate limit exceeded

Next Steps

→ Generate an API Key → Learn Core Concepts → Quick Start Guide → Webhook Events Reference → Developer Resources