API Endpoints

https://api.titlize.com

POST /generate

1
curl -X POST https://api.titlize.com/generate \
2
  -H "Authorization: Bearer your_api_token" \
3
  -F "[email protected]" \
4
  -F "title=10 Tips for Better Writing" \
5
  -F "subtitle=A comprehensive guide" \
6
  -F "template=bottom-left"

1
curl -X POST https://api.titlize.com/generate \
2
  -H "Authorization: Bearer your_api_token" \
3
  -F "[email protected]" \
4
  -F "title=Five Ways to Improve Your Code" \
5
  -F "aspect=square" \
6
  -F "fileFormat=jpeg"

1
curl -X POST https://api.titlize.com/generate \
2
  -H "Authorization: Bearer your_api_token" \
3
  -F "[email protected]" \
4
  -F "title=The Complete Guide" \
5
  -F "template=left" \
6
  -F "aspect=portrait" \
7
  -F "fileFormat=webp"

1
{
2
  "success": true,
3
  "data": {
4
    "id": "gen_abc123def456",
5
    "url": "https://<your-image-url>/gen_abc123def456.png",
6
    "thumbnailUrl": "https://<your-image-url>/thumbnails/gen_abc123def456.png",
7
    "width": 1200,
8
    "height": 630,
9
    "createdAt": "2024-01-15T10:30:00Z"
10
  }
11
}

1
{
2
  "success": false,
3
  "error": {
4
    "code": "VALIDATION_ERROR",
5
    "message": "Title is required",
6
    "details": {
7
      "field": "title",
8
      "constraint": "required"
9
    }
10
  }
11
}

1
{
2
  "success": false,
3
  "error": {
4
    "code": "FILE_TOO_LARGE",
5
    "message": "Image must be less than 10MB"
6
  }
7
}

GET /images

1
curl -X GET "https://api.titlize.com/images?limit=10&offset=0" \
2
  -H "Authorization: Bearer your_api_token"

1
{
2
  "success": true,
3
  "data": {
4
    "images": [
5
      {
6
        "id": "gen_abc123def456",
7
        "title": "10 Tips for Better Writing",
8
        "url": "https://<your-image-url>/gen_abc123def456.png",
9
        "thumbnailUrl": "https://<your-image-url>/thumbnails/gen_abc123def456.png",
10
        "createdAt": "2024-01-15T10:30:00Z"
11
      }
12
    ],
13
    "pagination": {
14
      "total": 42,
15
      "limit": 10,
16
      "offset": 0,
17
      "hasMore": true
18
    }
19
  }
20
}

GET /usage

1
curl -X GET https://api.titlize.com/usage \
2
  -H "Authorization: Bearer your_api_token"

1
{
2
  "success": true,
3
  "data": {
4
    "period": {
5
      "start": "2024-01-01T00:00:00Z",
6
      "end": "2024-01-31T23:59:59Z"
7
    },
8
    "usage": {
9
      "generated": 156,
10
      "limit": 500,
11
      "remaining": 344,
12
      "percentUsed": 31.2
13
    },
14
    "tier": "pro"
15
  }
16
}

POST /tokens

1
{
2
  "name": "Production Website"
3
}

1
{
2
  "success": true,
3
  "data": {
4
    "id": "tok_xyz789",
5
    "name": "Production Website",
6
    "token": "it_live_abc123...",
7
    "createdAt": "2024-01-15T10:30:00Z"
8
  }
9
}

GET /tokens

1
{
2
  "success": true,
3
  "data": {
4
    "tokens": [
5
      {
6
        "id": "tok_xyz789",
7
        "name": "Production Website",
8
        "lastUsedAt": "2024-01-15T14:22:00Z",
9
        "createdAt": "2024-01-01T10:00:00Z"
10
      }
11
    ]
12
  }
13
}

DELETE /tokens/:id

1
{
2
  "success": true,
3
  "message": "Token deleted successfully"
4
}

GET /tokens/validate

1
curl -X GET https://api.titlize.com/tokens/validate \
2
  -H "Authorization: Bearer your_api_token"

1
{
2
  "success": true,
3
  "data": {
4
    "user": {
5
      "id": "usr_abc123",
6
      "email": "[email protected]",
7
      "displayName": "Your Name",
8
      "tier": "pro"
9
    },
10
    "usage": {
11
      "month": "2024-01",
12
      "quota": 500,
13
      "count": 156,
14
      "remaining": 344
15
    }
16
  }
17
}