API Reference

API Documentation

Complete REST API reference for integrating Blizzity into your applications

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

Authorization: YOUR_API_KEY

Account Management

POST/api/account/data

Get account information by username/password or API key

Parameters:

• username (optional)
• password (optional)
• Authorization header (optional)

Response:

{
  "id": "user_id",
  "username": "string",
  "usages": "number",
  "credits": "number",
  "api_key": "string"
}

POST/api/account/create

Create a new user account

Parameters:

• username
• password

Response:

{
  "id": "user_id",
  "username": "string",
  "api_key": "string"
}

POST/api/account/settings/set

Update user settings (requires API key)

Parameters:

• key
• value

Response:

{
  "message": "Setting updated successfully"
}

POST/api/account/settings/get

Get user setting value (requires API key)

Parameters:

• key

Response:

{
  "value": "setting_value"
}

Project Management

POST/api/project/create

Create a new project workflow

Parameters:

• name
• description
• data
• visibility
• node_data
• connection_data
• manual_data

Response:

{
  "project_id": "string",
  "title": "string",
  "visibility": "private"
}

POST/api/project/update

Update an existing project

Parameters:

• project_id
• name
• description
• data
• visibility
• node_data
• connection_data
• manual_data

Response:

{
  "message": "Project updated successfully"
}

POST/api/project/get

Get project details by ID

Parameters:

• project_id

Response:

{
  "project_id": "string",
  "name": "string",
  "description": "string",
  "node_data": "array"
}

POST/api/project/delete

Delete a project

Parameters:

• project_id

Response:

{
  "message": "Project deleted successfully"
}

POST/api/project/list/mine

List user's projects with pagination

Parameters:

• page
• limit

Response:

{
  "projects": "array",
  "total": "number",
  "pages": "number"
}

POST/api/project/list/trending

List trending public projects

Parameters:

• page
• limit

Response:

{
  "projects": "array",
  "total": "number",
  "pages": "number"
}

POST/api/project/interact

Like or save a project

Parameters:

• project_id
• interaction_type (like/save)

Response:

{
  "project_id": "string",
  "interaction_type": "string",
  "is_active": "boolean"
}

POST/api/project/nodes

Get available node templates

Parameters:

Response:

{
  "nodes": "array"
}

Project Runs

POST/api/project/runs/run

Execute a project workflow (SSE stream)

Parameters:

• project_id
• seed
• variables

Response:

Server-Sent Events stream with progress updates

POST/api/project/runs/estimate

Estimate credits cost for running a project

Parameters:

• project_id
• seed

Response:

{
  "estimated_cost": "number",
  "project": "object"
}

POST/api/project/runs/list

List project run history

Parameters:

• project_id
• page
• limit

Response:

{
  "runs": "array",
  "total": "number",
  "pages": "number"
}

File Management

POST/api/file/get

Get file data by ID (returns base64 encoded file)

Parameters:

• file

Response:

{
  "file_id": "string",
  "raw": "base64_string",
  "tag": "object",
  "data": "object"
}

POST/api/file/list

List user's files with pagination

Parameters:

• page
• limit

Response:

{
  "files": "array"
}

Social Media Integration

POST/api/social/url

Get OAuth authorization URL for social platform

Parameters:

• space (youtube/tiktok/snapchat)

Response:

{
  "url": "authorization_url"
}

POST/api/social/verify

Verify OAuth code and link social account

Parameters:

• space
• code

Response:

{
  "user": "object",
  "message": "Account successfully linked"
}

POST/api/social/account

Get linked social media accounts

Parameters:

• space

Response:

{
  "users": "array"
}

POST/api/social/select

Select active social account for uploads

Parameters:

• space
• id

Response:

{
  "user": "object",
  "message": "Account selected successfully"
}

POST/api/social/upload

Upload video to selected social platform

Parameters:

• space
• video
• title
• description
• privacy_level

Response:

{
  "message": "Upload initiated"
}

PayPal Integration

POST/api/paypal/create

Create PayPal payment for credits

Parameters:

• amount
• currency
• credits

Response:

