API Reference

The NativeBridge REST API enables you to programmatically upload apps, manage builds, generate magic links, and automate your mobile testing workflows.

📚 Full API Documentation

View our complete API reference with interactive examples on Postman

Key Features

App Management

Upload, update, and manage your app builds programmatically

Magic Links

Auto-generate shareable magic links for every build

CI/CD Integration

Integrate with GitHub Actions, GitLab CI, and other pipelines

Automation

Run automated tests with Appium and Maestro

Quick Start

Authentication

All API requests require authentication using your API key:

curl -X POST https://api.nativebridge.dev/v1/apps \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Get your API key from the Dashboard → Settings → API Keys

Upload Your First App

curl -X POST https://api.nativebridge.dev/v1/apps/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@path/to/your/app.apk" \
  -F "platform=android"

The response includes your magic link:

{
  "appId": "abc123",
  "magicLink": "https://nativebridge.io/app/abc123",
  "embedUrl": "https://nativebridge.io/embed/abc123",
  "status": "ready"
}

CI/CD Integration

Auto-Generate Magic Links on Every Push

Automatically create magic links for every commit to get instant preview links for your team:

GitHub Actions Example

name: Deploy to NativeBridge

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      - name: Build App
        run: |
          # Your build commands here
          ./gradlew assembleDebug  # Android
          # or
          # xcodebuild -scheme YourApp  # iOS

      - name: Upload to NativeBridge
        id: upload
        run: |
          response=$(curl -X POST https://api.nativebridge.dev/v1/apps/upload \
            -H "Authorization: Bearer ${{ secrets.NATIVEBRIDGE_API_KEY }}" \
            -F "file=@app/build/outputs/apk/debug/app-debug.apk" \
            -F "platform=android" \
            -F "buildMessage=${{ github.event.head_commit.message }}")

          echo "response=$response" >> $GITHUB_OUTPUT
          magic_link=$(echo $response | jq -r '.magicLink')
          echo "magic_link=$magic_link" >> $GITHUB_OUTPUT

      - name: Comment PR with Magic Link
        if: github.event_name == 'pull_request'
        uses: actions/github-script@v6
        with:
          script: |
            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: `🚀 **App Preview Ready!**\n\nTest this build: ${{ steps.upload.outputs.magic_link }}\n\n_Powered by NativeBridge_`
            })

Auto-Generate Links for Pull Requests

Create preview apps for every PR to streamline code reviews:

GitLab CI Example

deploy_preview:
  stage: deploy
  script:
    - |
      # Build your app
      ./gradlew assembleDebug

      # Upload to NativeBridge
      RESPONSE=$(curl -X POST https://api.nativebridge.dev/v1/apps/upload \
        -H "Authorization: Bearer $NATIVEBRIDGE_API_KEY" \
        -F "file=@app/build/outputs/apk/debug/app-debug.apk" \
        -F "platform=android" \
        -F "buildMessage=PR: $CI_MERGE_REQUEST_TITLE")

      # Extract magic link
      MAGIC_LINK=$(echo $RESPONSE | jq -r '.magicLink')

      # Post comment to MR
      curl -X POST "$CI_API_V4_URL/projects/$CI_PROJECT_ID/merge_requests/$CI_MERGE_REQUEST_IID/notes" \
        -H "PRIVATE-TOKEN: $GITLAB_TOKEN" \
        -d "body=🚀 **Preview App Ready**: $MAGIC_LINK"

  only:
    - merge_requests

Common API Endpoints

Core Operations

Endpoint	Method	Description
`/v1/apps/upload`	POST	Upload a new app or update existing
`/v1/apps/{appId}`	GET	Get app details and magic link
`/v1/apps/{appId}/builds`	GET	List all builds for an app
`/v1/apps/{appId}`	DELETE	Delete an app
`/v1/apps/{appId}/permissions`	PUT	Update app permissions

Automation & Testing

Endpoint	Method	Description
`/v1/sessions/start`	POST	Start a new testing session
`/v1/sessions/{sessionId}/screenshot`	GET	Capture screenshot
`/v1/sessions/{sessionId}/logs`	GET	Get device logs
`/v1/sessions/{sessionId}/stop`	POST	End testing session

For complete endpoint documentation, request/response schemas, and interactive examples, visit our Postman Documentation

Use Cases

1. Continuous Deployment

Automatically deploy every commit:

// Node.js Example
const FormData = require('form-data');
const fs = require('fs');

