POST VC Inference

Create new VC Inference Job

POST /v1/inferences-vc

Creates a voice conversions inference job and adds it to the inference queue. All requests must be made as multipart form requests. The response will contain the job status.

Headers

Name	Value
Content-Type	multipart/form-data
x-api-key	<token>

Query Parameters

Name	Type	Description	Default Values
modelId	string	Name of the user
indexRate	number	Influence exerted by the index model	default=0.76 min=0 max=1
rmsMixRate	number	Fusion ratio for replacing the input volume envelope with the output volume envelope	default=1 min=0 max=1
filterRadius	integer	median filter in the result of the pitch recognition of the crop	default=3 min=0 max=7

Body Parameters

Name	Type	Description
audioInfer	binary	Support wav, mp3 or flac. Max file size is 50MB.

The parameters "audioInfer" and "modelId" are mandatory for the correct functioning of the application.

Response

200: OK

{
    "inferenceId": "123x456",
    "modelId": "123x456",
    "status": "RUNNING",
    "type": "VC",
    "inferenceUrl": null,
    "jobStartTime": "2024-01-01 20:15:50.428000 +00:00",
    "jobEndTime": null
}

402: Invalid File

{"message": "Invalid file type, use: ['audio/x-wav', 'audio/mpeg', 'audio/flac']"}

403: Forbidden

{"message": "Forbidden"}

413: Payload Too Large

{"message": "Payload Too Large"}

422: Bad Request

{
  "detail": [
    {
      "loc": [
        "query",
        ""
      ],
      "msg": "field required",
      "type": "value_error.missing"
    },
    {
      "loc": [
        "body",
        ""
      ],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}

429: Rate Limit

{"error": "Rate limit exceeded."}