Informations sur les crédits
curl --request GET \
--url https://app.voicehire.io/api/v1/account/credits \
--header 'X-API-Key: <api-key>'import requests
url = "https://app.voicehire.io/api/v1/account/credits"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://app.voicehire.io/api/v1/account/credits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.voicehire.io/api/v1/account/credits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.voicehire.io/api/v1/account/credits"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.voicehire.io/api/v1/account/credits")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.voicehire.io/api/v1/account/credits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"credits_available": 245.5,
"credits_used_this_month": 154,
"subscription_type": "VoiceHire Resonance",
"reset_date": "2024-02-01"
}
Compte
Obtenir les informations de crédits
Récupère le solde de crédits et les informations d’abonnement de votre compte
GET
/
api
/
v1
/
account
/
credits
Informations sur les crédits
curl --request GET \
--url https://app.voicehire.io/api/v1/account/credits \
--header 'X-API-Key: <api-key>'import requests
url = "https://app.voicehire.io/api/v1/account/credits"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://app.voicehire.io/api/v1/account/credits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.voicehire.io/api/v1/account/credits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.voicehire.io/api/v1/account/credits"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.voicehire.io/api/v1/account/credits")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.voicehire.io/api/v1/account/credits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"credits_available": 245.5,
"credits_used_this_month": 154,
"subscription_type": "VoiceHire Resonance",
"reset_date": "2024-02-01"
}
Réponse
{
"credits_available": 245.5,
"credits_used_this_month": 154,
"subscription_type": "VoiceHire Resonance",
"reset_date": "2024-02-01"
}
number
required
Nombre de crédits disponibles sur le compte
integer
required
Nombre de crédits utilisés pendant la période en cours
string
required
Type d’abonnement actuelTypes possibles:
VoiceHire Echo- Plan EchoVoiceHire Resonance- Plan ResonanceVoiceHire Symphony- Plan SymphonyPay as you go- Paiement à l’usage
string
required
Date de réinitialisation des crédits mensuels (format YYYY-MM-DD)
Exemple de requête
curl -X GET https://app.voicehire.io/api/v1/account/credits \
-H "X-API-Key: vh_live_XXXXXXXXXXXXX"
import requests
response = requests.get(
"https://app.voicehire.io/api/v1/account/credits",
headers={
"X-API-Key": "vh_live_XXXXXXXXXXXXX"
}
)
if response.status_code == 200:
data = response.json()
print(f"Crédits disponibles: {data['credits_available']}")
print(f"Abonnement: {data['subscription_type']}")
const axios = require('axios');
const response = await axios.get(
'https://app.voicehire.io/api/v1/account/credits',
{
headers: {
'X-API-Key': 'vh_live_XXXXXXXXXXXXX'
}
}
);
console.log(`Crédits disponibles: ${response.data.credits_available}`);
console.log(`Abonnement: ${response.data.subscription_type}`);
Notes importantes
- Les crédits sont consommés pour chaque candidat ajouté ou SMS envoyé
- Les crédits mensuels sont réinitialisés à la date indiquée
- Les crédits non utilisés ne sont pas reportés au mois suivant
- Pour les plans Pay-as-you-go, la date de réinitialisation n’est pas applicable
Codes d’erreur
| Code | Description |
|---|---|
| 401 | Clé API manquante ou invalide |
Authorizations
Clé API au format vh_live_XXXXX
Response
200 - application/json
Informations sur les crédits
Crédits disponibles
Example:
100
Crédits utilisés ce mois
Example:
45
Date de réinitialisation mensuelle
Example:
"2025-08-01"
Type d'abonnement
Available options:
Pay as you go, VoiceHire Echo, VoiceHire Resonance, VoiceHire Symphony Example:
"VoiceHire Echo"

