Clousd Devices API

The Devices API from Clousd — 14 operation(s) for devices.

GitHub OpenAPI

Operations 16

GET /devices Devices this key can see #
POST /devices Create a device (charged to the account of the API key) #
GET /devices/{name} One device #
DELETE /devices/{name} Delete the device: it moves to Trash for 14 days (not running, not billed) and… #
POST /devices/{name}/start Start the device #
POST /devices/{name}/stop Stop the device (state is kept; a stopped device costs nothing) #
POST /devices/{name}/restart Restart the device #
GET /devices/{name}/ice ICE servers for a WebRTC viewer of this device: the TURN of the device's host… #
GET /devices/{name}/quality Quality by category (last measurement) #
GET /android Android versions you can create devices on #
GET /trash Devices in Trash, with when each one is deleted for good #
POST /trash/{name}/restore Bring a device back from Trash as a stopped device (start it when you need it) #
POST /devices/{name}/reset Reset the device to a fresh state: apps and data are wiped, the phone comes… #
GET /devices/{name}/screenrecord Record the screen for a few seconds #
POST /devices/{name}/label Give a phone a name people and agents can tell apart ("QA team"); empty = back… #
GET /balance The account's money - balance, spend per day, hours left, renewals and warnings… #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/clousd-com:clousd-com-devices-api"
All apis
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.

Get an API 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. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

clousd-com-devices-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Clousd Com Devices API
  version: '1.0'
  description: 'Operations tagged Devices across 2 of this provider''s published API definitions: clousd-com-openapi-v1.yaml, clousd-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.clousd.com/v1
