# TypeScript & JavaScript SDK

Instale o SDK e execute uma busca no Node.js. Escolha TypeScript ou JavaScript; mantenha API no servidor.

Referência canônica: https://flashdata.dev/pt/docs/guides/flashdata-typescript
2026-11-04 por FlashData

- [GitHub](https://github.com/flashdatadev/flashdata-typescript) — Fonte e referência SDK
- [Obtenha uma chave de API](https://flashdata.dev/app/api-keys) — Crie uma chave no console

<a id="application"></a>

## Faça seu primeiro pedido Node.js

Instale o pacote, defina sua chave API e escolha TypeScript ou JavaScript abaixo. Execute este código em seu servidor ou em um script local.

- [Referência do método SDK](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/api-reference.md)
- [npm](https://www.npmjs.com/package/@flashdata-dev/sdk/v/1.1.0)

<a id="install"></a>

### Instale o SDK

Estes exemplos usam Node.js 22.18+ para executar TypeScript diretamente. Comece em uma pasta vazia, ou selecione o projeto existente se você tiver package.json.

#### Novo projeto

##### Instalar

```bash
npm init -y
npm install --save-exact @flashdata-dev/sdk@1.1.0
```


#### Projeto existente

##### Instalar

```bash
npm install --save-exact @flashdata-dev/sdk@1.1.0
```


- [Instale Node.js](https://nodejs.org/en/download)

<a id="key"></a>

### Autenticação

Crie uma chave com permissão Google Search ou reutilize uma chave autorizada. Coloque FLASHDATA_API_KEY neste terminal usando o alerta escondido abaixo, pule isso se seu ambiente já o fornecer.

O exemplo passa a chave explicitamente. Um arquivo Env não é carregado por esses scripts. Mantenha a chave na configuração do servidor ao integrar-se em uma aplicação web.

#### Bash

##### Chave escondida pronta. Bash

```bash
# Bash: paste the key into a hidden prompt, not into this command.
read -r -s -p "FlashData API key: " FLASHDATA_API_KEY
printf '\n'
export FLASHDATA_API_KEY
```


#### PowerShell 7

##### Chave escondida pronta. PowerShell

```powershell
# PowerShell 7: paste the key into a hidden prompt.
$flashdataSecureKey = Read-Host "FlashData API key" -AsSecureString
$env:FLASHDATA_API_KEY = [System.Net.NetworkCredential]::new("", $flashdataSecureKey).Password
Remove-Variable flashdataSecureKey
```


- [Criar conta](https://flashdata.dev/signup)
- [Abrir API Keys](https://flashdata.dev/app/api-keys)
- [Abra Billing](https://flashdata.dev/app/billing)
- [Armação do teste do agente](https://flashdata.dev/pt/docs/guides/agent-onboarding/reference.md)

<a id="query"></a>

### Faça uma pesquisa

Salve o arquivo selecionado e execute seu comando neste projeto. Cada corrida envia uma busca por até cinco resultados. Ambos os arquivos são executados diretamente com Node.js; nenhum passo de construção é necessário para este exemplo.

#### TypeScript

##### quickstart.mts

```typescript
import { FlashData, type GoogleSearchParams } from '@flashdata-dev/sdk';

const apiKey = process.env.FLASHDATA_API_KEY;
if (!apiKey) throw new Error('Set FLASHDATA_API_KEY in the server environment.');
const client = new FlashData({ apiKey });
const params: GoogleSearchParams = { num: 5 };
const response = await client.google.search({ query: 'battery recycling research', ...params });
if (response.status !== 'done') throw new Error(JSON.stringify(response));

for (const page of response.results) {
  for (const hit of page.organic ?? []) console.log(hit.title, hit.link);
}
console.log('Credits used:', response.usage.credits);
```

##### Corra! Node.js 22.18!

```bash
node quickstart.mts
```


#### JavaScript

##### quickstart.mjs

```javascript
import { FlashData } from '@flashdata-dev/sdk';

const apiKey = process.env.FLASHDATA_API_KEY;
if (!apiKey) throw new Error('Set FLASHDATA_API_KEY in the server environment.');
const client = new FlashData({ apiKey });
const response = await client.google.search({ query: 'battery recycling research', num: 5 });
if (response.status !== 'done') throw new Error(JSON.stringify(response));

for (const page of response.results) {
  for (const hit of page.organic ?? []) console.log(hit.title, hit.link);
}
console.log('Credits used:', response.usage.credits);
```

##### Executar

```bash
node quickstart.mjs
```



<a id="result"></a>

### Confira o resultado

O script verifica o status e imprime títulos de origem, URLs e créditos usados. Os resultados orgânicos vazios são válidos. O exemplo abaixo ilustra a forma, fontes vivas variam.

| Campo | Use |
| --- | --- |
| results[].organic[] | Títulos Google Search, links e trechos. Outras fontes têm suas próprias cargas. |
| usage.credits | Créditos cobrados por este pedido, cinco retornos são um pedido de busca. |

#### Exemplo de saída

```text
Battery recycling research https://example.org/recycling
Credits used: 0.02
```


<a id="common-tasks"></a>

## Tente outra fonte de dados

Cada guia funciona em TypeScript e JavaScript. Substitua o arquivo do passo 3, mantenha sua extensão MTS ou MJs e execute o mesmo comando. Cada corrida é um novo pedido e precisa da permissão da fonte mostrada.

### Google Notícias

Requer google_news. Leia entradas de artigos em results[].news[].

#### quickstart.mts / quickstart.mjs

```typescript
import { FlashData } from '@flashdata-dev/sdk';

const apiKey = process.env.FLASHDATA_API_KEY;
if (!apiKey) throw new Error('Set FLASHDATA_API_KEY first.');
const client = new FlashData({ apiKey });
const response = await client.google.news({
  query: 'battery recycling', num: 5,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);
```


### YouTube metadados

Requer youtube_metadata. Devolve títulos, canais, duração e outros detalhes de vídeo.

#### quickstart.mts / quickstart.mjs

```typescript
import { FlashData } from '@flashdata-dev/sdk';

const apiKey = process.env.FLASHDATA_API_KEY;
if (!apiKey) throw new Error('Set FLASHDATA_API_KEY first.');
const client = new FlashData({ apiKey });
const response = await client.youtube.metadata({
  video_id: 'dQw4w9WgXcQ', include_formats: false,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);
```


### YouTube transcrição

Requer youtube_transcript. Solicita uma faixa automática inglesa existente. O texto está em results[].fullText quando a faixa está disponível.

#### quickstart.mts / quickstart.mjs

```typescript
import { FlashData } from '@flashdata-dev/sdk';

const apiKey = process.env.FLASHDATA_API_KEY;
if (!apiKey) throw new Error('Set FLASHDATA_API_KEY first.');
const client = new FlashData({ apiKey });
const response = await client.youtube.transcript({
  video_id: 'dQw4w9WgXcQ', language: 'en', auto: true,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);
```


- [Todos os parâmetros de origem](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/sources/index.md)

<a id="typecheck"></a>

## Verifique um projeto TypeScript

Node corre este exemplo despindo tipos. Para verificar os tipos sem enviar uma solicitação, instale TypeScript e execute o compilador com --noEmit:

### Verificação opcional do tipo

```bash
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmit
```

- [Node.js TypeScript suporte](https://nodejs.org/api/typescript.html)

<a id="features"></a>

## O que o SDK suporta

| Use | Métodos |
| --- | --- |
| google / youtube | Procure e recupere dados estruturados com ajudantes de origem digitados. Reutilize um cliente ao seu serviço. |
| youtube.download | Entregue áudio ou vídeo ao seu armazenamento na nuvem através de um trabalho de fundo. Requer permissão youtube_download e configuração de armazenamento. |
| jobs / bulk | Salve o trabalho submetido IDs e recupere resultados completos. aguarde esperas no JavaScript; mode: 'async' envia uma tarefa de background do lado do servidor. |
| account | Leia acesso, equilíbrio, preços, limites e uso antes do trabalho recorrente. |
| respondWith / accept | Passe { respondWith: 'markdown' } como segundo argumento do método para Markdown em response.content, ou { accept: 'text/plain' } para uma cadeia. Os objetos JSON são o padrão. |

- [Baixe o exemplo](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/examples/youtube_download.mjs)
- [Armazém de montagem](https://flashdata.dev/pt/docs/guides/youtube-download-guide/reference.md)
- [Formatos de resposta](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/response-formats.md)

<a id="next"></a>

## Próximos passos

- [Salvar resultados e lidar com erros](https://flashdata.dev/pt/docs/guides/sdk-operations/reference.md)
- [trabalhos e lotes](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/jobs.md)
- [Configuração do cliente](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/client.md)
- [Referência do método SDK](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/api-reference.md)

<a id="errors"></a>

## Se um passo falhar

| Problema | Consertar |
| --- | --- |
| Pacote ou tempo de execução faltando | Verifique o nó --version e instale @flashdata-dev/sdk neste projeto. Mantenha a extensão MTs ou MJs mostrada acima. |
| 401 / FLASHDATA_API_KEY | Coloque uma chave válida no terminal onde você executa o exemplo. |
| 403 | Active a busca Google por esta chave API. |
| 402 | verificação Billing para os créditos disponíveis, ou reivindique um teste de agente exausto. |
| 429 | Espere pelo Retry-After, então reduza a taxa de solicitação. |
| Tempo limite ou erro do servidor | Verifique History antes de reenviar, o primeiro pedido pode já ter sido executado. |

- [Requisito histórico](https://flashdata.dev/app/jobs)
- [Billing](https://flashdata.dev/app/billing)
- [Erros SDK e recuperação](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/errors.md)
