Local API Overview

TikMatrix provides a local RESTful API that allows you to manage tasks programmatically. This is useful for integrating TikMatrix with your own automation systems, building custom workflows, or creating batch operations.

Requirements

License Requirement

The Local API is only available for Pro, Team, and Business plan subscribers. Starter plan does not have access to the API.

Base URL

The API runs on your local machine at:

http://localhost:50809/api/v1/

note

The port 50809 is the default port. Make sure TikMatrix is running before making API requests.

Response Format

All API responses follow this format:

{
  "code": 0,
  "message": "success",
  "data": { ... }
}

Response Codes

Code	Description
0	Success
40001	Bad Request - Invalid parameters
40002	Bad Request - Missing script_name
40003	Bad Request - Script not supported via API
40301	Forbidden - API access requires Pro+ plan
40401	Not Found - Resource not found
50001	Internal Server Error

Quick Start

1. Check API Access

First, verify your license supports API access:

curl http://localhost:50809/api/v1/license/check

Response:

{
  "code": 0,
  "message": "success",
  "data": {
    "plan_name": "Pro",
    "api_enabled": true,
    "device_limit": 20,
    "message": "API access enabled"
  }
}

2. Create a Task

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1", "device_serial_2"],
    "script_name": "post",
    "script_config": {
      "content_type": 1,
      "captions": "Check out my new video! #viral"
    },
    "enable_multi_account": false,
    "min_interval": 1,
    "max_interval": 5
  }'

3. List Tasks

curl http://localhost:50809/api/v1/task?status=0&page=1&page_size=20

Available Scripts

Current Support

Currently, the Local API only supports the post script. More scripts will be added in future versions.

The script_name parameter accepts the following values:

Script Name	Description	API Support
post	Publish content	✅ Supported
follow	Follow a user	🔜 Coming Soon
unfollow	Unfollow a user	🔜 Coming Soon
like	Like posts	🔜 Coming Soon
comment	Comment on posts	🔜 Coming Soon
message	Send direct messages	🔜 Coming Soon
account_warmup	Warm up accounts	🔜 Coming Soon
super_marketing	Super marketing campaign	🔜 Coming Soon
profile	Update profile	🔜 Coming Soon
scrape_user	Scrape user data	🔜 Coming Soon

Task Status

Status Code	Status Text	Description
0	pending	Task is waiting to be executed
1	running	Task is currently running
2	completed	Task completed successfully
3	failed	Task failed

Next Steps

• Task Management API - Create, query, and manage tasks
• API Examples - Code examples in different languages