212 lines
2.3 KiB
Markdown
212 lines
2.3 KiB
Markdown
# API Reference
|
|
|
|
## Authentication
|
|
|
|
All endpoints (except `/auth/*` and `/api/ping/`) require a Bearer token in the Authorization header.
|
|
|
|
### Register
|
|
```
|
|
POST /auth/register
|
|
```
|
|
|
|
### Login
|
|
```
|
|
POST /auth/login
|
|
```
|
|
|
|
### Refresh Token
|
|
```
|
|
POST /auth/refresh
|
|
```
|
|
|
|
## Users
|
|
|
|
### List Users
|
|
```
|
|
GET /api/users/
|
|
```
|
|
|
|
### Get Current User
|
|
```
|
|
GET /api/users/me/
|
|
```
|
|
|
|
### Get User by ID
|
|
```
|
|
GET /api/users/{user_id}/
|
|
```
|
|
|
|
### Create User
|
|
```
|
|
POST /api/users/
|
|
```
|
|
|
|
### Update User
|
|
```
|
|
PATCH /api/users/{user_id}/
|
|
```
|
|
|
|
### Delete User
|
|
```
|
|
DELETE /api/users/{user_id}/
|
|
```
|
|
|
|
## Projects
|
|
|
|
### List Projects
|
|
```
|
|
GET /api/projects/
|
|
```
|
|
|
|
### Create Project
|
|
```
|
|
POST /api/projects/
|
|
```
|
|
|
|
### Get Project
|
|
```
|
|
GET /api/projects/{project_id}/
|
|
```
|
|
|
|
### Update Project
|
|
```
|
|
PATCH /api/projects/{project_id}/
|
|
```
|
|
|
|
### Delete Project
|
|
```
|
|
DELETE /api/projects/{project_id}/
|
|
```
|
|
|
|
## Files
|
|
|
|
### Upload File
|
|
```
|
|
POST /api/files/upload/
|
|
```
|
|
|
|
### Get File Info
|
|
```
|
|
GET /api/files/get_file/?file_path={path}
|
|
```
|
|
|
|
### Local File Access
|
|
```
|
|
GET /api/files/local/{file_path}
|
|
```
|
|
|
|
### List File Entries
|
|
```
|
|
GET /api/files/files/
|
|
```
|
|
|
|
### Create File Entry
|
|
```
|
|
POST /api/files/files/
|
|
```
|
|
|
|
### Get File Entry
|
|
```
|
|
GET /api/files/files/{file_id}/
|
|
```
|
|
|
|
### Update File Entry
|
|
```
|
|
PATCH /api/files/files/{file_id}/
|
|
```
|
|
|
|
### Delete File Entry
|
|
```
|
|
DELETE /api/files/files/{file_id}/
|
|
```
|
|
|
|
## Media
|
|
|
|
### Get Media Metadata
|
|
```
|
|
GET /api/media/get_meta/?file_path={path}
|
|
```
|
|
|
|
### Remove Silence
|
|
```
|
|
POST /api/media/silence_remove
|
|
```
|
|
|
|
### Convert to MP4
|
|
```
|
|
POST /api/media/convert
|
|
```
|
|
|
|
## Transcription
|
|
|
|
### Whisper Transcribe
|
|
```
|
|
POST /api/transcribe/whisper/
|
|
```
|
|
|
|
### Google Speech Transcribe
|
|
```
|
|
POST /api/transcribe/google-speech/
|
|
```
|
|
|
|
## Captions
|
|
|
|
### Get Video with Captions
|
|
```
|
|
POST /api/captions/get_video/
|
|
```
|
|
|
|
## Jobs
|
|
|
|
### List Jobs
|
|
```
|
|
GET /api/jobs/jobs/
|
|
```
|
|
|
|
### Create Job
|
|
```
|
|
POST /api/jobs/jobs/
|
|
```
|
|
|
|
### Get Job
|
|
```
|
|
GET /api/jobs/jobs/{job_id}/
|
|
```
|
|
|
|
### Update Job
|
|
```
|
|
PATCH /api/jobs/jobs/{job_id}/
|
|
```
|
|
|
|
### Delete Job
|
|
```
|
|
DELETE /api/jobs/jobs/{job_id}/
|
|
```
|
|
|
|
## Webhooks
|
|
|
|
### List Webhooks
|
|
```
|
|
GET /api/webhooks/
|
|
```
|
|
|
|
### Create Webhook
|
|
```
|
|
POST /api/webhooks/
|
|
```
|
|
|
|
### Get Webhook
|
|
```
|
|
GET /api/webhooks/{webhook_id}/
|
|
```
|
|
|
|
### Update Webhook
|
|
```
|
|
PATCH /api/webhooks/{webhook_id}/
|
|
```
|
|
|
|
### Delete Webhook
|
|
```
|
|
DELETE /api/webhooks/{webhook_id}/
|
|
```
|