Skip to main content

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:
Get your API key from the Dashboard → Settings → API Keys

Upload Your First App

The response includes your magic link:

CI/CD Integration

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

GitHub Actions Example

Create preview apps for every PR to streamline code reviews:

GitLab CI Example

Common API Endpoints

Core Operations

Automation & Testing

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

Use Cases

1. Continuous Deployment

Automatically deploy every commit:

2. Nightly Build Distribution

Share nightly builds with your QA team:

3. Feature Branch Previews

Create previews for each feature branch:

Best Practices

  • 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

Error Handling

Common error responses and solutions:
Check that your API key is valid and included in the Authorization header
Compress your app or upgrade to a higher plan for larger file limits
You’ve exceeded the rate limit. Wait and retry or upgrade your plan
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