security:
- bearer: []
tags:
- name: Devices
paths:
  /devices:
    get:
      summary: Devices this key can see
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  devices:
                    type: array
                    items:
                      $ref: '#/components/schemas/Device'
      tags:
      - Devices
      operationId: getDevices
      x-operation-id-source: derived
    post:
      summary: Create a device (charged to the account of the API key)
      description: 'One device per call. Creating a phone is free; it runs pay as you go by the minute from the account balance (a plan''s minutes are used first); a paid network exit (mobile, residential, isp, datacenter) is metered per GB. Idempotency-Key (header, or idempotency_key / name in the body) is required - a retry with the same key within 10 minutes returns the same answer and is not charged twice. The device boots in one to three minutes: poll GET /devices/{name}.'
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          type: string
          maxLength: 120
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - android
              properties:
                android:
                  type: string
                  example: '14'
                  description: Android version from GET /android. The phone model is picked by the service
                label:
                  type: string
                  maxLength: 40
                  description: 'the name shown in the dashboard; empty = "Phone #N"'
                network:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - false
                      - byo
                      - mobile
                      - residential
                      - isp
                      - datacenter
                    country:
                      type: string
                      description: ISO-2 for paid exits
                    url:
                      type: string
                      description: socks5:// or http:// for byo
                region:
                  type: string
                  description: where the device itself runs (ISO-2); default - the exit country
                burner:
                  type: boolean
                  description: disposable - stopping deletes it
                idempotency_key:
                  type: string
      responses:
        '202':
          description: Creating
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  name:
                    type: string
                  ext_id:
                    type: string
                  state:
                    type: string
                    const: starting
                  poll:
                    type: string
                  charged_cents:
                    type: integer
                  android:
                    type: string
        '400':
          description: bad_android (the answer lists the available versions) | bad_network | bad_request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: insufficient_funds - add funds in the dashboard
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: only account API keys can create devices
        '409':
          description: limit (50 devices per account) | processing (same Idempotency-Key still running)
        '502':
          description: the device service did not answer - nothing was charged
      tags:
      - Devices
      operationId: postDevices
      x-operation-id-source: derived
    servers:
    - url: https://api.clousd.com/v1
  /devices/{name}:
    parameters:
    - $ref: '#/components/parameters/name'
    get:
      summary: One device
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  device:
                    $ref: '#/components/schemas/Device'
        '404':
          $ref: '#/components/responses/Error'
      tags:
      - Devices
      operationId: getDevicesByName
      x-operation-id-source: derived
    delete:
      summary: 'Delete the device: it moves to Trash for 14 days (not running, not billed) and…'
      parameters:
      - name: forever
        in: query
        required: false
        schema:
          type: string
          enum:
          - '1'
      responses:
        '200':
          description: Moved to Trash
          content:
            application/json:
              schema:
                type: object
                properties:
                  trashed:
                    type: boolean
                  device:
                    type: string
                  purge_at:
                    type: string
                    format: date-time
                  note:
                    type: string
        '202':
          $ref: '#/components/responses/Job'
        '409':
          $ref: '#/components/responses/Error'
      tags:
      - Devices
      operationId: deleteDevicesByName
      x-operation-id-source: derived
    servers:
    - url: https://api.clousd.com/v1
  /devices/{name}/start:
    parameters:
    - $ref: '#/components/parameters/name'
    post:
      summary: Start the device
      responses:
        '202':
          $ref: '#/components/responses/Job'
      tags:
      - Devices
      operationId: postDevicesByNameStart
      x-operation-id-source: derived
    servers:
    - url: https://api.clousd.com/v1
  /devices/{name}/stop:
    parameters:
    - $ref: '#/components/parameters/name'
    post:
      summary: Stop the device (state is kept; a stopped device costs nothing)
      responses:
        '202':
          $ref: '#/components/responses/Job'
      tags:
      - Devices
      operationId: postDevicesByNameStop
      x-operation-id-source: derived
    servers:
    - url: https://api.clousd.com/v1
  /devices/{name}/restart:
    parameters:
    - $ref: '#/components/parameters/name'
    post:
      summary: Restart the device
      responses:
        '202':
          $ref: '#/components/responses/Job'
      tags:
      - Devices
      operationId: postDevicesByNameRestart
      x-operation-id-source: derived
    servers:
    - url: https://api.clousd.com/v1
  /devices/{name}/ice:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    get:
      summary: 'ICE servers for a WebRTC viewer of this device: the TURN of the device''s host…'
      description: Pass them as RTCPeerConnection({iceServers}) before POST …/stream. Needed behind VPNs that block non-proxied UDP and strict NATs; empty when the host has no TURN. The credential lives ttl seconds - ask again before it expires.
      parameters:
      - name: viewer
        in: query
        required: false
        schema:
          type: string
          maxLength: 40
        description: Viewer id, as in stream stats
      responses:
        '200':
          description: ICE servers
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  ttl:
                    type: integer
                    description: Credential lifetime in seconds (0 = no TURN)
                  ice_servers:
                    type: array
                    items:
                      type: object
                      properties:
                        urls:
                          type: array
                          items:
                            type: string
                          example:
                          - turn:stream.clousd.com:3478?transport=udp
                          - turns:stream.clousd.com:5349?transport=tcp
                        username:
                          type: string
                        credential:
                          type: string
      tags:
      - Devices
      operationId: getDevicesByNameIce
      x-operation-id-source: derived
    servers:
    - url: https://api.clousd.com/v1
  /devices/{name}/quality:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Quality by category (last measurement)
      responses:
        '200':
          description: Categories
          content:
            application/json:
              schema:
                type: object
                properties:
                  overall:
                    type: number
                  measured_at:
                    type: string
                  categories:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        label:
                          type: string
                        score:
                          type: number
                          nullable: true
      tags:
      - Devices
      operationId: getDevicesByNameQuality
      x-operation-id-source: derived
    servers:
    - url: https://api.clousd.com/v1
  /android:
    get:
      summary: Android versions you can create devices on
      description: Create a device with one of them - POST /devices {android}. The phone model is picked by the service.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  android:
                    type: array
                    items:
                      type: string
                    example:
                    - '12'
                    - '13'
                    - '14'
                    - '15'
                    - '16'
                    - '17'
                  note:
                    type: string
      tags:
      - Devices
      operationId: getAndroid
      x-operation-id-source: derived
    servers:
    - url: https://api.clousd.com/v1
  /trash:
    get:
      summary: Devices in Trash, with when each one is deleted for good
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  trash:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        label:
                          type: string
                        android:
                          type: string
                        deleted_at:
                          type: string
                          format: date-time
                        purge_at:
                          type: string
                          format: date-time
                        reason:
                          type: string
                          enum:
                          - user
                          - api
                          - stopped
                          - expired
                        ready:
                          type: boolean
      tags:
      - Devices
      operationId: getTrash
      x-operation-id-source: derived
    servers:
    - url: https://api.clousd.com/v1
  /trash/{name}/restore:
    parameters:
    - $ref: '#/components/parameters/name'
    post:
      summary: Bring a device back from Trash as a stopped device (start it when you need it)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  device:
                    type: string
                  state:
                    type: string
                  note:
                    type: string
        '404':
          $ref: '#/components/responses/Error'
        '409':
          $ref: '#/components/responses/Error'
      tags:
      - Devices
      operationId: postTrashByNameRestore
      x-operation-id-source: derived
    servers:
    - url: https://api.clousd.com/v1
  /devices/{name}/reset:
    parameters:
    - $ref: '#/components/parameters/name'
    post:
      summary: 'Reset the device to a fresh state: apps and data are wiped, the phone comes…'
      responses:
        '202':
          $ref: '#/components/responses/Job'
      tags:
      - Devices
      operationId: postDevicesByNameReset
      x-operation-id-source: derived
    servers:
    - url: https://api.clousd.com/v1
  /devices/{name}/screenrecord:
    parameters:
    - $ref: '#/components/parameters/name'
    get:
      summary: Record the screen for a few seconds
      parameters:
      - name: seconds
        in: query
        description: 1-60, default 10
        schema:
          type: integer
          minimum: 1
          maximum: 60
      responses:
        '200':
          description: The recording
          content:
            video/mp4:
              schema:
                type: string
                format: binary
        '409':
          description: Another recording is running on this phone
      tags:
      - Devices
      operationId: getDevicesByNameScreenrecord
      x-operation-id-source: derived
    servers:
    - url: https://api.clousd.com/v1
  /devices/{name}/label:
    post:
      summary: Give a phone a name people and agents can tell apart ("QA team"); empty = back…
      parameters:
      - $ref: '#/components/parameters/name'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  maxLength: 40
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  label:
                    type: string
                  own_label:
                    type:
                    - string
                    - 'null'
      tags:
      - Devices
      operationId: postDevicesByNameLabel
      x-operation-id-source: derived
    servers:
    - url: https://api.clousd.com/v1
  /balance:
    get:
      summary: The account's money - balance, spend per day, hours left, renewals and warnings…
      description: spend_per_day = running per-minute phones (hourly price up to the daily cap) + paid proxy traffic of the last 24 hours; runs_out_in_hours = balance / spend; warnings are ready sentences (hours left, traffic cost, monthly renewals above the balance, below the minimum to start). Check it before starting phones or long runs.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  balance:
                    type: string
                  balance_cents:
                    type: integer
                  spend_per_day:
                    type: string
                  runs_out_in_hours:
                    type:
                    - number
                    - 'null'
                  warnings:
                    type: array
                    items:
                      type: string
                  top_up:
                    type: string
      tags:
      - Devices
      operationId: getBalance
      x-operation-id-source: derived
    servers:
    - url: https://api.clousd.com/v1
components:
  schemas:
    Job:
      type: object
      properties:
        id:
          type: string
        kind:
          type: string
        phone:
          type: string
        state:
          type: string
          enum:
          - running
          - done
          - failed
        started:
          type: string
          format: date-time
        done:
          type: string
          format: date-time
        output:
          type: string
    Device:
      type: object
      properties:
        name:
          type: string
        label:
          type: string
          example: 'Phone #3'
          description: 'the name shown in the dashboard; "Phone #N" unless renamed'
        number:
          type: integer
          example: 3
        android:
          type: string
          example: '14'
        state:
          type: string
          enum:
          - running
          - stopped
          - starting
          - error
    Error:
      type: object
      properties:
        ok:
          type: boolean
          const: false
        error:
          type: string
        message:
          type: string
  responses:
    Error:
      description: Error
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              message:
                type: string
    Job:
      description: Started
      content:
        application/json:
          schema:
            type: object
            properties:
              ok:
                type: boolean
              job:
                $ref: '#/components/schemas/Job'
  parameters:
    name:
      name: name
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
x-refined-from:
- clousd-com-openapi-v1.yaml
- clousd-com-openapi.yml