{"info":{"_postman_id":"a0a09bb5-1a05-4d54-9a91-f07470298467","name":"NativeBridge Public API","description":"

Welcome to the NativeBridge Public API documentation.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"41713518","collectionId":"a0a09bb5-1a05-4d54-9a91-f07470298467","publishedId":"2sAYkGLf4d","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-03-21T11:16:59.000Z"},"item":[{"name":"APIs","item":[{"name":"List Devices","id":"ed88aa8c-5d89-45e3-af5e-180d1db9d732","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"Nb-XXXX-XXXX-XXXX-XXXX","type":"text"}],"url":"https://api.nativebridge.io/v1/devices","description":"

Description

\n

This endpoint retrieves a list of available devices (both real and emulated) that can be used for testing.

\n","urlObject":{"protocol":"https","path":["v1","devices"],"host":["api","nativebridge","io"],"query":[],"variable":[]}},"response":[{"id":"e3e94583-be0c-450d-b653-1daed484c363","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"Nb-XXXX-XXXX-XXXX-XXXX","type":"text"}],"url":"https://api.nativebridge.io/v1/devices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 21 Mar 2025 08:42:16 GMT"},{"key":"server","value":"uvicorn"},{"key":"content-length","value":"1481"},{"key":"content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"1234567890abcdef12345678\",\n \"type\": \"ios\",\n \"osVersion\": \"16\",\n \"modelName\": \"iPhone 14\",\n \"isEmulator\": false,\n \"userPlan\":\"paid\"\n },\n {\n \"id\": \"abcdef1234567890abcdef12\",\n \"type\": \"android\",\n \"osVersion\": \"13\",\n \"modelName\": \"Galaxy S23\",\n \"isEmulator\": false,\n \"userPlan\":\"all\"\n },\n {\n \"id\": \"fedcba0987654321fedcba09\",\n \"type\": \"android\",\n \"osVersion\": \"12\",\n \"modelName\": null,\n \"isEmulator\": true,\n \"userPlan\":\"all\"\n },\n {\n \"id\": \"456789abcdef0123456789ab\",\n \"type\": \"android\",\n \"osVersion\": \"14\",\n \"modelName\": \"Pixel 7\",\n \"isEmulator\": false,\n \"userPlan\":\"paid\"\n }\n ]\n}\n"}],"_postman_id":"ed88aa8c-5d89-45e3-af5e-180d1db9d732"},{"name":"Upload Application / Generate Magic Link","id":"515c218f-a989-4513-af7b-3d4d4210530a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"X-Api-Key","value":"Nb-XXXX.XXXX.XXXX.XXXX","type":"text"}],"body":{"mode":"formdata","formdata":[{"type":"file","contentType":"application/vnd.android.package-archive","key":"file","value":null,"disabled":true},{"type":"text","key":"allowedUsers","value":"","disabled":true},{"key":"apkUrl","value":"","type":"text","uuid":"240cfe87-491e-4c25-bb50-390af591948f","disabled":true},{"key":"accessType","value":"","type":"text","uuid":"e403db99-635b-4bd9-bed5-01f5e9f55039","disabled":true}]},"url":"https://api.nativebridge.io/v1/application","description":"

Description

\n

This endpoint allows users to upload an APK or AAB file directly or provide a public URL from which the file can be fetched. The uploaded application will be processed, and a sharable magic link will be generated.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeRequiredDescription
fileUploadFileOptionalThe APK/AAB file to be uploaded. Either file or apkUrl must be provided.
apkUrlstringOptionalA public URL to fetch the application file. Either file or apkUrl must be provided.
accessTypestringOptionalDefines whether the app is public or private. Default is public.
allowedUsersarray of stringsOptionalList of emails allowed to access the app when access_type is private.
\n

Notes

\n\n","urlObject":{"protocol":"https","path":["v1","application"],"host":["api","nativebridge","io"],"query":[],"variable":[]}},"response":[{"id":"a43c6055-db2b-4691-9825-154012b29455","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"X-Api-Key","value":"Nb-XXXX.XXXX.XXXX.XXXX","type":"text"}],"body":{"mode":"formdata","formdata":[{"type":"file","contentType":"application/vnd.android.package-archive","key":"file","value":null},{"type":"text","key":"allowedUsers","value":"xyz@gmail.com"},{"key":"apkUrl","value":"https://your-public-apk-url","type":"text","uuid":"240cfe87-491e-4c25-bb50-390af591948f","disabled":true},{"key":"accessType","value":"private","type":"text","uuid":"e403db99-635b-4bd9-bed5-01f5e9f55039"}]},"url":"https://api.nativebridge.io/v1/application"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 21 Mar 2025 12:46:17 GMT"},{"key":"server","value":"uvicorn"},{"key":"content-length","value":"92"},{"key":"content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"47nL\",\n \"magicLink\": \"https://nativebridge.io/app/47nL\",\n \"accessType\": \"public\",\n \"version\": \"1.0\"\n }\n}"}],"_postman_id":"515c218f-a989-4513-af7b-3d4d4210530a"},{"name":"List User Uploaded Applications","id":"94917bc9-854e-4025-bc98-3ead750b249d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"Nb-XXXX.XXXX.XXXX.XXXX","type":"text"}],"url":"https://api.nativebridge.io/v1/applications","description":"

Description

\n

This endpoint retrieves a list of all applications uploaded by the authenticated user, along with their details such as app name, package name, version, and access type.

\n","urlObject":{"protocol":"https","path":["v1","applications"],"host":["api","nativebridge","io"],"query":[],"variable":[]}},"response":[{"id":"0a92c868-0d08-4ecd-a4fb-6cfb4080763f","name":"Successfull Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"Nb-XXXX.XXXX.XXXX.XXXX","type":"text"}],"url":"https://api.nativebridge.io/v1/applications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 21 Mar 2025 12:27:01 GMT"},{"key":"server","value":"uvicorn"},{"key":"content-length","value":"2379"},{"key":"content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"\",\n \"magicLink\": \"\",\n \"access_type\":\"public\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"applicationType\": \"\",\n \"name\": \"\",\n \"manifestName\": \"\",\n \"packageName\": \"\",\n \"version\": \"\",\n \"views\": \"\",\n \"upvotes\": \"\",\n \"downloads\": \"\",\n \"iconImage\": \"\",\n \"defaultDeviceId\": \"\",\n \"applicationMetaData\": \"\",\n \"versionedData\":\"\"\n },\n {\n \"id\": \"\",\n \"magicLink\": \"\",\n \"access_type\":\"public\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"applicationType\": \"\",\n \"name\": \"\",\n \"manifestName\": \"\",\n \"packageName\": \"\",\n \"version\": \"\",\n \"views\": \"\",\n \"upvotes\": \"\",\n \"downloads\": \"\",\n \"iconImage\": \"\",\n \"defaultDeviceId\": \"\",\n \"applicationMetaData\": \"\",\n \"versionedData\":\"\"\n }\n ]\n}"}],"_postman_id":"94917bc9-854e-4025-bc98-3ead750b249d"},{"name":"Create Session","id":"5d4bb6f4-79a7-4f0d-8556-f0d14879073d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"Nb-XXXX.XXXX.XXXX.XXXX","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deviceId\": \"\",\n \"apkId\": \"\", //optional\n \"region\": \"ind\" // optional: \"ind\" or \"us\" defaults to \"ind\" if not provided\n}","options":{"raw":{"language":"json"}}},"url":"https://api.nativebridge.io/v1/device/session/android","description":"

