Skip to main content

​
Base URL

All API requests should be made to: 
https://genui.sh/api

​
Authentication

All endpoints require authentication via Bearer token. Include your API key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY
See Authentication for details on obtaining and using API keys.

​
Request Format

All POST and PUT requests should include: 
Content-Type: application/json
Request bodies should be valid JSON.

​
Response Format

All responses are JSON with the following structure: Success Response: 
{
  "id": "art_abc123",
  "template": "markdown",
  "status": "active",
  ...
}
Error Response: 
{
  "error": {
    "code": "error_code",
    "message": "Human-readable error message"
  }
}

​
HTTP Status Codes

CodeDescription
200Success
201Created
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
404Not Found - Resource doesn’t exist
429Too Many Requests - Rate limited
500Internal Server Error

​
Rate Limiting

Requests are rate limited based on your plan. Rate limit headers are included in all responses: 
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
X-RateLimit-Reset: 1705320000

​
Pagination

List endpoints support pagination with these query parameters:
ParameterTypeDescription
limitintegerItems per page (default: 20, max: 100)
offsetintegerNumber of items to skip
cursorstringCursor for cursor-based pagination

​
Endpoints Overview

Create and Share

POST /api/artifacts/share

Create Artifact

POST /api/artifacts

List Artifacts

GET /api/artifacts

Get Artifact

GET /api/artifacts/[id]

Update Artifact

PUT /api/artifacts/[id]

Delete Artifact

DELETE /api/artifacts/[id]

Share Artifact

POST /api/artifacts/[id]/share