🔌API Showcase

To make FX AI more visually appealing, an interactive API visualization will be available, showcasing the potential of AI-generated sound effects.

Users will be able to preview sound transformations and interact with different settings. More details will be revealed soon!

OpenAPI block

GitBook's OpenAPI block is powered by Scalar, so you can test your APIs directly from your docs.

FX AI API Endpoints

1️⃣ Generate a Sound Effect

Creates a new AI-generated sound effect based on a text prompt.

Method	Endpoint	Description
POST	/api/v1/generate-sound	Generates a sound effect from a text prompt.

Request Example (JSON)

jsonCopiaModifica{
  "prompt": "Thunderstorm on Mars with metallic echoes",
  "duration": 10,
  "format": "mp3"
}

Response Example (JSON)

jsonCopiaModifica{
  "id": "123456",
  "status": "processing",
  "download_url": "https://fxai.io/sounds/123456.mp3"
}

---

2️⃣ Retrieve Sound Status

Checks the status of a generated sound effect.

Method	Endpoint	Description
GET	/api/v1/sound/{sound_id}	Fetches the status and download link for a generated sound.

Response Example (JSON)

jsonCopiaModifica{
  "id": "123456",
  "status": "completed",
  "download_url": "https://fxai.io/sounds/123456.mp3"
}

---

3️⃣ List Available Sound Categories

Returns a list of categories for sound generation.

Method	Endpoint	Description
GET	/api/v1/categories	Fetches a list of available sound effect categories.

Response Example (JSON)

jsonCopiaModifica{
  "categories": [
    "Nature",
    "Sci-Fi",
    "Cinematic",
    "Horror",
    "Fantasy"
  ]
}

---

4️⃣ Generate Sound from Video (Upcoming Feature 🚀)

Generates sound effects automatically from an uploaded video.

Method	Endpoint	Description
POST	/api/v1/generate-sound-from-video	Extracts sound effects from a video input.

Request Example (JSON)

jsonCopiaModifica{
  "video_url": "https://example.com/video.mp4",
  "sound_format": "wav"
}

Response Example (JSON)

jsonCopiaModifica{
  "id": "78910",
  "status": "processing",
  "download_url": "https://fxai.io/sounds/78910.wav"
}

---