> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gatetrix.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Mobile API

> Use Access's HTTP API for human-facing operational clients, with human-profile roles and workspace visibility.

The Mobile API powers the [iOS app](/access/ios) and can support other human-facing
clients. It exposes operational state and actions, rather than full configuration
administration. It uses **human profiles**, not agent MCP credentials.

## Enable and connect

Create a credential under **Human Profiles**, then enable **Mobile API** under
**Access Channels**. Copy the endpoint shown by the Mac app. The default local
prefix is `http://127.0.0.1:37374/api`.

Send the human credential as an `Authorization: Bearer` header. An MCP credential
is not accepted. The API is disabled until enabled in Access. For another device,
use an authenticated, encrypted private VPN and connect through the Mac's VPN
address. Plain HTTP alone does not protect credentials in transit. Follow the
[connection steps](/access/ios#connect-your-iphone).

## Read state

Send `GET /state` relative to the copied API prefix. Optional query parameters
include `workspace_id` and `include_audit=false`. Results are filtered by the
human profile's workspace visibility. Audit and approval data are Admin-only.

The state includes workspaces, tasks, status updates, scheduled definitions,
occurrences, and runs. Use it to build a status or review interface.

## Role and action reference

| Action | Route relative to the API prefix | Role required |
| - | - | - |
| Read visible state | `GET /state` | Viewer, Operator, or Admin |
| Create a task | `POST /tasks` | Operator or Admin |
| Mark updates read | `POST /status-updates/mark-read` | Operator or Admin |
| Complete or cancel a task | `POST /tasks/{id}/complete` or `/cancel` | Admin |
| Decide an approval | `POST /approvals/{id}/approve` or `/decline` | Admin |
| Create a schedule | `POST /scheduled-tasks` | Admin |
| Update or remove a schedule | `PATCH` or `DELETE /scheduled-tasks/{id}` | Admin |
| Create a run now | `POST /scheduled-tasks/{id}/run-now` | Admin |
| Complete or fail a run | `POST /scheduled-task-runs/{id}/complete` or `/fail` | Admin |

This is a route overview, not a complete request-schema reference. Operators and
Viewers are limited to selected workspaces; Admins have visibility across them.
See [Human profiles](/access/permissions#human-profiles).

Even Admin credentials cannot use this API to configure connectors, perform OAuth
setup, change folder or profile grants, or browse the filesystem. Use the Mac app
for those administrative tasks. For agent tool calls, use [MCP](/access/mcp).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.