Skip to main content
O SDK autentica todas as requisições com uma chave de API bearer. Você cria um YoukaClient uma única vez e o reutiliza durante todo o ciclo de vida do seu processo.

​
new YoukaClient(options)

import { YoukaClient } from "@youka/pt/sdk";

const client = new YoukaClient({
  apiKey: process.env.YOUKA_API_KEY!,
});

​
Opções

​
apiKey
string
required
Sua chave de API da Youka. Crie uma em online.youka.io/account em API keys.
​
fetch
typeof fetch
Implementação personalizada de fetch. O padrão é o fetch global. Use isto para injetar logging, proxies ou middleware de retentativas personalizado.

​
Armazenando a chave de API

Chaves de API dão acesso à sua cobrança. Nunca as envie para o controle de versão.
Padrões recomendados: 
const client = new YoukaClient({
  apiKey: process.env.YOUKA_API_KEY!,
});

​
Injetando um fetch personalizado

Todo método do SDK usa o fetch que você passa ao construtor. Isso facilita adicionar logging ou middleware: 
import { YoukaClient } from "@youka/pt/sdk";

const instrumentedFetch: typeof fetch = async (input, init) => {
  const start = Date.now();
  const response = await fetch(input, init);
  console.log(
    `${init?.method ?? "GET"} ${input} ${response.status} in ${Date.now() - start}ms`,
  );
  return response;
};

const client = new YoukaClient({
  apiKey: process.env.YOUKA_API_KEY!,
  fetch: instrumentedFetch,
});

​
Opções por requisição

Todo método aceita um segundo ou terceiro argumento opcional com opções no nível da requisição: 
await client.projects.create(body, {
  idempotencyKey: "import-2026-04-08-song-001",
  signal: abortController.signal,
});
​
idempotencyKey
string
Enviado como o header Idempotency-Key. Reutilizar a mesma chave com o mesmo payload retorna o resultado original em vez de criar um duplicado. Veja API idempotency.
​
signal
AbortSignal
Sinal padrão de abort. Cancela requisições em andamento e polls de longa duração de client.tasks.wait(...), client.projects.wait(...) e client.exports.wait(...).

​
Próximos passos