.do

APIs.do

REST and RPC APIs for the .do platform

Build autonomous businesses with powerful APIs.

Quick Start

# Get API key from dashboard
export API_KEY="your-api-key"

# Get API info
curl -H "Authorization: Bearer $API_KEY" \
  https://apis.do

# Access primitives
curl -H "Authorization: Bearer $API_KEY" \
  https://apis.do/businesses

# Access integrations
curl -H "Authorization: Bearer $API_KEY" \
  https://apis.do/github/repos/owner/repo/issues

Response Format

All API responses follow HATEOAS principles with semantic JSON-LD metadata:

{
  "$id": "https://apis.do",
  "$context": "https://platform.do",
  "$type": "https://schema.org.ai/API",
  "api": {
    "version": "1.0.0",
    "platform": "platform.do",
    "endpoint": "https://apis.do",
    "documentation": "https://docs.platform.do/api",
    "status": "https://status.platform.do"
  },
  "links": {
    "primitives": {
      "businesses": "https://apis.do/businesses",
      "teams": "https://apis.do/teams",
      "agents": "https://apis.do/agents",
      "workflows": "https://apis.do/workflows",
      "functions": "https://apis.do/functions",
      "databases": "https://apis.do/databases",
      "events": "https://apis.do/events",
      "analytics": "https://apis.do/analytics"
    },
    "integrations": {
      "github": "https://apis.do/github",
      "stripe": "https://apis.do/stripe",
      "slack": "https://apis.do/slack",
      "email": "https://apis.do/email",
      "cloudflare": "https://apis.do/cloudflare",
      "openai": "https://apis.do/openai"
    },
    "examples": {
      "github-issues": "https://apis.do/github/repos/owner/repo/issues",
      "stripe-customers": "https://apis.do/stripe/customers",
      "slack-messages": "https://apis.do/slack/channels/general/messages",
      "business-workflows": "https://apis.do/businesses/acme-inc/workflows"
    },
    "docs": {
      "quickstart": "https://docs.platform.do/api",
      "authentication": "https://docs.platform.do/api/auth",
      "primitives": "https://docs.platform.do/primitives",
      "integrations": "https://docs.platform.do/integrations"
    }
  },
  "readme": [
    "# APIs.do - Platform API",
    "Unified REST and RPC API for autonomous business operations.",
    "",
    "Access core primitives (Businesses, Teams, Agents, Workflows, Functions,",
    "Databases, Events, Analytics) and 9000+ integrations (GitHub, Stripe, Slack)",
    "through a single semantic API with HATEOAS navigation.",
    "",
    "Authenticate with API keys or OAuth 2.0 | Rate limits by plan | Real-time webhooks"
  ],
  "data": {
    "name": "APIs.do",
    "description": "Unified API for Platform.do autonomous business operations",
    "platform": "platform.do",
    "version": "1.0.0",
    "primitives": ["businesses", "teams", "agents", "workflows", "functions", "databases", "events", "analytics"],
    "integrations": 9010,
    "rateLimit": {
      "free": 60,
      "pro": 600,
      "business": 6000,
      "enterprise": "unlimited"
    }
  },
  "user": {
    "$id": "https://apis.do/users/john-doe",
    "name": "John Doe",
    "email": "[email protected]",
    "plan": "pro",
    "permissions": ["read", "write", "delete"],
    "links": {
      "resource": {
        "self": "https://apis.do/users/john-doe",
        "apiKeys": "https://apis.do/users/john-doe/keys"
      },
      "related": {
        "businesses": "https://apis.do/users/john-doe/businesses",
        "workflows": "https://apis.do/users/john-doe/workflows",
        "analytics": "https://apis.do/users/john-doe/analytics"
      }
    }
  },
  "meta": {
    "created": "2020-01-15T10:00:00Z",
    "updated": "2024-11-12T08:30:00Z",
    "version": 12,
    "etag": "a1b2c3d4e5f6"
  }
}

Response Fields

  • $id: API identifier (https://apis.do)
  • $context: Platform context URI (https://platform.do)
  • $type: Schema.org.ai type URI (https://schema.org.ai/API)
  • api: API metadata (version, platform, endpoint, documentation, status)
  • links: Categorized HATEOAS links ({ [category]: { [name]: url } })
    • primitives: Core resources (businesses, teams, agents, workflows, functions, databases, events, analytics)
    • integrations: Third-party services (github, stripe, slack, email, cloudflare, openai)
    • examples: Sample API paths showing usage patterns
    • docs: Documentation links (quickstart, authentication, primitives, integrations)
  • readme: Markdown content as string array (one line per element)
  • data: API information (name, description, platform, version, primitives list, integration count, rate limits)
  • user: Authenticated user with ID, plan, permissions, and resource links
  • meta: Versioning metadata (created, updated, version, etag)

API Types

Authentication

  • API keys
  • OAuth 2.0
  • Worker tokens

Resources

  • Standard CRUD operations
  • MDX file management
  • Agents, Functions, Workflows, Businesses

RPC

  • Semantic function calls
  • $.Subject.action.Object pattern
  • Custom functions

Webhooks

  • Event subscriptions
  • Real-time notifications
  • Workflow triggers

Base URL

https://apis.do

All primitives and integrations are accessed from this base URL.

Examples

import { $ } from 'sdk.do'

// Access primitives
const businesses = await $.businesses.list()
const workflow = await $.workflows.get('onboarding-flow')
const agent = await $.agents.create({ name: 'Customer Support' })

// Access integrations
const issues = await $.github.repos('owner/repo').issues.list()
const customers = await $.stripe.customers.list()
const messages = await $.slack.channels('general').messages.send({
  text: 'Hello from APIs.do!'
})

// RPC operations
const canvas = await $.ai.generate.LeanCanvas({
  businessIdea: 'AI scheduling assistant'
})

Rate Limits

PlanRequests/min
Free60
Pro600
Business6,000
EnterpriseCustom

Support

APIs.md

Markdown API - MDXLD instead of JSON

On this page

Quick StartResponse FormatResponse FieldsAPI TypesAuthenticationResourcesRPCWebhooksBase URLExamplesRate LimitsSupport