Description

\n

This endpoint creates a session for an Android device, optionally launching a specific APK.

\n","urlObject":{"protocol":"https","path":["v1","device","session","android"],"host":["api","nativebridge","io"],"query":[],"variable":[]}},"response":[{"id":"50455fbc-0aa0-4702-90a7-18d319eca35d","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"Nb-XXXX.XXXX.XXXX.XXXX","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deviceId\": \"67a642531a4aa535498192f8\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.nativebridge.io/v1/device/session/android"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 21 Mar 2025 10:49:19 GMT"},{"key":"server","value":"uvicorn"},{"key":"content-length","value":"70"},{"key":"content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"sessionId\": \"\",\n \"sessionUrl\":\"\",\n \"message\": \"Session created successfully\"\n }\n}"}],"_postman_id":"5d4bb6f4-79a7-4f0d-8556-f0d14879073d"},{"name":"Session Details","id":"8155494d-1dc0-48f3-b925-6ac40598ffbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"Nb-XXXX.XXXX.XXXX.XXXX","type":"text"}],"url":"https://api.nativebridge.io/v1/session/:sessionId","description":"

Description

\n

This endpoint retrieves details of a session, including its status, queue position (if applicable), and connection details if the session is running.

\n

Session Info Explained

\n
    \n

  • sessionId – Unique ID for the session you created.

    \n
    • \n

  • status – Current state of the session (e.g., running, inqueue, completed).

    \n
    • \n

  • apkInstallationStatus – Shows whether your app was installed successfully.

    \n
    • \n

  • timeLeftInSeconds – How much time is left before the session auto-ends.

    \n
    • \n

  • deviceId – ID of the device being used in the session.

    \n
    • \n

  • adbConnectString – Use this string to connect to the device using ADB from your local machine.

    \n
    • \n

  • sessionUrl – Shareable link to open and control the live session in the browser.

    \n
    • \n

  • position – Your spot in the queue (if the session is not yet started).

    \n
    • \n

  • totalQueued – Total number of sessions currently queued.

    \n
    • \n
\n","urlObject":{"protocol":"https","path":["v1","session",":sessionId"],"host":["api","nativebridge","io"],"query":[],"variable":[{"type":"any","value":"","key":"sessionId"}]}},"response":[{"id":"97b601bb-6a8a-47e3-9947-5b945b714baa","name":"Successfule Response(Running/completed)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"Nb-XXXX.XXXX.XXXX.XXXX","type":"text"}],"url":{"raw":"https://api.nativebridge.io/v1/session/:sessionId","protocol":"https","host":["api","nativebridge","io"],"path":["v1","session",":sessionId"],"variable":[{"key":"sessionId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 21 Mar 2025 12:19:20 GMT"},{"key":"server","value":"uvicorn"},{"key":"content-length","value":"185"},{"key":"content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"sessionId\": \"\",\n \"status\": \"running\",\n \"apkInstallationStatus\": \"\",\n \"timeLeftInSeconds\": \"\",\n \"deviceId\": \"\",\n \"adbConnectString\": \"\",\n \"sessionUrl\": \"\"\n }\n}"},{"id":"433d26a9-40a6-40e9-8b6f-ea9091ecacfc","name":"Successful Response(InQueue Session)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"Nb-XXXX.XXXX.XXXX.XXXX","type":"text"}],"url":{"raw":"https://api.nativebridge.io/v1/session/:sessionId","protocol":"https","host":["api","nativebridge","io"],"path":["v1","session",":sessionId"],"variable":[{"key":"sessionId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"sessionId\": \"\",\n \"position\": 3,\n \"totalQueued\": 10,\n \"status\": \"inqueue\"\n }\n}\n"}],"_postman_id":"8155494d-1dc0-48f3-b925-6ac40598ffbf"},{"name":"Kill Session","id":"40550b48-9643-4420-ba95-1bea6af290b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"Nb-XXXX.XXXX.XXXX.XXXX","type":"text"}],"url":"https://api.nativebridge.io/v1/session/:sessionId","description":"

Description

\n

This endpoint is used to delete a specific session identified by the session ID.

\n","urlObject":{"protocol":"https","path":["v1","session",":sessionId"],"host":["api","nativebridge","io"],"query":[],"variable":[{"type":"any","value":"","key":"sessionId"}]}},"response":[{"id":"3062b9ae-53bf-434a-b6a6-65e9c518974b","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"Nb-XXXX.XXXX.XXXX.XXXX","type":"text"}],"url":"https://api.nativebridge.io/v1/session/Mat7"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 21 Mar 2025 12:11:33 GMT"},{"key":"server","value":"uvicorn"},{"key":"content-length","value":"62"},{"key":"content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"\",\n \"sessionId\": \"\"\n}"}],"_postman_id":"40550b48-9643-4420-ba95-1bea6af290b8"},{"name":"New Request","id":"b6af2833-de28-486e-a1e2-9c90d146020a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"your_api_key_here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My Test Project\",\n \"description\": \"E2E tests for mobile app\"\n }","options":{"raw":{"language":"json"}}},"url":"https://api.nativebridge.io/v1/projects","description":"

