Organization Management Org CRUD, members, billing, transfer (agent→human), discovery

An organization (org) is a collector of workspaces. It can represent a company, a business unit, a team, or simply a personal collection. Orgs are the billable entity — storage, credits, and member limits are tracked at the org level. Every workspace and share lives under an org.

Profile IDs are 19-digit numeric strings. Most endpoints also accept the org's domain name (e.g., acme) in place of the numeric ID.

Internal vs External Orgs

Agents must call both GET /current/orgs/list/ and GET /current/orgs/list/external/ to discover all orgs they can access.

• Internal orgs (member: true) — orgs you created or were invited to join as a member. You have org-level access: see all workspaces (subject to permissions), manage settings if admin, appear in the member list. Listed via GET /current/orgs/list/.
• External orgs (member: false) — orgs you access only through workspace membership. A human invited you to their workspace but not to the org itself. You can see the org's name and basic public info, but cannot manage org settings, see other workspaces, or add org members. Listed via GET /current/orgs/list/external/.

External orgs are the most common pattern when a human invites an agent to help with a specific project — they add the agent to a workspace but not to the org itself.

If the human later invites the agent to the org itself, it moves from external to internal and gains org-level access.

Org Field Constraints

Member Roles and Permissions

The perm_member_manage org setting controls the minimum role required to add, remove, or update members.

Organization CRUD

Create Organization

Rate limits: 3/20s, 8/60s, 20/hr, 60/day

Request parameters

Agent accounts are always assigned the agent plan (free: 50 GB storage, 5,000 credits/month, no trial, no expiration). Agents cannot select or change to a human plan.

curl example

curl -X POST "https://api.fast.io/current/org/create/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "domain=acme-corp" \
  -d "name=Acme Corporation" \
  -d "industry=technology"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "org": {
      "id": "1234567890123456789",
      "domain": "acme-corp",
      "name": "Acme Corporation",
      "description": null,
      "logo": null,
      "accent_color": null,
      "closed": false,
      "suspended": false
    },
    "has_free_trial": true,
    "requires_payment": false,
    "is_agent": false
  }
}

When user is ineligible for free trial:

{
  "result": "yes",
  "response": {
    "org": { "...": "..." },
    "has_free_trial": false,
    "requires_payment": true,
    "no_trial_reason": "existing_org"
  }
}

Response fields

Error responses

Get Org Details

{org_id} accepts a 19-digit numeric ID or the org's domain name.

Access levels

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/details/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "org": {
      "id": "1234567890123456789",
      "domain": "acme-corp",
      "name": "Acme Corporation",
      "description": "Leading provider of innovation",
      "logo": "https://assets.fast.io/org/logo.png",
      "accent_color": "#0066CC",
      "closed": false,
      "locked": false,
      "suspended": false,
      "created": "2024-01-15 10:30:00",
      "updated": "2024-06-20 14:45:00"
    }
  }
}

Response fields

Error responses

Get Public Org Details

Rate limits: 30/60s, 1000/hr, 5000/day (IP-based)

{org_id} accepts a 19-digit numeric ID or the org's domain name.

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/public/details/"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "org": {
      "id": "1234567890123456789",
      "domain": "acme-corp",
      "name": "Acme Corporation",
      "description": "Leading provider of innovation",
      "logo": "https://assets.fast.io/org/logo.png",
      "accent_color": "#0066CC"
    }
  }
}

Response fields

Update Organization

Rate limits: 1/3s, 5/10s, 20/60s, 100/hr

Access levels

Request parameters (all optional)

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/update/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "name=Acme Corp Updated" \
  -d "description=Updated description" \
  -d "industry=technology"

Response (200 OK)

{
  "result": "yes"
}

If no actual changes are detected, returns success immediately.

Error responses

Close Organization

Rate limits: 1/3s, 2/60s, 3/hr, 4/day

Request parameters

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/close/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "confirm=acme-corp"

Response (202 Accepted)

{
  "result": "yes"
}

Error responses

Storage deletion is deferred to the deletion system after a retention period.

Organization Assets

List Available Asset Types

curl example

curl -X GET "https://api.fast.io/current/org/assets/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "assets": [
      {
        "name": "logo",
        "mime_types": ["image/png", "image/jpeg"],
        "max_size": 5242880
      }
    ]
  }
}

List Org Assets

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/assets/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "assets": {
      "logo": {
        "url": "https://assets.fast.io/org/logo.png",
        "mime_type": "image/png",
        "size": 45678
      }
    }
  }
}

