Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.insforge.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

InsForge provides two partnership models that enable seamless integration of our Backend-as-a-Service platform into your applications. Whether you’re looking for a co-branded solution or a fully white-labeled experience, we have the right partnership model for you.

​
Partnership Models

Co-Branded Partnership

Perfect for platforms that want to offer InsForge alongside their services. The integration process is remarkably simple - developers can connect to the InsForge platform with just one click, without complicated OAuth flows.

White-Label Partnership

Ideal for platforms seeking complete control over the user experience. Offers full project lifecycle management, including project dashboard integration. Developers can complete all operations without ever leaving your partner platform.

​
Partnership Benefits

Scalable Infrastructure

Leverage our robust backend infrastructure without the overhead of maintenance and scaling

Flexible Integration

Choose from multiple integration options that best suit your application needs

Revenue Sharing

Benefit from our competitive revenue sharing model for partner applications

Technical Support

Get dedicated technical support and resources to ensure smooth integration

​
Getting Started

1

Apply for Partnership

Submit your partnership application through our partner email. Specify whether you’re interested in co-branded or white-label partnership.
2

Receive Partner Credentials

Once approved, you’ll receive:
  • Partner ID: Your unique partner identifier
  • Secret Key: Your authentication key for API access
  • Integration documentation and support
3

Configure Authentication

All API requests must include your secret key for authentication:
curl -X POST https://api.insforge.dev/partnership/v1/YOUR_PARTNER_ID/endpoint \
  -H "Content-Type: application/json" \
  -H "X-Partnership-Secret: YOUR_SECRET_KEY"
4

Start Integration

Begin integrating based on your partnership model using our API endpoints.

​
Features by Partnership Type

​
Co-Branded Features

In co-branded mode, developers explicitly know they are InsForge platform users (linked through the same email address). After logging into the InsForge platform, developers have full management rights for projects created through partners and need to pay according to InsForge’s billing plans. Partner platforms can:
  • Sync user accounts (name, email) with InsForge
  • Sync projects to InsForge
  • Query project connection information to leverage the completed backend capabilities.

​
White-Label Features

In white-label mode, developers are not aware of InsForge’s existence and cannot see partner-created projects on the InsForge platform. Partner platforms can:
  • Create embedded projects
  • Query project metadata to leverage the completed backend capabilities.
  • Pause projects
  • Restore projects
  • Delete projects
  • Get project’s authorization token for access
  • Get project’s usage
  • Get aggregated usage across all partnership projects (for billing)

​
API Reference

​
Connect User Account

Synchronize user account information with InsForge.
POST /partnership/v1/:partnerId/connect-user
Request Body:
{
  "name": "John Doe",      // required
  "email": "john@example.com" // required
}
Response:
{
  "account": {
    "id": "uuid-string"
  }
}

​
Sync Project

Create or synchronize a project for a specific user.
POST /partnership/v1/:partnerId/:userId/sync-project
Request Body:
{
  "project_name": "my-project",  // required
  "region": "us-east",         // optional, "us-east", "us-west", "ap-southeast", "eu-central", default: "us-east"
  "instance_type": "nano"      // optional, "nano", "micro", "small", "medium", "large", "xl", "2xl", "4xl", "8xl", "16xl", default: "nano"
}
Response:
{
  "success": true,
  "project": {
    "id": "uuid-string",
    "access_host": "https://project.us-east.insforge.app",
    "api_key": "project-api-key",
    "status": "active"
  }
}

​
Handling Project Limits

Note: Due to project limits on the InsForge free plan, project synchronization from partner platforms may fail. In such cases, the response will be:
{
  "success": false,
  "message": "Free plan allows up to 2 active projects. Please upgrade your plan to create more projects.",
  "candidate_projects": [
    {
      "id": "uuid-string",
      "access_host": "https://project2.us-east.insforge.app",
      "api_key": "project-api-key",
      "status": "active"
    }
  ]
}
Partners can guide users to select existing projects for connection rather than always creating new ones.

​
Get Project Metadata

Retrieve connection information for a specific project.
GET /partnership/v1/:partnerId/:userId/:projectId/metadata
Response:
{
  "project": {
    "id": "uuid-string",
    "access_host": "https://project.us-east.insforge.app",
    "api_key": "project-api-key",
    "status": "active"
  }
}

​
Integration Examples

​
Co-Branded Integration Flow

