Class: ElevenlabsClient::Admin::Samples

Inherits:
Object
  • Object
show all
Defined in:
lib/elevenlabs_client/endpoints/admin/samples.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Samples

Returns a new instance of Samples.



6
7
8
 
# File 'lib/elevenlabs_client/endpoints/admin/samples.rb', line 6

def initialize(client)
  @client = client
end

Instance Method Details

#delete_sample(voice_id:, sample_id:) ⇒ Hash Also known as: delete_voice_sample, remove_sample

DELETE /v1/voices/:voice_id/samples/:sample_id Delete voice sample Documentation: https://elevenlabs.io/docs/api-reference/samples/delete-voice-sample

Parameters:

  • voice_id (String) —

    ID of the voice to be used. You can use the Get voices endpoint to list all the available voices.

  • sample_id (String) —

    ID of the sample to be used. You can use the Get voices endpoint to list all the available samples for a voice.

Returns:

  • (Hash) —

    The JSON response containing the status of the deletion request.



17
18
19
20
 
# File 'lib/elevenlabs_client/endpoints/admin/samples.rb', line 17

def delete_sample(voice_id:, sample_id:)
  endpoint = "/v1/voices/#{voice_id}/samples/#{sample_id}"
  @client.delete(endpoint)
end