Boxes API

Boxes API

The Boxes API allows you to create and manage protection boxes for claimed identities. A box defines the protection policy for a claimed identity.

Note

A claim must be verified before a box can be created for it.

List Boxes

List boxes associated with your account.

Endpoint

GET /v1/lmif/boxes

Request

SDK

const boxes = await lmif.boxes.list({
  limit: 20,
  policy: 'MONETIZE'
});

cURL

curl https://api.lookmaimfamous.com/v1/lmif/boxes?limit=20 \
  -H "Authorization: Bearer lmif_live_xxx"

Query Parameters

Parameter	Type	Description
limit	integer	Max items (default: 20, max: 100)
offset	integer	Items to skip
policy	string	Filter by policy type
claimId	string	Filter by claim ID

Response

{
  "data": [
    {
      "id": "box_abc123",
      "claimId": "claim_xyz789",
      "identityName": "Taylor Swift",
      "policy": "MONETIZE",
      "enforcement": "MODERATE",
      "royaltyRate": 0.10,
      "status": "active",
      "createdAt": "2024-01-05T00:00:00Z",
      "stats": {
        "totalViolations": 47,
        "activeGracePeriods": 3,
        "licensedPlatforms": 12,
        "monthlyRevenue": 15000
      }
    }
  ],
  "meta": {
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

Get Box

Get details of a specific box.

Endpoint

GET /v1/lmif/boxes/{id}

Request

SDK

const box = await lmif.boxes.get('box_abc123');

cURL

curl https://api.lookmaimfamous.com/v1/lmif/boxes/box_abc123 \
  -H "Authorization: Bearer lmif_live_xxx"

Response

{
  "data": {
    "id": "box_abc123",
    "claimId": "claim_xyz789",
    "identityName": "Taylor Swift",
    "policy": "MONETIZE",
    "enforcement": "MODERATE",
    "policyConfig": {
      "royaltyRate": 0.10,
      "revenueTypes": ["subscription", "per_message", "tips"],
      "minimumPayout": 100,
      "contentGuidelines": "https://...",
      "nsfw": false
    },
    "status": "active",
    "createdAt": "2024-01-05T00:00:00Z",
    "updatedAt": "2024-01-10T00:00:00Z",
    "stats": {
      "totalViolations": 47,
      "resolvedViolations": 44,
      "activeGracePeriods": 3,
      "licensedPlatforms": 12,
      "totalLicenses": 15,
      "monthlyRevenue": 15000,
      "lifetimeRevenue": 45000
    }
  }
}

Create Box

Create a protection box for a verified claim.

Endpoint

POST /v1/lmif/boxes

Request

SDK

const box = await lmif.boxes.create({
  claimId: 'claim_xyz789',
  policy: 'MONETIZE',
  enforcement: 'MODERATE',
  policyConfig: {
    royaltyRate: 0.10,
    revenueTypes: ['subscription', 'per_message', 'tips'],
    minimumPayout: 100,
    nsfw: false
  }
});

cURL

curl -X POST https://api.lookmaimfamous.com/v1/lmif/boxes \
  -H "Authorization: Bearer lmif_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "claimId": "claim_xyz789",
    "policy": "MONETIZE",
    "enforcement": "MODERATE",
    "policyConfig": {
      "royaltyRate": 0.10,
      "revenueTypes": ["subscription", "per_message", "tips"],
      "minimumPayout": 100,
      "nsfw": false
    }
  }'

Request Body

Field	Type	Required	Description
claimId	string	Yes	ID of the verified claim
policy	string	Yes	Policy type (see below)
enforcement	string	No	Enforcement level (default: MODERATE)
policyConfig	object	No	Policy-specific configuration

Policy Types

Policy	Description
BLOCK_ALL	No AI avatars allowed
BLOCK_COMMERCIAL	Allow personal, block commercial
MONETIZE	Allow with revenue share
LICENSE	Require explicit license
TEAM	Only authorized accounts
OPEN	Allow all (monitoring only)

Policy Config by Type

For MONETIZE:

{
  "royaltyRate": 0.10,
  "revenueTypes": ["subscription", "per_message", "tips", "ads"],
  "minimumPayout": 100,
  "nsfw": false
}

For LICENSE:

{
  "licenseTypes": {
    "personal": { "price": 0, "autoApprove": true },
    "creator": { "price": 50, "autoApprove": false },
    "commercial": { "price": 500, "autoApprove": false }
  },
  "contentGuidelines": "https://...",
  "nsfw": false
}

For TEAM:

{
  "authorizedAccounts": ["account_123", "account_456"],
  "platformWhitelist": ["myorbit.ai"]
}

For BLOCK_COMMERCIAL:

{
  "allowedUses": ["personal", "educational", "parody"]
}

Response

{
  "data": {
    "id": "box_new456",
    "claimId": "claim_xyz789",
    "identityName": "Taylor Swift",
    "policy": "MONETIZE",
    "enforcement": "MODERATE",
    "status": "active",
    "createdAt": "2024-01-15T10:00:00Z",
    "initialScan": {
      "status": "in_progress",
      "estimatedCompletion": "2024-01-15T10:05:00Z"
    }
  }
}

Note

When a box is created, LMIF automatically scans for existing violations. This may trigger grace periods for existing avatars.

Update Box

Update a box’s policy or configuration.

Endpoint

PATCH /v1/lmif/boxes/{id}

Request

SDK

const updated = await lmif.boxes.update('box_abc123', {
  policy: 'BLOCK_ALL',
  enforcement: 'STRICT'
});

cURL

curl -X PATCH https://api.lookmaimfamous.com/v1/lmif/boxes/box_abc123 \
  -H "Authorization: Bearer lmif_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "policy": "BLOCK_ALL",
    "enforcement": "STRICT"
  }'

