Mobilerun Tools/SIM API
The Tools/SIM API from Mobilerun — 4 operation(s) for tools/sim.
The Tools/SIM API from Mobilerun — 4 operation(s) for tools/sim.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/mobilerun-ai:mobilerun-ai-tools-sim-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Mobilerun Ai Tools/SIM API
version: v1
contact:
name: Droidrun
email: support@droidrun.ai
description: 'Operations tagged Tools/SIM across 2 of this provider''s published API definitions: openapi.json, mobilerun-ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.mobilerun.ai
description: Droidrun Cloud API
security:
- bearerAuth: []
tags:
- name: Tools/SIM
paths:
/devices/{deviceId}/esim:
delete:
description: Deletes the eSIM subscription identified by the subId query parameter from the device.
operationId: delete-esim
responses:
'204':
description: No Content
default:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error
summary: Delete eSIM subscription
tags:
- Tools/SIM
x-mint:
content: 'Get the `subId` from list-esim.
<Warning>
Deletion is permanent. To use the plan on this device again, the profile must be downloaded again with configure-esim.
</Warning>
'
parameters:
- in: path
name: deviceId
required: true
schema:
type: string
- in: header
name: X-Device-Display-ID
schema:
default: 0
format: int64
minimum: 0
type: integer
- explode: false
in: query
name: subId
required: true
schema:
format: int64
type: integer
get:
description: Returns the eSIM subscriptions currently provisioned on the device.
operationId: list-esim
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ESimSubscription'
type:
- array
- 'null'
description: OK
default:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error
summary: List eSIM subscriptions
tags:
- Tools/SIM
x-mint:
content: 'Start here: the `subId` of each entry is what the other SIM endpoints take (enable, delete, and APN calls). The list may also include physical SIM slots — entries with `isEmbedded: false` are not eSIM profiles.
'
parameters:
- in: path
name: deviceId
required: true
schema:
type: string
- in: header
name: X-Device-Display-ID
schema:
default: 0
format: int64
minimum: 0
type: integer
post:
description: Download profile and/or enable subscription.
operationId: configure-esim
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigureESimBody'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ESimSubscription'
description: OK
default:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error
summary: Configure eSIM
tags:
- Tools/SIM
x-mint:
content: 'Returns the newly installed subscription — keep its `subId` for later enable, delete, and APN calls. With `enable: true` the profile is activated in the same call; otherwise enable it later with enable-esim.
`smDpAddr` is the bare SM-DP+ address, not a full activation code. Given `LPA:1$smdp.example.com$MATCH-123`, pass `smdp.example.com` as `smDpAddr` and `MATCH-123` as `matchingId`; a fourth segment would be `confirmationCode`.
eSIM operations run one at a time per device — a concurrent call fails instead of queueing.
'
parameters:
- in: path
name: deviceId
required: true
schema:
type: string
- in: header
name: X-Device-Display-ID
schema:
default: 0
format: int64
minimum: 0
type: integer
put:
description: Enables the eSIM subscription identified by the subId in the request body so it becomes the active subscription.
operationId: enable-esim
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnableESimBody'
required: true
responses:
'204':
description: No Content
default:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error
summary: Enable an eSIM subscription
tags:
- Tools/SIM
x-mint:
content: 'Use the `subId` from list-esim or from the configure-esim response. If you passed `enable: true` to configure-esim, the new profile is already active and this call is unnecessary.
<Note>
On iOS this re-requests the plan from the carrier rather than switching profiles — iOS provides no way to deactivate an active eSIM.
</Note>
'
parameters:
- in: path
name: deviceId
required: true
schema:
type: string
- in: header
name: X-Device-Display-ID
schema:
default: 0
format: int64
minimum: 0
type: integer
servers:
- url: https://api.mobilerun.ai
description: Droidrun Cloud API
/devices/{deviceId}/esim/apn:
get:
description: Returns the access point names (APNs) configured for the device's active eSIM subscriptions.
operationId: list-esim-apns
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ESimAPN'
type:
- array
- 'null'
description: OK
default:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error
summary: List APNs for active subscriptions
tags:
- Tools/SIM
x-mint:
content: 'Use an entry''s `id` as `apnId` in select-esim-apn; `isPreferred` marks the APN currently in use. On Android the list covers all APNs of the active subscriptions, including carrier-provisioned ones; on iOS it shows only APNs created through this API.
'
parameters:
- in: path
name: deviceId
required: true
schema:
type: string
- in: header
name: X-Device-Display-ID
schema:
default: 0
format: int64
minimum: 0
type: integer
post:
description: Creates an access point name (APN) from the request body and applies it to the given eSIM subscription. Type, protocol, and roaming protocol default to common values when omitted.
operationId: set-esim-apn
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SetAPNBody'
required: true
responses:
'204':
description: No Content
default:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error
summary: Create and set an APN for an eSIM subscription
tags:
- Tools/SIM
x-mint:
content: '`subId` comes from list-esim. Defaults when omitted: `name` takes the `apn` value; `type` is `default,supl`; `protocol` and `roamingProtocol` are `IPV4V6`.
On iOS the new APN becomes active immediately, replacing the previous one. On Android it is only created — and the response doesn''t return its id — so call list-esim-apns to find it, then select-esim-apn to make it preferred.
'
parameters:
- in: path
name: deviceId
required: true
schema:
type: string
- in: header
name: X-Device-Display-ID
schema:
default: 0
format: int64
minimum: 0
type: integer
put:
description: Marks an existing APN, identified by apnId, as the preferred APN for the given eSIM subscription in the request body.
operationId: select-esim-apn
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SelectAPNBody'
required: true
responses:
'204':
description: No Content
default:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error
summary: Select an existing APN as preferred
tags:
- Tools/SIM
x-mint:
content: 'Get `apnId` from the `id` field of list-esim-apns and `subId` from list-esim. Use it after set-esim-apn on Android, where new APNs are not preferred automatically.
<Note>
iOS APNs apply device-wide, so `subId` is ignored there.
</Note>
'
parameters:
- in: path
name: deviceId
required: true
schema:
type: string
- in: header
name: X-Device-Display-ID
schema:
default: 0
format: int64
minimum: 0
type: integer
servers:
- url: https://api.mobilerun.ai
description: Droidrun Cloud API
/devices/{deviceId}/esim/roaming:
put:
description: Enables or disables data roaming for the device's eSIM based on the enabled flag in the request body.
operationId: set-esim-roaming
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SetRoamingBody'
required: true
responses:
'204':
description: No Content
default:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error
summary: Toggle eSIM data roaming
tags:
- Tools/SIM
x-mint:
content: 'Roaming is a device-wide setting — it is not scoped to a `subId`. Check the effect with get-esim-status, which reports `dataRoamingEnabled` per subscription. On iOS this toggles voice roaming along with data roaming.
'
parameters:
- in: path
name: deviceId
required: true
schema:
type: string
- in: header
name: X-Device-Display-ID
schema:
default: 0
format: int64
minimum: 0
type: integer
servers:
- url: https://api.mobilerun.ai
description: Droidrun Cloud API
/devices/{deviceId}/esim/status:
get:
description: Returns the connectivity status of the device's eSIM subscriptions.
operationId: get-esim-status
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ESimStatus'
type:
- array
- 'null'
description: OK
default:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error
summary: Get eSIM connectivity status
tags:
- Tools/SIM
x-mint:
content: 'Where list-esim shows what is provisioned, this shows how each active subscription is connecting. Poll it after enable-esim, set-esim-roaming, or an APN change to confirm mobile data actually came up (`dataState`, `networkType`) and that roaming flags took effect.
'
parameters:
- in: path
name: deviceId
required: true
schema:
type: string
- in: header
name: X-Device-Display-ID
schema:
default: 0
format: int64
minimum: 0
type: integer
servers:
- url: https://api.mobilerun.ai
description: Droidrun Cloud API
components:
schemas:
EnableESimBody:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/schemas/EnableESimBody.json
format: uri
readOnly: true
type: string
subId:
format: int64
type: integer
required:
- subId
type: object
SetRoamingBody:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/schemas/SetRoamingBody.json
format: uri
readOnly: true
type: string
enabled:
type: boolean
required:
- enabled
type: object
ESimSubscription:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/schemas/ESimSubscription.json
format: uri
readOnly: true
type: string
carrier:
type: string
displayName:
type: string
iccid:
type: string
isEmbedded:
type: boolean
slot:
format: int64
type: integer
subId:
format: int64
type: integer
type:
type: string
required:
- subId
- iccid
- carrier
- displayName
- slot
- type
- isEmbedded
type: object
ESimStatus:
additionalProperties: false
properties:
carrier:
type: string
dataRoamingEnabled:
type: boolean
dataState:
type: string
isRoaming:
type: boolean
mobileDataEnabled:
type: boolean
networkType:
type: string
operator:
type: string
phoneType:
type: string
simState:
type: string
subId:
format: int64
type: integer
required:
- subId
- carrier
- dataState
- networkType
- isRoaming
- dataRoamingEnabled
- mobileDataEnabled
- operator
- simState
- phoneType
type: object
SetAPNBody:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/schemas/SetAPNBody.json
format: uri
readOnly: true
type: string
apn:
type: string
mcc:
type: string
mnc:
type: string
name:
type: string
protocol:
type: string
roamingProtocol:
type: string
subId:
format: int64
type: integer
type:
type: string
required:
- name
- apn
- mcc
- mnc
- type
- protocol
- roamingProtocol
- subId
type: object
ErrorModel:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/schemas/ErrorModel.json
format: uri
readOnly: true
type: string
detail:
description: A human-readable explanation specific to this occurrence of the problem.
examples:
- Property foo is required but is missing.
type: string
errors:
description: Optional list of individual error details
items:
$ref: '#/components/schemas/ErrorDetail'
type:
- array
- 'null'
instance:
description: A URI reference that identifies the specific occurrence of the problem.
examples:
- https://example.com/error-log/abc123
format: uri
type: string
status:
description: HTTP status code
examples:
- 400
format: int64
type: integer
title:
description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
examples:
- Bad Request
type: string
type:
default: about:blank
description: A URI reference to human-readable documentation for the error.
examples:
- https://example.com/errors/example
format: uri
type: string
type: object
ErrorDetail:
additionalProperties: false
properties:
location:
description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
type: string
message:
description: Error message text
type: string
value:
description: The value at the given location
type: object
ESimAPN:
additionalProperties: false
properties:
apn:
type: string
id:
format: int64
type: integer
isPreferred:
type: boolean
mcc:
type: string
mnc:
type: string
name:
type: string
protocol:
type: string
roamingProtocol:
type: string
subId:
format: int64
type: integer
type:
type: string
required:
- id
- name
- apn
- mcc
- mnc
- type
- protocol
- roamingProtocol
- subId
- isPreferred
type: object
ConfigureESimBody:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/schemas/ConfigureESimBody.json
format: uri
readOnly: true
type: string
confirmationCode:
description: Optional carrier-issued confirmation code (the 4th LPA segment). Required only for plans whose SM-DP+ challenges the device for one. Requires matchingId — the LPA spec only interprets segment 4 when segment 3 is present.
type: string
enable:
type: boolean
matchingId:
type: string
smDpAddr:
type: string
required:
- smDpAddr
- enable
type: object
SelectAPNBody:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/schemas/SelectAPNBody.json
format: uri
readOnly: true
type: string
apnId:
format: int64
type: integer
subId:
format: int64
type: integer
required:
- apnId
- subId
type: object
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: Opaque
description: Bearer token via Authorization header
x-refined-from:
- openapi.json
- mobilerun-ai-openapi.json
x-provenance:
method: harvested
publisher: Mobilerun
source: https://api.mobilerun.ai/v1/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)