@fluxStyles

Active development for new features. Limited slots are already filled. Check back again.

Taratxt

Developer Docs

Welcome to the Taratxt developer documentation. Here you will find everything you need to connect your applications, AI assistants, and devices to the Taratxt platform.

1. Getting Started

How to Get Your API Key and Device Key

To interact with Taratxt programmatically or setup your Gateway Device, you will need a Personal Access Token (API key) and a Device Key.

  1. Log in to your account and navigate to the Dashboard.
  2. To get your API Key, go to the API Keys section, click Create API Key, select appropriate abilities, and copy your token.
  3. To get your Device Key, go to the Devices section. You can find the device key under each of your registered devices.
  4. Keep your keys secure as they grant access to your account and devices.

2. Setup Your Device

The easiest way to get started. Turn your Android device into a powerful automation gateway in minutes.

Requirements

  • Android Phone
  • Carrier Card with Load

Setup Steps

  1. Download the Android App (Download APK) and install it on your device.
  2. Open the app and scan the QR code from your device dashboard, or manually input your Device Key and API Key.
  3. In the app settings, toggle Run in Background to ensure the service persists.
  4. Tap Start Gateway to begin routing messages.
  5. Critical: Exclude the app from battery optimization to prevent the Android system from killing the gateway process:
    • Samsung: Settings > Apps > Taratxt > Battery > Unrestricted.
    • Xiaomi / Poco: Settings > Apps > Manage apps > Taratxt > Battery saver > No restrictions.
    • Oppo / Realme: Settings > Battery > App battery management > Taratxt > Allow background activity.
    • Vivo: Settings > Battery > Background power consumption management > Taratxt > Don't restrict background power usage.
    • Stock Android: Settings > Apps > Taratxt > App battery usage > Unrestricted.
  6. Do not close the app (swiping away from recent apps). You can safely minimize it.

3. Connecting the MCP Server

Taratxt provides a native Model Context Protocol (MCP) server that you can integrate directly into your AI assistants like Cursor or custom MCP clients. This allows your AI assistant to seamlessly interact with your Taratxt account-capable of sending messages or pulling device data automatically on your behalf without requiring custom code.

Sample MCP Configuration

Add the following to your MCP client's configuration file, making sure to replace YOUR_API_KEY with your generated token. You can generate a random string for the SESSION_ID.

"taratxt": {
  "serverUrl": "https://taratxt.com/mcp",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_API_KEY",
    "X-MCP-Session-ID": "random_generated_session_id"
  }
}

4. REST API Reference

If you prefer standard HTTP requests, you can interact with our REST API to manage devices or send messages directly from your application.

Authentication & Base URL

The base URL for all API requests is:

https://taratxt.com/api

All endpoints require an Authorization header containing your API key:

Authorization: Bearer YOUR_API_KEY
Accept: application/json

Devices API

GET /api/devices

Retrieve a paginated list of your devices.

Query Parameters:

  • project_id (optional) - Filter by project ID.
  • per_page (optional) - Number of results per page (default: 15).
POST /api/devices

Register a new device.

Body payload (JSON): 

{
  "name": "My New Phone",
  "project_id": 1 // (nullable)
}

Response:

Returns a 201 Created containing the device details including its generated unique key.

GET /api/devices/{id}

Retrieve a specific device associated with your account.

PUT /api/devices/{id}

Update a specific device.

Body payload (JSON): 

{
  "name": "Updated Phone Name", // (optional)
  "project_id": 2               // (optional)
}
DELETE /api/devices/{id}

Delete a device from your account.

Messages API

GET /api/message

Retrieve a paginated list of your inbound and outbound messages.

Query Parameters:

  • device_key (optional) - Filter messages processed by a specific device key.
  • mobile_number (optional) - Filter messages by recipient or sender number.
  • per_page (optional) - Number of results per page (default: 15).
POST /api/message

Queue an outbound SMS message to be sent via your connected devices.

Body payload (JSON): 

{
  "mobile_number": "+1234567890", // required
  "content": "Hello World!",      // required
  "device_id": 1,                 // (optional) Direct to a specific device
  "project_id": 1                 // (optional) Associate with a project
}

Response:

Returns a 201 Created with the generated Message object. Its status will initially be set to pending.