async function deployToNativeBridge(appPath, commitMessage) {
  const form = new FormData();
  form.append('file', fs.createReadStream(appPath));
  form.append('platform', 'ios');
  form.append('buildMessage', commitMessage);

  const response = await fetch('https://api.nativebridge.dev/v1/apps/upload', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${process.env.NATIVEBRIDGE_API_KEY}`,
      ...form.getHeaders()
    },
    body: form
  });

  const result = await response.json();
  console.log(`Magic Link: ${result.magicLink}`);
  return result;
}

2. Nightly Build Distribution

Share nightly builds with your QA team:

# Python Example
import requests
import schedule
import time

def upload_nightly_build():
    with open('app-nightly.apk', 'rb') as f:
        files = {'file': f}
        data = {
            'platform': 'android',
            'buildMessage': f'Nightly Build - {time.strftime("%Y-%m-%d")}'
        }
        headers = {
            'Authorization': f'Bearer {API_KEY}'
        }

        response = requests.post(
            'https://api.nativebridge.dev/v1/apps/upload',
            files=files,
            data=data,
            headers=headers
        )

        magic_link = response.json()['magicLink']
        send_slack_notification(magic_link)  # Share with team

# Schedule nightly at 2 AM
schedule.every().day.at("02:00").do(upload_nightly_build)

3. Feature Branch Previews

Create previews for each feature branch:

#!/bin/bash
# deploy-preview.sh

BRANCH_NAME=$(git rev-parse --abbrev-ref HEAD)
BUILD_MESSAGE="Feature: $BRANCH_NAME"

# Build app
./gradlew assembleDebug

# Upload and get magic link
RESPONSE=$(curl -s -X POST https://api.nativebridge.dev/v1/apps/upload \
  -H "Authorization: Bearer $NATIVEBRIDGE_API_KEY" \
  -F "file=@app/build/outputs/apk/debug/app-debug.apk" \
  -F "platform=android" \
  -F "buildMessage=$BUILD_MESSAGE")

MAGIC_LINK=$(echo $RESPONSE | jq -r '.magicLink')

echo "✅ Preview ready: $MAGIC_LINK"

# Update PR description or send to Slack

Best Practices

Security
Performance
Organization

Store API keys in environment variables or secrets management
Never commit API keys to version control
Use different API keys for production and development
Rotate API keys regularly

Rate Limits

Plan	Requests/Hour	Concurrent Uploads	Max App Size
Free	60	1	100 MB
Starter	300	3	500 MB
Growth	1000	10	1 GB
Custom	Unlimited	Unlimited	Unlimited

Error Handling

Common error responses and solutions:

{
  "error": "INVALID_FILE_FORMAT",
  "message": "File must be .apk, .app, or .ipa",
  "solution": "Ensure you're uploading a valid app file"
}

401 Unauthorized

Check that your API key is valid and included in the Authorization header

413 File Too Large

Compress your app or upgrade to a higher plan for larger file limits

429 Rate Limited

You’ve exceeded the rate limit. Wait and retry or upgrade your plan

500 Server Error

Temporary issue on our end. Retry with exponential backoff

SDK & Libraries

Node.js SDK

npm install nativebridge

Python SDK

pip install nativebridge

GitHub Action

Official GitHub Action

Next Steps

View Full API Docs

Explore all endpoints with examples

Get API Key

Generate your API key to get started

Test Automation

Automation and CI/CD integration

Support

Get help with API integration

Getting Started

Platform

Testing

API

API Reference

API Reference

📚 Full API Documentation

Key Features

App Management

Magic Links

CI/CD Integration

Automation

Quick Start

Authentication

Upload Your First App

CI/CD Integration

Auto-Generate Magic Links on Every Push

GitHub Actions Example

Auto-Generate Links for Pull Requests

GitLab CI Example

Common API Endpoints

Core Operations

Automation & Testing

Use Cases

1. Continuous Deployment

2. Nightly Build Distribution

3. Feature Branch Previews

Best Practices

Rate Limits

Error Handling

SDK & Libraries

Node.js SDK

Python SDK

GitHub Action

Next Steps

View Full API Docs

Get API Key

Test Automation

Support

Getting Started

Platform

Testing

API

Documentation Index

​API Reference

​📚 Full API Documentation

​Key Features

App Management

Magic Links

CI/CD Integration

Automation

​Quick Start

​Authentication

​Upload Your First App

​CI/CD Integration

​Auto-Generate Magic Links on Every Push

​GitHub Actions Example

​Auto-Generate Links for Pull Requests

​GitLab CI Example

​Common API Endpoints

​Core Operations

​Automation & Testing

​Use Cases

​1. Continuous Deployment

​2. Nightly Build Distribution

​3. Feature Branch Previews

​Best Practices

​Rate Limits

​Error Handling

​SDK & Libraries

Node.js SDK

Python SDK

GitHub Action

​Next Steps

View Full API Docs

Get API Key

Test Automation

Support

API Reference

📚 Full API Documentation

Key Features

Quick Start

Authentication

Upload Your First App

CI/CD Integration

Auto-Generate Magic Links on Every Push

GitHub Actions Example

Auto-Generate Links for Pull Requests

GitLab CI Example

Common API Endpoints

Core Operations

Automation & Testing

Use Cases

1. Continuous Deployment

2. Nightly Build Distribution

3. Feature Branch Previews

Best Practices

Rate Limits

Error Handling

SDK & Libraries

Next Steps