# Início rápido

> Faça sua primeira requisição ao YesCaptcha em 5 minutos: cadastre-se, copie a clientKey, faça uma recarga e reconheça um captcha de imagem com curl, Python ou Node.js (ImageToTextTaskOcrBase, resposta síncrona, 2 pontos por imagem).

Source: https://docs.yescaptcha.com/pt/getting-started/quickstart/ · Last verified: 2026-10-15

> This page was machine-translated from the Chinese version. If anything differs, the Chinese version prevails: https://docs.yescaptcha.com/zh/getting-started/quickstart/

Esta página faz a primeira requisição com o tipo de tarefa mais simples, `ImageToTextTaskOcrBase` (reconhece letras e números em uma imagem). Ele é síncrono: uma única requisição `createTask` já retorna o resultado, custa 2 pontos (≈ US$0.30 / 1k) por imagem e não depende de sites de terceiros, o que o torna ideal para confirmar que a conta e o código estão funcionando.

1.  **Crie uma conta**
    
    Acesse [yescaptcha.com](https://yescaptcha.com/), cadastre-se e faça login.
    
2.  **Copie a clientKey**
    
    Depois de entrar, no Painel ([yescaptcha.com/dashboard.html](https://yescaptcha.com/dashboard.html)) encontre “Sua ClientKey” e clique em copiar. Copie o valor completo.
    
    > **Cuidado:** Todas as requisições da API são autenticadas com a clientKey; quem tiver acesso a ela pode usar o seu saldo. Não a compartilhe nem a coloque em código público. Se vazar, você pode redefini-la no mesmo lugar.
    
3.  **Faça uma recarga**
    
    O saldo precisa ser maior que 10 pontos para criar tarefas. Formas de pagamento e bônus VIP: [Recarga e VIP](https://docs.yescaptcha.com/pt/account/recharge.md).
    
4.  **Confirme que a clientKey funciona**
    
    `getBalance` consulta o saldo e não cobra pontos:
    
    ```bash
    curl -s https://api.yescaptcha.com/getBalance \
      -H 'Content-Type: application/json' \
      -d '{"clientKey": "YOUR_CLIENT_KEY"}'
    ```
    
    Se retornar `{"errorId": 0, "balance": 12345, ...}`, está tudo certo; `balance` é o saldo restante em pontos. Se retornar `ERROR_KEY_DOES_NOT_EXIST`, a chave foi copiada incorretamente.
    
5.  **Reconheça uma imagem**
    
    Baixe a imagem de exemplo [captcha.jpg](https://docs.yescaptcha.com/samples/captcha.jpg) (ou use sua própria imagem de captcha), coloque a clientKey em uma variável de ambiente e execute um dos scripts:
    
    ```bash
    export YESCAPTCHA_CLIENT_KEY=your_client_key
    ```
    
    **curl**
    
    quickstart.sh
    
    ```bash
    #!/usr/bin/env bash
    # First request: read an alphanumeric image captcha with ImageToTextTaskOcrBase (synchronous, 2 points per image)
    # Usage: YESCAPTCHA_CLIENT_KEY=your_client_key bash quickstart.sh captcha.png
    set -euo pipefail
    IMAGE="${1:-captcha.png}"
    BODY=$(base64 < "$IMAGE" | tr -d '\n')   # no "data:" prefix, no line breaks
    curl -s https://api.yescaptcha.com/createTask \
      -H 'Content-Type: application/json' \
      -d "{\"clientKey\": \"${YESCAPTCHA_CLIENT_KEY}\", \"task\": {\"type\": \"ImageToTextTaskOcrBase\", \"body\": \"${BODY}\"}}"
    echo
    ```
    
    
    
    **Python**
    
    quickstart.py
    
    ```python
    """First request: read an alphanumeric image captcha with ImageToTextTaskOcrBase
    (synchronous, 2 points per image).
    
    Usage:
        export YESCAPTCHA_CLIENT_KEY=your_client_key
        python quickstart.py captcha.png
    """
    import base64
    import os
    import sys
    
    import requests
    
    CLIENT_KEY = os.environ["YESCAPTCHA_CLIENT_KEY"]
    image_path = sys.argv[1] if len(sys.argv) > 1 else "captcha.png"
    
    with open(image_path, "rb") as f:
        body = base64.b64encode(f.read()).decode()  # no "data:" prefix
    
    r = requests.post(
        "https://api.yescaptcha.com/createTask",
        json={
            "clientKey": CLIENT_KEY,
            "task": {"type": "ImageToTextTaskOcrBase", "body": body},
        },
        timeout=30,
    )
    data = r.json()
    if data.get("errorId"):
        raise SystemExit(f"{data.get('errorCode')}: {data.get('errorDescription')}")
    print("text:", data["solution"]["text"])
    ```
    
    
    
    **Node.js**
    
    quickstart.mjs
    
    ```js
    // First request: read an alphanumeric image captcha with ImageToTextTaskOcrBase (synchronous, 2 points per image).
    // Usage: YESCAPTCHA_CLIENT_KEY=your_client_key node quickstart.mjs captcha.png
    import { readFileSync } from 'node:fs';
    
    const CLIENT_KEY = process.env.YESCAPTCHA_CLIENT_KEY;
    const body = readFileSync(process.argv[2] ?? 'captcha.png').toString('base64'); // no "data:" prefix
    
    const res = await fetch('https://api.yescaptcha.com/createTask', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({ clientKey: CLIENT_KEY, task: { type: 'ImageToTextTaskOcrBase', body } }),
    });
    const data = await res.json();
    if (data.errorId) throw new Error(`${data.errorCode}: ${data.errorDescription}`);
    console.log('text:', data.solution.text);
    ```
    
    Execute: `bash quickstart.sh captcha.jpg`, `python quickstart.py captcha.jpg` ou `node quickstart.mjs captcha.jpg`. O Python exige `pip install requests` antes; o Node.js exige a versão 18 ou superior.
    
6.  **Veja o resultado**
    
    Em caso de sucesso, a resposta é:
    
    ```json
    {
      "errorId": 0,
      "status": "ready",
      "solution": {
        "text": "LMResm"
      },
      "taskId": "2376919c-1863-11ec-a012-94e6f7355a0b"
    }
    ```
    
    `errorId` igual a 0 indica sucesso, e o texto reconhecido está em `solution.text`. Se `errorId` for 1, consulte `errorCode`; os significados estão em [Códigos de erro](https://docs.yescaptcha.com/pt/api/errors.md).
    

## Próximos passos

-   Tarefas que retornam token, como reCAPTCHA e hCaptcha, são **assíncronas**: `createTask` retorna primeiro o `taskId`, e depois você chama `getTaskResult` a cada 5 segundos. O fluxo completo está em [Requisições e respostas](https://docs.yescaptcha.com/pt/api/overview.md); veja um exemplo em [reCAPTCHA v2](https://docs.yescaptcha.com/pt/tasks/recaptcha-v2.md).
-   Para escolher o tipo de tarefa: [Tipos de tarefa e preços](https://docs.yescaptcha.com/pt/tasks.md).
-   Um cliente que você pode copiar direto para o projeto: [Python](https://docs.yescaptcha.com/pt/samples/python.md), [Node.js](https://docs.yescaptcha.com/pt/samples/nodejs.md).
-   Sem escrever código: [extensão do navegador](https://docs.yescaptcha.com/pt/extension.md).