Upload Org Asset

Request parameters

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/assets/logo/" \
  -H "Authorization: Bearer {jwt_token}" \
  -F "file=@logo.png"

Error responses

Delete Org Asset

curl example

curl -X DELETE "https://api.fast.io/current/org/1234567890123456789/assets/logo/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes"
}

Read Org Asset (Raw)

HEAD requests return headers only.

Organization Members

Add or Invite a Member

Rate limits: 10/3s, 25/10s, 50/60s, 100/hr, 1000/day

The target is specified as a path parameter:

• Use a user ID (19-digit numeric) to add an existing user directly
• Use an email address to send an invitation

Request parameters (adding existing user by ID)

Request parameters (inviting by email)

curl example (add existing user)

curl -X POST "https://api.fast.io/current/org/1234567890123456789/members/9876543210987654321/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "permissions=member"

curl example (invite by email)

curl -X POST "https://api.fast.io/current/org/1234567890123456789/members/jane@example.com/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "permissions=member" \
  -d "message=Welcome to the team!"

Response (200 OK) — direct add

{
  "result": "yes"
}

Response (200 OK) — invitation created

{
  "result": "yes",
  "response": {
    "invitation": {
      "id": "eA1B2C3D4E5F6G7H8J9K0L1M2N3O4",
      "invitee_email": "jane@example.com",
      "entity_type": "org",
      "state": "pending",
      "created": "2024-01-15 10:30:00"
    }
  }
}

Error responses

Remove a Member

Rate limits: 1/3s, 2/10s, 5/60s, 20/hr, 100/day

The target user ID (19-digit numeric) is a path parameter.

curl example

curl -X DELETE "https://api.fast.io/current/org/1234567890123456789/members/9876543210987654321/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes"
}

List Org Members

Rate limits: 20/3s, 50/10s, 200/60s, 500/hr, 10000/day

Query parameters

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/members/list/?limit=50&offset=0" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "users": [
      {
        "id": "1234567890123456789",
        "account_type": "human",
        "email_address": "owner@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "permissions": "owner"
      },
      {
        "id": "1234567890123456780",
        "account_type": "agent",
        "email_address": "bot@example.com",
        "first_name": "Service",
        "last_name": "Bot",
        "permissions": "admin"
      }
    ],
    "pagination": {
      "total": 2,
      "limit": 50,
      "offset": 0,
      "has_more": false
    }
  }
}

Response fields

Leave Organization (Self)

curl example

curl -X DELETE "https://api.fast.io/current/org/1234567890123456789/member/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes"
}

Error responses

Get Member Details

Rate limits: 200/3s, 500/10s, 750/60s, 1000/hr, 2500/day

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/member/9876543210987654321/details/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "member": {
      "id": "9876543210987654321",
      "account_type": "human",
      "email_address": "jane@example.com",
      "first_name": "Jane",
      "last_name": "Smith",
      "permissions": "admin",
      "invite": "accepted",
      "notify": "Email me",
      "expires": null
    }
  }
}

Response fields

Error responses

Update Member Permissions

Rate limits: 10/3s, 25/10s, 50/60s, 100/hr, 1000/day

Request parameters (all optional)

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/member/9876543210987654321/update/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "permissions=admin"

Response (200 OK)

{
  "result": "yes"
}

Error responses

Transfer Org Ownership

Rate limits: 10/3s, 25/10s, 50/60s, 100/hr, 1000/day

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/member/9876543210987654321/transfer_ownership/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes"
}

Error responses

Join Organization

Rate limits: 10/3s, 25/10s, 50/60s, 100/hr, 1000/day

Join methods

1. Via invitation: Append the invitation key to the URL path: .../join/{invitation_key}/ optionally followed by accept or decline. Default is accept.
2. Via authorized domain: The org must have perm_authorized_domains set and the user's email domain must match. User is added as a Member.

curl example (invitation)

curl -X POST "https://api.fast.io/current/org/1234567890123456789/members/join/abc123def456/accept/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes"
}

Error responses

List Org Invitations

Rate limits: 10/3s, 25/10s, 50/60s, 100/hr, 1000/day

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/members/invitations/list/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "invitations": [
      {
        "id": "eA1B2C3D4E5F6G7H8J9K0L1M2N3O4",
        "inviter": "John Doe",
        "invitee_email": "jane@example.com",
        "entity_type": "org",
        "state": "pending",
        "created": "2024-01-15 10:30:00",
        "expires": "2024-02-15 10:30:00"
      }
    ]
  }
}

