Fairphonic Partner API
test
6 subscribers
13 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Fairphonic Partner API endpoints
| Method | Endpoint | Description |
|---|---|---|
| backend-api Partner > run | ||
| POST |
queue /backend-api/run/queue |
|
| GET |
readRuns /backend-api/run/ |
**GET /backend-api/run/?gid=** **Description:** Retrieves a list of all runs performed by the user associated with the provided `gid`. **Query Params:** - **gid** (string,… |
| backend-api Partner > run > ongoing | ||
| GET |
readOngoingRuns /backend-api/run/ongoing |
**GET //backend-api/run/ongoing?gid=** **Description:** Retrieves information about all ongoing runs within the system, specifically those associated with the provided grouping… |
| backend-api Partner > run > progress | ||
| GET |
readRun /backend-api/run/progress |
**GET /backend-api/run/ongoing** **Description:** Retrieves information about all ongoing runs within the system. **Response:** **Status:** - 200 OK: Successful response… |
| backend-api Partner > run > results | ||
| GET |
runFinished /backend-api/run/results |
**GET /backend-api/run/results?gid=&run_gid=** **Description:** Retrieves the results of a specific completed run. **Query Params:** - **gid** (string, required): The unique ID… |
| backend-api Partner > tracks | ||
| DELETE |
deleteTrack /backend-api/tracks/ |
**Endpoint:** `//backend-api/tracks/` **Method:** `DELETE` **Purpose:** Deletes a track from the user's library. **Query Params:** - **gid** (Required, string): The unique… |
| backend-api Partner > tracks > edit | ||
| PUT |
editTrack /backend-api/tracks/edit |
Edit track details and metadata. Request Body: - **track_gid** (string): The unique ID of the track being edited. (string): The new name of the track. - **metadata** (object): -… |
| backend-api Partner > tracks > me | ||
| POST |
readUserTrackLibrary /backend-api/tracks/me |
**Endpoint:** `/backend-api/tracks/me` **HTTP Method:** `POST` **Summary:** Read User Track Library **Description:** This endpoint allows users to retrieve the list of tracks in… |
| backend-api Partner > tracks > online-usage | ||
| POST |
getOnlineUsage /backend-api/tracks/online-usage |
Get all of the track's performance results after a processing or multiple processings. **Endpoint:** `/backend-api/tracks/online-usage` **HTTP Method:** `POST` **Summary:** Get… |
| backend-api Partner > tracks > create_track | ||
| POST |
createTrack /backend-api/tracks/create_track |
Create a new track in the user's library. |
| backend-api Partner > tracks > reupload | ||
| PUT |
reuploadTrack /backend-api/tracks/reupload |
This API endpoint allows authorized users to create a new track in their music library. It accepts a JSON object in the request body containing details about the track, its… |
| backend-api Partner > health > readiness | ||
| GET |
readiness /backend-api/health/readiness |
Readiness check. Currently only check db and redis connection |
| backend-api Partner > health > liveness | ||
| GET |
liveness /backend-api/health/liveness |
Liveness check |
Fairphonic Partner API pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
