| --- |
| title: Nca |
| emoji: 🏃 |
| colorFrom: red |
| colorTo: gray |
| sdk: docker |
| pinned: false |
| license: mit |
|
|
|
|
|
|
|
|
|
|
|
|
| --- |
| |
| ## API Endpoints |
|
|
| Each endpoint is supported by robust payload validation and detailed API documentation to facilitate easy integration and usage. |
|
|
| ### Audio |
|
|
| - **[`/v1/audio/concatenate`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/audio/concatenate.md)** |
| - Combines multiple audio files into a single audio file. |
|
|
| ### Code |
|
|
| - **[`/v1/code/execute/python`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/code/execute/execute_python.md)** |
| - Executes Python code remotely and returns the execution results. |
|
|
| ### FFmpeg |
|
|
| - **[`/v1/ffmpeg/compose`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/ffmpeg/ffmpeg_compose.md)** |
| - Provides a flexible interface to FFmpeg for complex media processing operations. |
|
|
| ### Image |
|
|
| - **[`/v1/image/convert/video`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/image/convert/image_to_video.md)** |
| - Transforms a static image into a video with custom duration and zoom effects. |
|
|
| - **[`/v1/image/screenshot/webpage`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/image/screenshot_webpage.md)** |
| - Captures screenshots of web pages using Playwright with advanced options like viewport size, device emulation, and custom HTML/CSS/JS injection. |
|
|
| ### Media |
|
|
| - **[`/v1/media/convert`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media/convert/media_convert.md)** |
| - Converts media files from one format to another with customizable codec options. |
|
|
| - **[`/v1/media/convert/mp3`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media/convert/media_to_mp3.md)** |
| - Converts various media formats specifically to MP3 audio. |
|
|
| - **[`/v1/BETA/media/download`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media/download.md)** |
| - Downloads media content from various online sources using yt-dlp. |
|
|
| - **[`/v1/media/feedback`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media/feedback.md)** |
| - Provides a web interface for collecting and displaying feedback on media content. |
|
|
| - **[`/v1/media/transcribe`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media/media_transcribe.md)** |
| - Transcribes or translates audio/video content from a provided media URL. |
|
|
| - **[`/v1/media/silence`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media/silence.md)** |
| - Detects silence intervals in a given media file. |
|
|
| - **[`/v1/media/metadata`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media/metadata.md)** |
| - Extracts comprehensive metadata from media files including format, codecs, resolution, and bitrates. |
|
|
| ### S3 |
|
|
| - **[`/v1/s3/upload`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/s3/upload.md)** |
| - Uploads files to Amazon S3 storage by streaming directly from a URL. |
|
|
| ### Toolkit |
|
|
| - **[`/v1/toolkit/authenticate`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/toolkit/authenticate.md)** |
| - Provides a simple authentication mechanism to validate API keys. |
|
|
| - **[`/v1/toolkit/test`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/toolkit/test.md)** |
| - Verifies that the NCA Toolkit API is properly installed and functioning. |
|
|
| - **[`/v1/toolkit/job/status`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/toolkit/job_status.md)** |
| - Retrieves the status of a specific job by its ID. |
|
|
| - **[`/v1/toolkit/jobs/status`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/toolkit/jobs_status.md)** |
| - Retrieves the status of all jobs within a specified time range. |
|
|
| ### Video |
|
|
| - **[`/v1/video/caption`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/video/caption_video.md)** |
| - Adds customizable captions to videos with various styling options. |
|
|
| - **[`/v1/video/concatenate`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/video/concatenate.md)** |
| - Combines multiple videos into a single continuous video file. |
|
|
| - **[`/v1/video/thumbnail`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/video/thumbnail.md)** |
| - Extracts a thumbnail image from a specific timestamp in a video. |
|
|
| - **[`/v1/video/cut`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/video/cut.md)** |
| - Cuts specified segments from a video file with optional encoding settings. |
|
|
| - **[`/v1/video/split`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/video/split.md)** |
| - Splits a video into multiple segments based on specified start and end times. |
|
|
| - **[`/v1/video/trim`](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/video/trim.md)** |
| - Trims a video by keeping only the content between specified start and end times. |
|
|
| --- |
|
|
| ## Docker Build and Run |
|
|
| ### Build the Docker Image |
|
|
| ```bash |
| docker build -t no-code-architects-toolkit . |
| ``` |
|
|
| ### General Environment Variables |
|
|
| #### `API_KEY` |
| - **Purpose**: Used for API authentication. |
| - **Requirement**: Mandatory. |
| |
| --- |
| |
| ### S3-Compatible Storage Environment Variables |
| |
| #### `S3_ENDPOINT_URL` |
| - **Purpose**: Endpoint URL for the S3-compatible service. |
| - **Requirement**: Mandatory if using S3-compatible storage. |
| |
| #### `S3_ACCESS_KEY` |
| - **Purpose**: The access key for the S3-compatible storage service. |
| - **Requirement**: Mandatory if using S3-compatible storage. |
| |
| #### `S3_SECRET_KEY` |
| - **Purpose**: The secret key for the S3-compatible storage service. |
| - **Requirement**: Mandatory if using S3-compatible storage. |
| |
| #### `S3_BUCKET_NAME` |
| - **Purpose**: The bucket name for the S3-compatible storage service. |
| - **Requirement**: Mandatory if using S3-compatible storage. |
| |
| #### `S3_REGION` |
| - **Purpose**: The region for the S3-compatible storage service. |
| - **Requirement**: Mandatory if using S3-compatible storage, "None" is acceptible for some s3 providers. |
|
|
| --- |
|
|
| ### Google Cloud Storage (GCP) Environment Variables |
|
|
| #### `GCP_SA_CREDENTIALS` |
| - **Purpose**: The JSON credentials for the GCP Service Account. |
| - **Requirement**: Mandatory if using GCP storage. |
|
|
| #### `GCP_BUCKET_NAME` |
| - **Purpose**: The name of the GCP storage bucket. |
| - **Requirement**: Mandatory if using GCP storage. |
|
|
| --- |
|
|
| ### Performance Tuning Variables |
|
|
| #### `MAX_QUEUE_LENGTH` |
| - **Purpose**: Limits the maximum number of concurrent tasks in the queue. |
| - **Default**: 0 (unlimited) |
| - **Recommendation**: Set to a value based on your server resources, e.g., 10-20 for smaller instances. |
|
|
| #### `GUNICORN_WORKERS` |
| - **Purpose**: Number of worker processes for handling requests. |
| - **Default**: Number of CPU cores + 1 |
| - **Recommendation**: 2-4× number of CPU cores for CPU-bound workloads. |
| |
| #### `GUNICORN_TIMEOUT` |
| - **Purpose**: Timeout (in seconds) for worker processes. |
| - **Default**: 30 |
| - **Recommendation**: Increase for processing large media files (e.g., 300-600). |
|
|
| --- |
|
|
| ### Storage Configuration |
|
|
| #### `LOCAL_STORAGE_PATH` |
| - **Purpose**: Directory for temporary file storage during processing. |
| - **Default**: /tmp |
| - **Recommendation**: Set to a path with sufficient disk space for your expected workloads. |
|
|
| ### Notes |
| - Ensure all required environment variables are set based on the storage provider in use (GCP or S3-compatible). |
| - Missing any required variables will result in errors during runtime. |
| - Performance variables can be tuned based on your workload and available resources. |
|
|
| ### Run the Docker Container: |
|
|
| ```bash |
| docker run -d -p 8080:8080 \ |
| # Authentication (required) |
| -e API_KEY=your_api_key \ |
| |
| # Cloud storage provider (choose one) |
| |
| # s3 |
| # |
| #-e S3_ENDPOINT_URL=https://nyc3.digitaloceanspaces.com \ |
| #-e S3_ACCESS_KEY=your_access_key \ |
| #-e S3_SECRET_KEY=your_secret_key \ |
| #-e S3_BUCKET_NAME=your_bucket_name \ |
| #-e S3_REGION=nyc3 \ |
| |
| # Or |
| |
| # GCP Storage |
| # |
| #-e GCP_SA_CREDENTIALS='{"your":"service_account_json"}' \ |
| #-e GCP_BUCKET_NAME=your_gcs_bucket_name \ |
| |
| # Local storage configuration (optional) |
| -e LOCAL_STORAGE_PATH=/tmp \ |
| |
| # Performance tuning (optional) |
| -e MAX_QUEUE_LENGTH=10 \ |
| -e GUNICORN_WORKERS=4 \ |
| -e GUNICORN_TIMEOUT=300 \ |
| |
| no-code-architects-toolkit |
| ``` |
|
|
| --- |
|
|
| ## Installation Guides |
|
|
| This API can be deployed to various cloud platforms: |
|
|
| ### Digital Ocean |
|
|
| The Digital Ocean App platform is pretty easy to set up and get going, but it can cost more then other cloud providers. |
|
|
| #### Important: Long running processes |
|
|
| You need to use the "webhook_url" (for any request that exceeds 1 min) in your API payload to avoid timeouts due to CloudFlair proxy timeout. |
| |
| If you use the webhook_url, there is no limit to the processing length. |
|
|
| - [Digital Ocean App Platform Installation Guide](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/cloud-installation/do.md) - Deploy the API on Digital Ocean App Platform |
|
|
| ### Google Cloud RUN Platform |
|
|
| Sometimes difficult for people to install (especially on Google Business Workspaces), lots of detailed security exceptions. |
|
|
| However this is one of the cheapest options with great performance because you're only charged when the NCA Toolkit is processesing a request. |
|
|
| Outside of that you are not charged. |
|
|
| #### Imporatnt: Requests exceeding 5+ minutes can be problemactic |
|
|
| GCP Run will terminate long rununing processes, which can happen when processing larger files (whether you use the webhook_url or not). |
| |
| However, when your processing times are consistant lower than 5 minutes (e.g. you're only process smaller files), it works great! The performance is also great and as soon as you stop making requests you stop paying. |
| |
| They also have a GPU option that might be usable for better performance (untested). |
| |
| - [Google Cloud RUN Platform (GCP) Installation Guide](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/cloud-installation/gcp.md) - Deploy the API on Google Cloud Run |
| |
| ### General Docker Instructions |
| |
| You can use these instructions to deploy the NCA Toolkit to any linux server (on any platform) |
| |
| You can more easily control performance and cost this way, but requires more technical skill to get up and running (not much though). |
| |
| - [General Docker Compose Installation Guide](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docker-compose.md) |
| |
| ### Local Development with MinIO and n8n |
| |
| For local development with integrated S3-compatible storage and workflow automation: |
| |
| - [Local Development with MinIO and n8n Guide](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docker-compose.local.minio.n8n.md) - Complete local development environment with MinIO storage and n8n workflow automation |
| |
| ## Testing the API |
| |
| 1. Install the **[Postman Template](https://bit.ly/49Gkh61)** on your computer |
| 2. Import the API example requests from the template |
| 3. Configure your environment variables in Postman: |
| - `base_url`: Your deployed API URL |
| - `x-api-key`: Your API key configured during installation |
| 4. Use the example requests to validate that the API is functioning correctly |
| 5. Use the **[NCA Toolkit API GPT](https://bit.ly/4feDDk4)** to explore additional features |
|
|
| --- |
|
|
| ## Contributing To the NCA Toolkit API |
|
|
| We welcome contributions from the public! If you'd like to contribute to this project, please follow these steps: |
|
|
| 1. Fork the repository |
| 2. Create a new branch for your feature or bug fix |
| 3. Make your changes |
| 4. Submit a pull request to the "build" branch |
|
|
| ### Pull Request Process |
|
|
| 1. Ensure any install or build dependencies are removed before the end of the layer when doing a build. |
| 2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters. |
|
|
| ### Adding New Routes |
|
|
| If you want to add new API endpoints, check out our [Adding Routes Guide](docs/adding_routes.md) to learn how to use the dynamic route registration system. |
|
|
| Thank you for your contributions! |
|
|
| --- |
|
|
| ## How To Get Support |
|
|
| Get courses, community, support daily calls and more. |
|
|
| Join the **[No-Code Architects Community](https://www.skool.com/no-code-architects)** today! |
|
|
| ## License |
|
|
| This project is licensed under the [GNU General Public License v2.0 (GPL-2.0)](LICENSE). |
|
|
| --- |
|
|
| Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference |
|
|
