Skip to content

Commit e12bff9

Browse files
Stephen G. PopeStephen G. Pope
authored andcommitted
fix to readme.md
1 parent 3a301b9 commit e12bff9

1 file changed

Lines changed: 61 additions & 40 deletions

File tree

README.md

Lines changed: 61 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -33,68 +33,89 @@ Join the **[No-Code Architects Community](https://www.skool.com/no-code-architec
3333

3434
---
3535

36-
## Features of the No-Code Architects Toolkit API
36+
## API Endpoints
3737

38-
Each feature is supported by robust payload validation and detailed API documentation to facilitate easy integration and usage.
38+
Each endpoint is supported by robust payload validation and detailed API documentation to facilitate easy integration and usage.
3939

40-
### Advanced Media Manipulation
40+
### Audio
4141

42-
#### 1. `/v1/ffmpeg/compose`
43-
- **Description**: Provides a flexible way to compose and manipulate media files using FFmpeg. Supports complex media operations like transcoding, concatenation, and filtering.
44-
- **Documentation Link**: [FFmpeg Compose Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/ffmpeg/ffmpeg_compose.md)
42+
- **`/v1/audio/concatenate`**
43+
- Combines multiple audio files into a single audio file.
44+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/audio/concatenate.md)
4545

46-
---
46+
### Code
4747

48-
### Video Processing
48+
- **`/v1/code/execute/python`**
49+
- Executes Python code remotely and returns the execution results.
50+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/code/execute/execute_python.md)
4951

50-
#### 2. `/v1/video/caption`
51-
- **Description**: Adds captions to a video file, including options for font, position, and styling. It also supports automated language detection and custom replacements in captions.
52-
- **Documentation Link**: [Video Caption Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/video/caption_video.md)
52+
### FFmpeg
5353

54-
#### 3. `/v1/video/concatenate`
55-
- **Description**: Combines multiple video files into a single video file. The input files are concatenated in the specified order, and the final video is uploaded to cloud storage.
56-
- **Documentation Link**: [Video Concatenate Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/video/concatenate.md)
54+
- **`/v1/ffmpeg/compose`**
55+
- Provides a flexible interface to FFmpeg for complex media processing operations.
56+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/ffmpeg/ffmpeg_compose.md)
5757

58-
---
58+
### Image
5959

60-
### Code Execution
60+
- **`/v1/image/convert/video`**
61+
- Transforms a static image into a video with custom duration and zoom effects.
62+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/image/convert/image_to_video.md)
6163

62-
#### 4. `/v1/code/execute/python`
63-
- **Description**: Executes Python code on the server in a controlled environment. Useful for scripting, prototyping, or dynamically running Python scripts with secure execution.
64-
- **Documentation Link**: [Execute Python Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/code/execute/execute_python.md)
64+
### Media
6565

66-
---
66+
- **`/v1/media/convert`**
67+
- Converts media files from one format to another with customizable codec options.
68+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media_convert.md)
6769

68-
### Image Processing
70+
- **`/v1/media/convert/media`**
71+
- Advanced media conversion with customizable video and audio codec options.
72+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media/convert/media_convert.md)
6973

70-
#### 5. `/v1/image/convert/video`
71-
- **Description**: Converts an image into a video file with configurable options like duration, frame rate, and zoom effects. Ideal for creating video slideshows or transitions.
72-
- **Documentation Link**: [Image to Video Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/image/convert/image_to_video.md)
74+
- **`/v1/media/convert/mp3`**
75+
- Converts various media formats specifically to MP3 audio.
76+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media/convert/media_to_mp3.md)
7377

74-
---
78+
- **`/v1/media/download`**
79+
- Downloads media content from various online sources using yt-dlp.
80+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media/download.md)
7581

76-
### Media Transformation
82+
- **`/v1/media/feedback`**
83+
- Provides a web interface for collecting and displaying feedback on media content.
84+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media/feedback.md)
7785

78-
#### 6. `/v1/media/convert/mp3`
79-
- **Description**: Converts various media files (audio or video) to MP3 format with configurable bitrate and quality settings.
80-
- **Documentation Link**: [Media to MP3 Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media/convert/media_to_mp3.md)
86+
- **`/v1/media/transcribe`**
87+
- Transcribes or translates audio/video content from a provided media URL.
88+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media/media_transcribe.md)
8189

82-
#### 7. `/v1/media/transcribe`
83-
- **Description**: Transcribes audio files to text using advanced speech-to-text processing. Supports various languages and audio formats.
84-
- **Documentation Link**: [Audio Transcribe Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/media/media_transcribe.md)
90+
### S3
8591

92+
- **`/v1/s3/upload`**
93+
- Uploads files to Amazon S3 storage by streaming directly from a URL.
94+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/s3/upload.md)
8695

87-
---
96+
### Toolkit
97+
98+
- **`/v1/toolkit/authenticate`**
99+
- Provides a simple authentication mechanism to validate API keys.
100+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/toolkit/authenticate.md)
101+
102+
- **`/v1/toolkit/test`**
103+
- Verifies that the NCA Toolkit API is properly installed and functioning.
104+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/toolkit/test.md)
105+
106+
### Video
88107

89-
### Core Features
108+
- **`/v1/video/caption`**
109+
- Adds customizable captions to videos with various styling options.
110+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/video/caption_video.md)
90111

91-
#### 8. `/v1/toolkit/test`
92-
- **Description**: A basic endpoint to verify the availability and functionality of the API. Useful for initial setup and connection tests.
93-
- **Documentation Link**: [Test Endpoint Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/toolkit/test.md)
112+
- **`/v1/video/concatenate`**
113+
- Combines multiple videos into a single continuous video file.
114+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/video/concatenate.md)
94115

95-
#### 9. `/v1/toolkit/authenticate`
96-
- **Description**: Verifies the provided API key and authenticates the user. Returns a success message if the API key is valid.
97-
- **Documentation Link**: [Authenticate Endpoint Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/toolkit/authenticate.md)
116+
- **`/v1/video/thumbnail`**
117+
- Extracts a thumbnail image from a specific timestamp in a video.
118+
- [Documentation](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/video/thumbnail.md)
98119

99120
---
100121

0 commit comments

Comments
 (0)