Response fields

Error responses

Update an Invitation

Rate limits: 10/60s, 20/600s, 30/hr

{invitation_id} can be the invitation ID or the invitee email address.

Request parameters (all optional)

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/members/invitation/eA1B2C3D4E5F6G7H8J9K0L1M2N3O4/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "permissions=admin"

Response (200 OK)

{
  "result": "yes"
}

Error responses

Delete an Invitation

Rate limits: 10/60s, 20/600s, 30/hr

{invitation_id} can be the invitation ID or the invitee email address.

curl example

curl -X DELETE "https://api.fast.io/current/org/1234567890123456789/members/invitation/eA1B2C3D4E5F6G7H8J9K0L1M2N3O4/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes"
}

Error responses

Organization Transfer (Agent to Human)

Agents build orgs, then transfer ownership to humans. The human gets the org plus all workspaces; the agent stays as admin. Only agent accounts can create/list/delete tokens; only human accounts can claim.

The claim URL for humans: https://go.fast.io/claim?token={token}

Create Transfer Token

Rate limits: 5/min, 20/hour, 50/day

Creates a transfer token: 64-character string, valid 72 hours. Max 5 active tokens per org.

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/transfer/token/create/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "transfer_token": {
      "id": "eA1B2C3D4E5F6G7H8J9K0L1M2N3O4",
      "token": "a1b2c3d4e5f6g7h8j9k0l1m2n3o4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2",
      "org_id": 1234567890123456789,
      "state": "pending",
      "expires": "2026-02-04T12:00:00+00:00",
      "created": "2026-02-01T12:00:00+00:00"
    }
  }
}

Response fields

Error responses

List Transfer Tokens

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/transfer/token/list/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "results": 1,
    "transfer_tokens": [
      {
        "id": "eA1B2C3D4E5F6G7H8J9K0L1M2N3O4",
        "token": "a1b2c3d4e5f6g7h8j9k0l1m2n3o4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2",
        "org_id": 1234567890123456789,
        "state": "pending",
        "expires": "2026-02-04T12:00:00+00:00",
        "created": "2026-02-01T12:00:00+00:00"
      }
    ]
  }
}

Error responses

Delete Transfer Token

curl example

curl -X DELETE "https://api.fast.io/current/org/1234567890123456789/transfer/token/eA1B2C3D4E5F6G7H8J9K0L1M2N3O4/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "transfer_token": {
      "id": "eA1B2C3D4E5F6G7H8J9K0L1M2N3O4",
      "token": "a1b2c3d4e5f6g7h8j9k0l1m2n3o4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2",
      "org_id": 1234567890123456789,
      "state": "deleted",
      "expires": "2026-02-04T12:00:00+00:00",
      "created": "2026-02-01T12:00:00+00:00"
    }
  }
}

Error responses

Public Token Details (Preview Before Claiming)

Rate limits: 15/10s, 100/hr, 500/day (IP-based)

Query parameters

curl example

curl -X GET "https://api.fast.io/current/org/transfer/claim/public/details/?token=a1b2c3d4e5f6g7h8j9k0l1m2n3o4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "transfer_token": {
      "id": "eA1B2C3D4E5F6G7H8J9K0L1M2N3O4",
      "state": "pending",
      "is_claimable": true,
      "expires": "2026-02-04T12:00:00+00:00",
      "created": "2026-02-01T12:00:00+00:00"
    },
    "org": {
      "id": "1234567890123456789",
      "domain": "my-agent-org",
      "name": "My Agent Org",
      "description": "An org built by an AI agent",
      "logo": null,
      "accent_color": null,
      "closed": false,
      "suspended": false
    },
    "created_by": {
      "id": "9876543210987654321",
      "account_type": "agent",
      "email_address": "agent@example.com",
      "first_name": "Agent",
      "last_name": "Smith"
    }
  }
}

Response fields

Error responses

Claim Organization

Rate limits: 5/min, 10/hour, 30/day

Request parameters

curl example

curl -X POST "https://api.fast.io/current/org/transfer/claim/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "token=a1b2c3d4e5f6g7h8j9k0l1m2n3o4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "org": {
      "id": "1234567890123456789",
      "domain": "my-agent-org",
      "plan": "free"
    },
    "previous_owner": {
      "id": "9876543210987654321",
      "account_type": "agent"
    },
    "workspaces_transferred": 3
  }
}

