Skip to main content

​
Phonefarm

Phonefarm is externally triggered TikTok execution infrastructure. Upstream systems such as UGC Tracker submit work, Phonefarm materializes that work onto phones, and callers observe normalized process state through callbacks and polling.

​
Who These Docs Are For

  • Teams integrating Phonefarm into another product or control plane.
  • Agents that need exact request and response contracts.
  • Engineers who need to understand process lifecycle, callbacks, idempotency, and capability constraints.

​
What Phonefarm Is

  • A process-oriented execution API.
  • A capability runner for keyword_warmup, fyp_warmup, and maintenance.
  • A normalized process-status layer over richer internal queue and runtime mechanics.

​
What Phonefarm Is Not

  • Not a content generation system.
  • Not a scheduler that invents work on its own for external callers.
  • Not a public control plane for low-level worker internals.

​
Official Integration Model

The primary public abstraction is the process API:
  1. Create work with POST /capability-requests/enqueue or POST /maintenance/requests.
  2. Receive process.updated callbacks on key milestones.
  3. Poll GET /processes/{process_id} for source-of-truth state.
  4. Cancel with POST /processes/{process_id}/cancel when needed.
Legacy queue-item posting endpoints still exist:
  • POST /ingest
  • POST /cancel
Those are compatibility endpoints for direct post-video queue items. New integrations should start with the process model.

​
Base URLs

  • Public API base URL: https://phonefarm.withmithras.com
  • Public docs base URL: https://docs.withmithras.com

​
Current Public Capabilities

  • keyword_warmup
  • fyp_warmup
  • maintenance

​
Important Caveats

  • fyp_warmup is currently blocked for unattended use.
  • Callbacks are best-effort delivery. GET /processes/{process_id} is the source of truth.
  • Public statuses are normalized views over richer internal states.
  • Public timestamps are milestone-derived and should not be treated as precise device-action timestamps.