Node.js

O SDK Node.js oficial da CaptureKit, com um método tipado por endpoint e um request() genérico para o resto.

RequisitosCopiar link da âncora

• Node.js 20+

InstalaçãoCopiar link da âncora

npm install @capturekitdev/sdk

Obtenha sua chave de APICopiar link da âncora

Copie sua chave de API no painel da CaptureKit e coloque-a na variável de ambiente CAPTUREKIT_API_KEY, que o SDK lê por padrão. Não a inclua no controle de versão.

Início rápidoCopiar link da âncora

import { CaptureKitClient } from "@capturekitdev/sdk";

const client = new CaptureKitClient({ apiKey: process.env.CAPTUREKIT_API_KEY });

const response = await client.content({ url: "https://example.com" });
console.log(response.data);

Jobs assíncronosCopiar link da âncora

Qualquer chamada aceita is_async, útil além do limite de 60 segundos do servidor. A resposta é então um job_id, e o SDK pode aguardar o fim do job.

const submitted = await client.content({
  url: "https://example.com",
  is_async: true,
});
const job = await client.waitForJob(submitted.data.job_id, {
  onProgress: (j) => console.log(`${j.status} ${j.progress ?? 0}%`),
});
console.log(JSON.stringify(job.data, null, 2));

ErrosCopiar link da âncora

Uma resposta fora de 2xx gera um erro de API com status e mensagem. Veja os códigos de status para a lista completa.

import { CaptureKitApiError } from "@capturekitdev/sdk";

try {
  await client.content({ url: "https://example.com" });
} catch (error) {
  if (error instanceof CaptureKitApiError) {
    console.error(error.status, error.message, error.responseBody);
  }
  throw error;
}

Novas tentativasCopiar link da âncora

As requisições são repetidas até 3 vezes após um erro de rede, um 408, 500, 502, 503 ou 504, ou um limite de taxa do plano. Erros de cota por chave e timeouts do cliente não são repetidos. A espera começa em 1 segundo e cresce 1,5× a cada tentativa, e um cabeçalho Retry-After tem prioridade.

const client = new CaptureKitClient({ maxRetries: 5, retryDelay: 500 });

// or for one request
await client.content({ url: "https://example.com" }, { maxRetries: 0 });

Requisições em loteCopiar link da âncora

Execute muitas chamadas de uma vez, 10 por padrão. Uma falha não interrompe as outras.

const inputs = [
  "https://example.com",
  "https://www.capturekit.dev",
  "https://github.com",
];
const results = await client.batch(inputs, (url) => client.content({ url }), {
  concurrency: 5,
});

for (const result of results) {
  if (result.status === "fulfilled") console.log(result.value.data);
  else console.error(inputs[result.index], result.reason);
}

Qualquer endpointCopiar link da âncora

request() alcança qualquer caminho, inclusive endpoints lançados depois da sua versão do SDK.

const response = await client.request("GET", "/v1/usage");

Erros comunsCopiar link da âncora

• Colocar a chave de API no código front-end. Qualquer pessoa poderia lê-la. Chame a API a partir do seu servidor.
• Tratar todo 401 como chave incorreta. Um 401 também pode ser um limite de taxa: leia a mensagem. O SDK repete automaticamente os limites do plano.
• Repetir um 402. Não há mais créditos nem cota, então uma nova tentativa não pode funcionar. Veja Créditos.
• Esperar requisições longas. Acima de 60 segundos, use o modo assíncrono como mostrado acima em vez de aumentar o timeout. Veja Timeout.

LinksCopiar link da âncora

• Pacote: @capturekitdev/sdk
• Código-fonte: github.com/capturekitdev/capturekit-node
• Referência da API