AUaudioshake
tasks

Get Task by ID

Changed on
get/tasks/{id}

Request

  • Base URL
    https://api.audioshake.ai
  • URL
    https://api.audioshake.ai/tasks/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Unique identifier of the Task

Response

Default Response

idstring

Unique identifier of the Task

createdAtstring date-time

Timestamp of when the Task was created

completedAtstring date-time nullable

Timestamp of when the Task was completed

clientIdstring

Unique identifier of the client

costnumber

Processing cost in credits

assetIdstring

Asset ID of an input media file. Mutually exclusive with url

urlstring nullable

URL of an input media file (HTTPS, s3://, or gs://). Mutually exclusive with assetId

storageIntegrationIdstring nullable

ID of the storage integration used to read the S3 or GCS input and write outputs. Only present when a storage integration was provided.

writeDestinationstring nullable

S3 or GCS URI prefix outputs were written under. The source 'url' must also have a matching URI scheme (s3:// or gs://). Outputs are written under <writeDestination>/<taskId>/*. Use output[].link for exact object locations. Only present when a custom write destination was provided.

metadatastring

Client-provided metadata. Stored and returned as-is in responses and webhooks.

Changes