Blob API Documentation

Effortless integration with our fluid data visualization platform. Bring your applications to life with real-time, dynamic interactions.

All endpoints operate under:

https://api.blob.localhost/v1/{endpoint}

Authentication

API Key Authentication

Include your API key in Authorization header using Bearer token format:

Authorization: Bearer

OAuth 2.0

Use standard OAuth 2.0 flow for applications requiring user-level permissions.

POST /oauth/token
{
  "client_id": "your-app-id",
  "client_secret": "your-secret",
  "redirect_uri": "https://your/callback",
  "grant_type": "authorization_code",
  "code": "code-from-redirect"
}

Core Endpoints

Create Dynamic Blob

POST

Generate a new interactive visualization with customizable parameters.

Request Body

{
  "data_set_id": "string",
  "layout_type": "organic|grid|cluster",
  "interaction_mode": "drag|flow|zoom",
  "theme": "fluid|minimal|creative",
  "custom_options": {
    "color_scheme": ["#6366f1", "#a855f7"],
    "transition_speed": 0.5
  }
}

Response

{
  "blob_id": "blob-organic-3456",
  "visual_url": "https://blob.localhost/visuals/3456",
  "api_url": "https://api.blob.localhost/v1/visuals/3456",
  "created_at": "2025-09-26T14:30:00.000Z"
}

Update Blob Properties

PUT

Modify an active visualization's configuration in real-time.

Required blob_id (in path)

Specific ID of blob to update

Request Body

{
  "layout_type": "grid",
  "theme": "minimal",
  "transition_speed": 1.2
}

Response

{
  "success": true,
  "updated_properties": {
    "layout_type": "grid",
    "theme": "minimal",
    "transition_speed": 1.2
  }
}

Stream Live Data

PATCH

Update blob visualization with streaming data inputs for real-time updates.

Required blob_id (in path)

Request Body

{
  "data": {
    "current_values": {
      "temperature": 22.5,
      "humidity": 65,
      "pressure": 1013.2
    },
    "timestamp": "2025-09-26T14:32:00.000Z"
  }
}

Response

{
  "success": true,
  "blob_id": "blob-organic-3456",
  "updated_at": "2025-09-26T14:32:00.000Z",
  "data_processed": true
}

Try It Live

Experiment with the API using our sandbox environment. No API key required for basic features.

POST https://api.blob.localhost/v1/visuals

Need help?

Have questions about integrating Blob into your application? Our developer support team is here to help!

Contact Support

Changelog

Stay up-to-date with the latest improvements and breaking changes in our API.

View Changelog