Common

Check the status of a task by id

This endpoint allows you to check the status of a specific task by its ID.
Checking is only possible within 24h after task creation, otherwise an error will be returned.
The current rate limit for this endpoint is 30 requests per minute. This limit may be increased in the future.
post/api/v1/check/

Request body

task_idsstring[] required

Example request

{
  "task_ids": [
    "2fe8f214-1771-4900-9e7e-570f823bd359",
    "8cad7e3d-a5a3-4e79-9463-59cd4da16977",
    "cb443802-e5be-44c2-bdd8-cb1d343c7d25",
    "f4978ff5-8e0b-4fdc-913a-e350eeb16d31"
  ]
}

Response

OK

resultobject required

Mapping of task IDs to their respective status and details.

Example response

{
  "result": {
    "2fe8f214-1771-4900-9e7e-570f823bd359": {
      "presets": {
        "dereverb_enabled": false,
        "encoder_format": null,
        "enhanced_processing_enabled": false,
        "label": "enhanced",
        "multivocal": null,
        "splitter": "perseus",
        "stem": "vocals",
        "task_type": "split"
      },
      "result": {
        "duration": 16,
        "tracks": [
          {
            "label": "vocals",
            "type": "stem",
            "url": "http://d.lalal.ai/2fe8f214-1771-4900-9e7e-570f823bd359/abcd1234/vocals"
          },
          {
            "label": "no_vocals",
            "type": "back",
            "url": "http://d.lalal.ai/2fe8f214-1771-4900-9e7e-570f823bd359/abcd1234/no_vocals"
          }
        ]
      },
      "source_id": "ecb6c2c5-6263-48b9-80c9-f54248e30892",
      "status": "success"
    },
    "8cad7e3d-a5a3-4e79-9463-59cd4da16977": {
      "error": "['The file has not been uploaded properly or has already been deleted. Please upload it again.']",
      "status": "server_error"
    },
    "cb443802-e5be-44c2-bdd8-cb1d343c7d25": {
      "presets": {
        "dereverb_enabled": false,
        "encoder_format": null,
        "enhanced_processing_enabled": false,
        "label": "enhanced",
        "multivocal": null,
        "splitter": "perseus",
        "stem": "vocals",
        "task_type": "split"
      },
      "progress": 42,
      "source_id": "9dec9880-12ad-4a7e-89af-c50c9380ec14",
      "status": "progress"
    },
    "f4978ff5-8e0b-4fdc-913a-e350eeb16d31": {
      "error": {
        "code": "inference_error",
        "detail": "Unable to detect voice/vocals in the uploaded files",
        "id": "<error_id>"
      },
      "presets": {
        "dereverb_enabled": false,
        "encoder_format": null,
        "enhanced_processing_enabled": false,
        "label": "enhanced",
        "multivocal": null,
        "splitter": "perseus",
        "stem": "vocals",
        "task_type": "split"
      },
      "source_id": "7ab9e030-c472-4281-8b08-108c3bd019bf",
      "status": "error"
    }
  }
}

Changes

Changed in 1 of the 2 revisions of this API.4

    • added the new guitar enum value to the result/additionalProperties/oneOf[subschema #1: CheckV1ProgressResult]/presets/oneOf[subschema #2]/oneOf[subschema #3: StemSeparatorSplitterPresetsV1]/stem response property for the response status 200

      response-property-enum-value-added

    • added the new guitar enum value to the result/additionalProperties/oneOf[subschema #2: CheckV1ErrorResult]/presets/oneOf[subschema #2]/oneOf[subschema #3: StemSeparatorSplitterPresetsV1]/stem response property for the response status 200

      response-property-enum-value-added

    • added the new guitar enum value to the result/additionalProperties/oneOf[subschema #3: CheckV1CancelledResult]/presets/oneOf[subschema #2]/oneOf[subschema #3: StemSeparatorSplitterPresetsV1]/stem response property for the response status 200

      response-property-enum-value-added

    • added the new guitar enum value to the result/additionalProperties/oneOf[subschema #4: CheckV1SuccessResult]/presets/oneOf[subschema #2]/oneOf[subschema #3: StemSeparatorSplitterPresetsV1]/stem response property for the response status 200

      response-property-enum-value-added