Response fields

What happens during claim

1. Organization ownership transfers to the human user
2. Previous agent owner becomes an admin member of the org
3. Billing plan changes from agent to free (credit-based, no trial period)
4. All workspaces: human becomes owner, agent becomes admin
5. Transfer token marked as "claimed"
6. Free trial period starts from the transfer date

Error responses

Organization Discovery

List Internal Orgs

Non-admin/non-owner members only see orgs with active subscriptions; admins and owners always see their orgs.

curl example

curl -X GET "https://api.fast.io/current/orgs/list/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "orgs": [
      {
        "id": "1234567890123456789",
        "domain": "acme-corp",
        "name": "Acme Corporation",
        "description": "Leading provider of innovation",
        "logo": "https://assets.fast.io/org/logo.png",
        "accent_color": "#0066CC",
        "closed": false,
        "suspended": false,
        "subscriber": true,
        "user_status": "joined",
        "member": true
      }
    ]
  }
}

Response fields

Subscription filtering

List External Orgs

Rate limits: 250/hr, 3000/day

curl example

curl -X GET "https://api.fast.io/current/orgs/list/external/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "orgs": [
      {
        "id": "1234567890123456780",
        "domain": "partner-corp",
        "name": "Partner Corporation",
        "description": "External partner organization",
        "logo": null,
        "accent_color": "#FF6600",
        "closed": false,
        "suspended": false,
        "subscriber": true,
        "user_status": "available",
        "member": false
      }
    ]
  }
}

Response fields

List All Orgs

curl example

curl -X GET "https://api.fast.io/current/orgs/all/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "orgs": [
      {
        "id": "1234567890123456789",
        "domain": "acme-corp",
        "name": "Acme Corporation",
        "description": "Leading provider of innovation",
        "logo": "https://assets.fast.io/org/logo.png",
        "accent_color": "#0066CC",
        "closed": false,
        "suspended": false,
        "user_status": "joined"
      }
    ]
  }
}

Response fields

List Available Orgs

curl example

curl -X GET "https://api.fast.io/current/orgs/available/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "orgs": [
      {
        "id": "1234567890123456782",
        "domain": "new-company",
        "name": "New Company",
        "description": "An org you can join",
        "logo": null,
        "accent_color": "#FF6600",
        "closed": false,
        "suspended": false
      }
    ]
  }
}

Check Domain Availability

Rate limits: 15/3s, 50/10s, 80/60s, 250/hr, 1000/day

Path parameters

curl example

curl -X GET "https://api.fast.io/current/orgs/check/domain/acme-corp" \
  -H "Authorization: Bearer {jwt_token}"

Response (202 Accepted) — domain available

{
  "result": "yes"
}

Error responses

List Industries

curl example

curl -X GET "https://api.fast.io/current/orgs/industries/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "technology": {
      "title": "Technology",
      "description": "Software, hardware, and IT services"
    },
    "healthcare": {
      "title": "Healthcare",
      "description": "Medical, pharmaceutical, and health services"
    },
    "finance": {
      "title": "Finance",
      "description": "Banking, investment, and financial services"
    },
    "education": {
      "title": "Education",
      "description": "Schools, universities, and training providers"
    }
  }
}

Response fields

Billing

Create or Update Subscription

Rate limits: 10/60s, 20/600s, 30/hr

Request parameters

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/billing/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "billing_plan=pro_monthly"

Response (201 Created) — new subscription

{
  "result": "yes",
  "response": {
    "subscription": { "...": "..." },
    "customer": { "...": "..." },
    "setup_intent": {
      "id": "seti_xxx",
      "client_secret": "seti_xxx_secret_xxx",
      "status": "requires_payment_method"
    },
    "is_active": false,
    "is_trial_eligible": true,
    "public_key": "pk_xxx"
  }
}

Response (202 Accepted) — subscription updated.

Error responses

Cancel Subscription

Rate limits: 10/60s, 20/600s, 30/hr

curl example

curl -X DELETE "https://api.fast.io/current/org/1234567890123456789/billing/" \
  -H "Authorization: Bearer {jwt_token}"

Response (202 Accepted)

{
  "result": "yes",
  "response": {
    "status": "cancelled",
    "message": "Subscription has been successfully cancelled",
    "closed": false
  }
}

If already cancelled:

{
  "result": "yes",
  "response": {
    "status": "already_cancelled",
    "message": "Subscription is already cancelled"
  }
}

Response fields

Error responses

Get Billing Details