The following sequence diagram illustrates the integration flow for co-branded partnerships: 
// 1. Connect user account
const connectUser = async (name: string, email: string) => {
  const response = await fetch(
    `https://api.insforge.dev/partnership/v1/${PARTNER_ID}/connect-user`,
    {
      method: 'POST',
      headers: {
        'X-Partnership-Secret': `${SECRET_KEY}`,
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({ name, email })
    }
  );

  const { account } = await response.json();
  return account.id;
};

// 2. Create project for user
const createProject = async (userId: string, projectName: string) => {
  const response = await fetch(
    `https://api.insforge.dev/partnership/v1/${PARTNER_ID}/${userId}/sync-project`,
    {
      method: 'POST',
      headers: {
        'X-Partnership-Secret': `${SECRET_KEY}`,
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        project_name: projectName,
        region: 'us-east',
        instance_type: 'nano'
      })
    }
  );

  const data = await response.json();
  if (data.success) {
    return data.project;
  }
  throw new Error(data.message);
};

// 3. Use project credentials
console.log(project.access_host);
console.log(project.api_key);

​
White-Label Integration Flow

The following sequence diagram illustrates the integration flow for white-label partnerships: 
// 1. Create embedded project
const createEmbeddedProject = async (projectName: string) => {
  const response = await fetch(
    `https://api.insforge.dev/partnership/v1/${PARTNER_ID}/sync-embedded-project`,
    {
      method: 'POST',
      headers: {
        'X-Partnership-Secret': `${SECRET_KEY}`,
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        project_name: projectName,
        region: 'eu-west',
        instance_type: 'small'
      })
    }
  );

  const data = await response.json();
  if (data.success) {
    return data.project;
  }
  throw new Error(data.message);
};

// 2. Manage project lifecycle
const pauseProject = async (projectId: string) => {
  const response = await fetch(
    `https://api.insforge.dev/partnership/v1/${PARTNER_ID}/${projectId}/pause`,
    {
      method: 'POST',
      headers: {
        'X-Partnership-Secret': `${SECRET_KEY}`,
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        wait_for_completion: true
      })
    }
  );

  const { project } = await response.json();
  console.log(`Project ${project.id} status: ${project.status}`);
};

const restoreProject = async (projectId: string) => {
  const response = await fetch(
    `https://api.insforge.dev/partnership/v1/${PARTNER_ID}/${projectId}/restore`,
    {
      method: 'POST',
      headers: {
        'X-Partnership-Secret': `${SECRET_KEY}`,
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        wait_for_completion: true
      })
    }
  );

  const { project } = await response.json();
  console.log(`Project ${project.id} status: ${project.status}`);
};

// 3. Delete project
const deleteProject = async (projectId: string) => {
  const response = await fetch(
    `https://api.insforge.dev/partnership/v1/${PARTNER_ID}/${projectId}`,
    {
      method: 'DELETE',
      headers: {
        'X-Partnership-Secret': `${SECRET_KEY}`
      }
    }
  );

  if (response.ok) {
    const data = await response.json();
    console.log(data.message); // "Project deleted successfully"
    console.log(`Request ID: ${data.requestId}`);
  } else {
    throw new Error(`Failed to delete project: ${response.status}`);
  }
};

// 4. Get partnership total usage (for billing)
const getPartnershipUsage = async (startDate: string, endDate: string) => {
  const params = new URLSearchParams({ start_date: startDate, end_date: endDate });
  const response = await fetch(
    `https://api.insforge.dev/partnership/v1/${PARTNER_ID}/usage?${params}`,
    {
      method: 'GET',
      headers: {
        'X-Partnership-Secret': `${SECRET_KEY}`
      }
    }
  );

  const data = await response.json();
  console.log(`Period: ${data.period.start} to ${data.period.end}`);
  console.log(`Database: ${data.summary.database_bytes} bytes (peak)`);
  console.log(`Storage: ${data.summary.storage_bytes} bytes (peak)`);
  console.log(`AI Credits: ${data.summary.ai_credits}`);
  console.log(`Egress: ${data.summary.egress_bytes} bytes`);
  return data;
};

​
Parameter and Response Reference

​
Project Region Values

InsForge provides global deployment capabilities. Each project can be deployed to different regions:
  • us-east - United States East Coast
  • us-west - United States West Coast
  • ap-southeast - Asia Pacific Southeast
  • eu-central - Europe Central
Additional regions will be added based on demand.

​
Project Instance Type Values

Based on your project’s business requirements, InsForge offers the following resource types:
  • nano - Minimal resources for development
  • micro - Basic resources for testing and development
  • small - Light workloads
  • medium - Standard applications
  • large - Production workloads
  • xl - High-performance applications
  • 2xl - Enterprise applications
  • 4xl - Large-scale operations
  • 8xl - Mission-critical systems
  • 16xl - Maximum performance

​
Project Status Values

Projects can have the following status values:
  • active: Project is running and accessible
  • paused: Project is paused (white-label only)

​
Error Handling

All API endpoints return consistent error responses: 
{
  "success": false,
  "message": "Detailed error message describing what went wrong"
}
Common error scenarios:
  • Invalid authentication credentials
  • Project not found
  • Insufficient permissions for requested operation
  • Invalid request parameters

​
Next Steps