Skip to main content

Music Cover Generation Callbacks

When music cover generation is complete, the system will call this callback to notify results.
When you submit a cover generation task to the Suno API, you can use the callBackUrl parameter to set the callback URL. When the task is complete, the system will automatically push results to your specified address.

Callback Mechanism Overview

The callback mechanism eliminates the need to poll the API for task status. The system will actively push task completion results to your server.

Callback Timing

The system will send callback notifications in the following situations:
  • Cover generation task completed successfully
  • Cover generation task failed
  • Error occurred during task processing

Callback Method

  • HTTP Method: POST
  • Content Type: application/json
  • Timeout Setting: 15 seconds

Callback Request Format

When the task is complete, the system will send a POST request to your callBackUrl:

Status Code Description

code
integer
required
Callback status code indicating task processing result:
msg
string
required
Status message providing more detailed status description
data.taskId
string
required
Task ID, consistent with the taskId returned when you submitted the task
data.images
array
Array of generated cover image URLs, returned on success. Usually contains 2 different style cover images

Callback Reception Examples

Here are example codes for receiving callbacks in common programming languages:

Best Practices

Callback URL Configuration Recommendations

  1. Use HTTPS: Ensure callback URL uses HTTPS protocol for data transmission security
  2. Verify Source: Verify the legitimacy of request sources in callback processing
  3. Idempotent Processing: The same taskId may receive multiple callbacks, ensure processing logic is idempotent
  4. Quick Response: Callback processing should return 200 status code quickly to avoid timeout
  5. Asynchronous Processing: Complex business logic should be processed asynchronously to avoid blocking callback response
  6. Image Management: Download and save images promptly, noting URL validity period
  7. Error Retry: Implement retry mechanism for failed image downloads

Important Reminders

  • Callback URL must be a publicly accessible address
  • Server must respond within 15 seconds, otherwise it will be considered timeout
  • If 3 consecutive retries fail, the system will stop sending callbacks
  • Please ensure stability of callback processing logic to avoid callback failures due to exceptions
  • Cover image URLs may have validity periods, recommend downloading and saving promptly
  • Usually generates 2 different style cover images for selection
  • Note handling exceptions for failed image downloads

Troubleshooting

If you don’t receive callback notifications, please check the following:
  • Confirm callback URL is accessible from the public internet
  • Check firewall settings to ensure inbound requests are not blocked
  • Verify domain name resolution is correct
  • Ensure server returns HTTP 200 status code within 15 seconds
  • Check server logs for error messages
  • Verify interface path and HTTP method are correct
  • Confirm received POST request body is in JSON format
  • Check if Content-Type is application/json
  • Verify JSON parsing is correct
  • Confirm image URLs are accessible
  • Check image download permissions and network connection
  • Verify file save path and permissions
  • Note image URL validity period limitations

Alternative Solutions

If you cannot use the callback mechanism, you can also use polling:

Poll Query Results

Use the Get Cover Details endpoint to periodically query task status. We recommend querying every 30 seconds.

To find navigation and other pages in this documentation, fetch the llms.txt file at: https://docs.apikley.ru/llms.txt
Rate limits and quotas are enforced by Apikley and may differ from upstream providers.