Rate limits: 500/600s, 10000/day

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/billing/details/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "subscription": { "...": "..." },
    "customer": { "...": "..." },
    "setup_intent": { "...": "..." },
    "payment_intent": { "...": "..." },
    "is_active": true,
    "is_trial_eligible": false,
    "is_cancelled": false,
    "current_plan": "pro_monthly",
    "previous_plan": null,
    "public_key": "pk_xxx"
  }
}

Response fields

Get Credit Usage

Rate limits: 500/60s, 20000/day

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/billing/usage/limits/credits/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": true,
  "credit_limits_enabled": true,
  "free_org_mode": true,
  "org_id": "1234567890123456789",
  "plan": "free",
  "over_limit": false,
  "usage": {
    "credits_used": 1200,
    "credit_limit": 10000,
    "credits_remaining": 8800,
    "usage_percentage": 12.0
  },
  "period": {
    "start": "2025-01-15T10:00:00+00:00",
    "end": "2025-02-14T10:00:00+00:00",
    "days_total": 30,
    "days_elapsed": 10,
    "days_remaining": 20
  },
  "renewal": {
    "interval_days": 30,
    "next_renewal": "2025-02-14T10:00:00+00:00"
  },
  "trial": null
}

Response fields

Credit costs: storage (100/GB), bandwidth (212/GB), AI tokens (1/100 tokens), document ingestion (10/page), video ingestion (5/sec), image ingestion (5/image), file conversions (25/each).

List Billable Members

Rate limits: 1/2s, 2/10s, 5/60s, 15/hr, 50/day

Query parameters

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/billing/usage/members/list/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "billable_members": [
      {
        "id": "1234567890123456789",
        "account_type": "human",
        "email_address": "user@example.com",
        "parents": {
          "9876543210987654321": {
            "permission": "member",
            "date_joined": "2024-01-15 10:30:00"
          }
        }
      }
    ]
  }
}

Response fields

Get Usage Meters

Rate limits: 30/3s, 80/10s, 200/60s, 600/hr, 12000/day

Query parameters

Only one of workspace_id or share_id can be specified at a time.

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/billing/usage/meters/list/?meter=storage_bytes&start_time=2024-01-01+00:00:00&end_time=2024-01-31+23:59:59" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "usage": {
      "meter": "storage_bytes",
      "total": 1073741824,
      "cost": 0.50,
      "credits": 500,
      "start_time": "2024-01-01 00:00:00 UTC",
      "end_time": "2024-01-31 23:59:59 UTC",
      "interval_hours": 24,
      "workspace_id": null,
      "share_id": null,
      "data_points": [
        {
          "start_time": "2024-01-01 00:00:00 UTC",
          "end_time": "2024-01-02 00:00:00 UTC",
          "value": 536870912,
          "cost": 0.25,
          "credits": 250
        }
      ]
    }
  }
}

Response fields

Error responses

List Available Plans

• Agent accounts only see the agent plan
• Human accounts see human plans: free, pro, business

Agents cannot subscribe to human plans.

curl example

curl -X GET "https://api.fast.io/current/org/billing/plan/list/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "results": 3,
    "defaults": {
      "pro": "pro_monthly",
      "business": "business_monthly"
    },
    "plans": [
      {
        "id": "free",
        "name": "Free",
        "category": "free",
        "amount": 0
      },
      {
        "id": "pro_monthly",
        "name": "Pro",
        "category": "pro",
        "amount": 2900
      },
      {
        "id": "business_monthly",
        "name": "Business",
        "category": "business",
        "amount": 4900
      }
    ]
  }
}

Response fields

Create Workspace (from Org)

Rate limits: 1/3s, 2/10s, 5/60s, 20/hr, 100/day

Request parameters

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/create/workspace/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "folder_name=project-alpha" \
  -d "name=Project Alpha" \
  -d "perm_join=Member or above" \
  -d "perm_member_manage=Admin or above" \
  -d "intelligence=true"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "workspace": {
      "id": "1234567890123456780",
      "folder_name": "project-alpha"
    }
  }
}

Response fields

Error responses

List Workspaces in Org

Rate limits: Org members: 500/hr, 5000/day. External users: 100/hr, 500/day.

Query parameters

Access levels

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/list/workspaces/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "workspaces": [
      {
        "id": "1234567890123456780",
        "folder_name": "project-alpha",
        "name": "Project Alpha",
        "description": "Main project workspace"
      }
    ]
  }
}

Response fields