Updateable Fields

Field	Description
policy	Policy type
enforcement	Enforcement level
policyConfig	Policy configuration

Caution

Changing to a more restrictive policy triggers new grace periods for existing licensed avatars.

Delete Box

Remove a box (stops protection).

Endpoint

DELETE /v1/lmif/boxes/{id}

Request

SDK

await lmif.boxes.delete('box_abc123');

cURL

curl -X DELETE https://api.lookmaimfamous.com/v1/lmif/boxes/box_abc123 \
  -H "Authorization: Bearer lmif_live_xxx"

Response

{
  "data": {
    "id": "box_abc123",
    "deleted": true,
    "deletedAt": "2024-01-15T12:00:00Z",
    "activeLicenses": 15,
    "licenseAction": "remain_active"
  }
}

Note

Deleting a box doesn’t revoke existing licenses. They remain active until their expiration.

Get Box Statistics

Get detailed statistics for a box.

Endpoint

GET /v1/lmif/boxes/{id}/stats

Response

{
  "data": {
    "boxId": "box_abc123",
    "period": "2024-01",
    "violations": {
      "detected": 47,
      "resolved": 44,
      "pending": 3,
      "appealed": 2
    },
    "gracePeriods": {
      "active": 3,
      "expired": 41,
      "resolved": 38
    },
    "licenses": {
      "total": 15,
      "active": 12,
      "pending": 2,
      "expired": 1
    },
    "revenue": {
      "monthly": 15000,
      "lifetime": 45000,
      "byType": {
        "subscriptions": 10000,
        "messages": 3000,
        "tips": 2000
      }
    },
    "platforms": {
      "licensed": 12,
      "topPlatforms": [
        { "name": "Platform A", "revenue": 5000, "users": 10000 },
        { "name": "Platform B", "revenue": 3000, "users": 7500 }
      ]
    }
  }
}

Enforcement Levels

Level	Behavior
STRICT	Immediate action, no exceptions
MODERATE	Standard grace period, standard review
RELAXED	Extended grace period, lenient on edge cases