Create Project

\n

Create a new test project.

\n","urlObject":{"protocol":"https","path":["v1","projects"],"host":["api","nativebridge","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"b6af2833-de28-486e-a1e2-9c90d146020a"},{"name":"List User Projects","id":"215639ce-e3de-45a8-a745-06fbe20fcf77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"your_api_key_here"}],"url":"https://api.nativebridge.io/v1/projects","description":"

List Projects

\n

Retrieve all your projects.

\n","urlObject":{"protocol":"https","path":["v1","projects"],"host":["api","nativebridge","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"215639ce-e3de-45a8-a745-06fbe20fcf77"},{"name":"New Request","id":"07e8a823-983b-470a-9b9c-cf1c80b963be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"your_api_key_here"}],"url":"https://api.nativebridge.io/v1/projects/:projectId/files","description":"

Get Project Files

\n

List all files and folders in a project.

\n","urlObject":{"protocol":"https","path":["v1","projects",":projectId","files"],"host":["api","nativebridge","io"],"query":[],"variable":[{"type":"any","value":"","key":"projectId"}]}},"response":[],"_postman_id":"07e8a823-983b-470a-9b9c-cf1c80b963be"},{"name":"New Request","id":"3eee05fe-0440-40d1-95a8-3a29a8161df6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"your_api_key_here"}],"body":{"mode":"formdata","formdata":[{"type":"file","key":"files","value":null}]},"url":"https://api.nativebridge.io/v1/projects/:projectId/import","description":"

Upload Test Files

\n

Upload test files to a project.

\n","urlObject":{"protocol":"https","path":["v1","projects",":projectId","import"],"host":["api","nativebridge","io"],"query":[],"variable":[{"type":"any","value":"","key":"projectId"}]}},"response":[],"_postman_id":"3eee05fe-0440-40d1-95a8-3a29a8161df6"}],"id":"85a3e264-5448-4b80-b933-7f7f944c2185","description":"

Authentication & API Key Usage

\n

To use the NativeBridge APIs, you must authenticate using an API key. Follow these steps to obtain and use your API key:

\n
    \n

  1. Create an Account: Visit NativeBridge.io and sign up for an account.

    \n
    2. \n

  2. Generate an API Key: Navigate to the API Keys section in your dashboard and create a new API key.

    \n
    3. \n

  3. Use the API Key:

    \n
      \n
    • Include the API key in every request using the X-Api-Key header.
      • \n
    \n
    4. \n
\n","_postman_id":"85a3e264-5448-4b80-b933-7f7f944c2185"}],"variable":[{"key":"baseUrl","value":"","type":"default"}]}