{
  "approval_url": "paypal_redirect_url"
}

POST/api/paypal/execute

Execute completed PayPal payment

Parameters:

• paymentId
• payerId

Response:

{
  "message": "Payment successful",
  "credits_awarded": "number"
}

Account Management

POST/api/account/data

Get account information by username/password or API key

Parameters:

• username (optional)
• password (optional)
• Authorization header (optional)

Response:

{
  "id": "user_id",
  "username": "string",
  "usages": "number",
  "credits": "number",
  "api_key": "string"
}

POST/api/account/create

Create a new user account

Parameters:

• username
• password

Response:

{
  "id": "user_id",
  "username": "string",
  "api_key": "string"
}

POST/api/account/settings/set

Update user settings (requires API key)

Parameters:

• key
• value

Response:

{
  "message": "Setting updated successfully"
}

POST/api/account/settings/get

Get user setting value (requires API key)

Parameters:

• key

Response:

{
  "value": "setting_value"
}

Project Management

POST/api/project/create

Create a new project workflow

Parameters:

• name
• description
• data
• visibility
• node_data
• connection_data
• manual_data

Response:

{
  "project_id": "string",
  "title": "string",
  "visibility": "private"
}

POST/api/project/update

Update an existing project

Parameters:

• project_id
• name
• description
• data
• visibility
• node_data
• connection_data
• manual_data

Response:

{
  "message": "Project updated successfully"
}

POST/api/project/get

Get project details by ID

Parameters:

• project_id

Response:

{
  "project_id": "string",
  "name": "string",
  "description": "string",
  "node_data": "array"
}

POST/api/project/delete

Delete a project

Parameters:

• project_id

Response:

{
  "message": "Project deleted successfully"
}

POST/api/project/list/mine

List user's projects with pagination

Parameters:

• page
• limit

Response:

{
  "projects": "array",
  "total": "number",
  "pages": "number"
}

POST/api/project/list/trending

List trending public projects

Parameters:

• page
• limit

Response:

{
  "projects": "array",
  "total": "number",
  "pages": "number"
}

POST/api/project/interact

Like or save a project

Parameters:

• project_id
• interaction_type (like/save)

Response:

{
  "project_id": "string",
  "interaction_type": "string",
  "is_active": "boolean"
}

POST/api/project/nodes

Get available node templates

Parameters:

Response:

{
  "nodes": "array"
}

Project Runs

POST/api/project/runs/run

Execute a project workflow (SSE stream)

Parameters:

• project_id
• seed
• variables

Response:

Server-Sent Events stream with progress updates

POST/api/project/runs/estimate

Estimate credits cost for running a project

Parameters:

• project_id
• seed

Response:

{
  "estimated_cost": "number",
  "project": "object"
}

POST/api/project/runs/list

List project run history

Parameters:

• project_id
• page
• limit

Response:

{
  "runs": "array",
  "total": "number",
  "pages": "number"
}

Social Media Integration

POST/api/social/url

Get OAuth authorization URL for social platform

Parameters:

• space (youtube/tiktok/snapchat)

Response:

{
  "url": "authorization_url"
}

POST/api/social/verify

Verify OAuth code and link social account

Parameters:

• space
• code

Response:

{
  "user": "object",
  "message": "Account successfully linked"
}

POST/api/social/account

Get linked social media accounts

Parameters:

• space

Response:

{
  "users": "array"
}

POST/api/social/select

Select active social account for uploads

Parameters:

• space
• id

Response:

{
  "user": "object",
  "message": "Account selected successfully"
}

POST/api/social/upload

Upload video to selected social platform

Parameters:

• space
• video
• title
• description
• privacy_level

Response:

{
  "message": "Upload initiated"
}

PayPal Integration

POST/api/paypal/create

Create PayPal payment for credits

Parameters:

• amount
• currency
• credits

Response:

{
  "approval_url": "paypal_redirect_url"
}

POST/api/paypal/execute

Execute completed PayPal payment

Parameters:

• paymentId
• payerId

Response:

{
  "message": "Payment successful",
  "credits_awarded": "number"
}