Parcourir la documentation
Premiers pas
Validez une requête, exécutez-la depuis un script et consultez séparément le résultat et les reçus d’exécution ou d’erreur.
Sur cette page
1. Sélectionner le profil existant
Utilisez la CLI installée, Bash et jq. Sous Windows, exécutez les exemples shell dans Git Bash. Ce guide utilise un profil authentifié nommé research ; définissez FLASHDATA_STATE_DIR avec le chemin absolu du répertoire qui contient ce profil.
Utilisez le même utilisateur du système et le même répertoire d’état pour chaque commande. FLASHDATA_API_KEY est prioritaire sur la clé enregistrée ; laissez cette variable non définie pour utiliser le profil. La CLI ne charge pas les fichiers .env.
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
flashdata auth status --profile research --state-dir "$FLASHDATA_STATE_DIR" --jsonRépertoires d’état par défaut
Conservez votre --state-dir d’origine si vous avez choisi un emplacement personnalisé. auth status doit indiquer data.accessVerified: true. Pour un déploiement sans intervention, importez la clé propriétaire depuis son stockage de secrets via stdin.
| Système | Répertoire |
|---|---|
| Windows | %APPDATA%/FlashData |
| macOS | ~/Library/Application Support/FlashData |
| Linux | $XDG_STATE_HOME/flashdata ou ~/.local/state/flashdata |
2. Valider la requête et son prix
Enregistrez request.json, puis lancez les vérifications gratuites dans le même répertoire. Le filtre affiche true uniquement si le prix de la source est disponible et si le solde couvre une requête. Arrêtez si le code de sortie est non nul. Vérifier le prix ne réserve pas de crédits.
{
"source": "google_search",
"query": "battery recycling research",
"params": {
"num": 5
}
}set -euo pipefail
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
flashdata account balance --profile research --state-dir "$FLASHDATA_STATE_DIR" \
--json --non-interactive > balance.json
flashdata query --input request.json --dry-run --run-id cli-research-001 \
--profile research --state-dir "$FLASHDATA_STATE_DIR" \
--json --non-interactive > preflight.json
jq -e --slurpfile balance balance.json '
.ok and .data.dryRun and .data.estimateAvailable
and ($balance[0].ok == true)
and any(.data.estimate.prices[]?;
.source == "google_search" and .available == true
and (.estimatedCredits | type == "number")
and ($balance[0].data.availableCredits | type == "number")
and .estimatedCredits <= $balance[0].data.availableCredits)
' preflight.json3. Exécuter et lire le reçu
Après la réussite des vérifications, enregistrez run-search.sh et exécutez bash run-search.sh. La première exécution réussie soumet une recherche. Chaque tentative enregistre ses fichiers dans un nouveau répertoire cli-run ; l’identifiant d’exécution stable permet à la CLI de réutiliser un résultat réussi pour le même compte, le même profil et le même répertoire d’état.
#!/usr/bin/env bash
set -euo pipefail
umask 077
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
dir=$(mktemp -d "cli-run.XXXXXX")
if ! flashdata query --input request.json --run-id cli-research-001 \
--profile research --state-dir "$FLASHDATA_STATE_DIR" \
--output "$dir/result.json" --timeout 2m --json --non-interactive \
> "$dir/receipt.json" 2> "$dir/error.json"; then
cat "$dir/error.json" >&2
printf 'Inspect saved run cli-research-001; receipts: %s\n' "$dir" >&2
exit 1
fi
jq -e '.schemaVersion == 1 and .ok == true' "$dir/receipt.json" >/dev/null
jq -e '.status == "done" and .source == "google_search"' "$dir/result.json" >/dev/null
jq -r '.results[]?.organic[]? | [.title, .link] | @tsv' "$dir/result.json"
jq '{runId, cached, usage}' "$dir/receipt.json"
printf 'Files: %s\n' "$dir"Savoir quel fichier lire
L’enveloppe CLI et la réponse de la source sont deux documents JSON distincts. Sans --output, la réponse de la source se trouve dans data. Cet exemple utilise --output : lisez donc les champs de la source dans le fichier result.json enregistré.
| Fichier | Contenu à lire |
|---|---|
| receipt.json | ok, runId, cached, usage et le chemin de sortie. Un reçu mis en cache indique la consommation d’origine, pas une nouvelle facturation. |
| result.json | source, status, results et usage. Pour Google Search, lisez results[].organic[]. Un tableau vide peut être un résultat de recherche valide. |
| error.json | Si le code de sortie est non nul, examinez error.code, error.httpStatus, error.retryAfter et les éventuels identifiants d’exécution ou de tâche. |
{
"schemaVersion": 1,
"ok": true,
"runId": "cli-research-001",
"cached": false,
"data": {
"output": "cli-run.EXAMPLE/result.json"
},
"usage": {
"credits": 0.02
}
}Récupérer le résultat sans nouvelle recherche
Examinez l’exécution enregistrée avant de réessayer. Avec l’accès au compte d’origine, exportez un résultat réussi vers un fichier qui n’existe pas encore. Le rattachement remplace le compte d’essai par le compte propriétaire ; conservez les résultats d’essai déjà exportés et utilisez de nouveaux identifiants pour les nouvelles tâches du propriétaire. Une requête modifiée sous le même identifiant d’exécution est rejetée ; utilisez un nouvel identifiant uniquement pour lancer volontairement une nouvelle tâche.
flashdata runs show cli-research-001 --profile research \
--state-dir "$FLASHDATA_STATE_DIR" --json
flashdata runs show cli-research-001 --result --output recovered.json \
--profile research --state-dir "$FLASHDATA_STATE_DIR" --jsonAjouter la planification une fois le script validé
Utilisez --recurring avec un accès propriétaire installé, un identifiant stable par occurrence planifiée et un état persistant. Un essai ne permet pas les tâches récurrentes. Votre hôte gère la planification ; l’option vérifie uniquement l’accès. Utilisez le script complet de tâches récurrentes pour gérer les dates planifiées et les redémarrages.
Option : stockage privé des téléchargements
Pour youtube download --storage-config storage.json, enregistrez uniquement cet objet de stockage dans storage.json et remplacez les valeurs d’exemple localement. Le fichier doit être privé et appartenir à l’utilisateur qui exécute la commande. Appliquez la commande de permissions adaptée avant de lancer un téléchargement.
{
"storage_type": "s3",
"storage_url": "YOUR_BUCKET",
"access_key": "YOUR_ACCESS_KEY",
"secret_key": "YOUR_SECRET_KEY",
"region": "us-east-1"
}chmod 600 storage.json$storagePath = (Resolve-Path -LiteralPath './storage.json').Path
$storageUser = [System.Security.Principal.WindowsIdentity]::GetCurrent().User
$storageAcl = [System.Security.AccessControl.FileSecurity]::new()
$storageAcl.SetOwner($storageUser)
$storageAcl.SetAccessRuleProtection($true, $false)
$storageAcl.AddAccessRule([System.Security.AccessControl.FileSystemAccessRule]::new($storageUser, 'FullControl', 'Allow'))
Set-Acl -LiteralPath $storagePath -AclObject $storageAcl