> ## Documentation Index
> Fetch the complete documentation index at: https://docs.venice.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Início rápido

> Início rápido para a API Venice — gere uma chave de API, envie sua primeira chat completion e explore endpoints de imagem, vídeo e áudio em minutos.

Comece a usar a API Venice em minutos. Gere uma chave de API, faça sua primeira requisição e comece a construir.

## Início rápido

<Steps>
  <Step title="Obtenha sua chave de API">
    Acesse as [Configurações da API Venice](https://venice.ai/settings/api) e gere uma nova chave de API.

    Para um passo a passo detalhado, confira o [guia de Chave de API](/guides/getting-started/generating-api-key).
  </Step>

  <Step title="Configure sua chave de API">
    Adicione sua chave de API ao seu ambiente. Você pode exportá-la no seu shell:

    ```bash theme={"system"}
    export VENICE_API_KEY='your-api-key-here'
    ```

    Ou adicione-a a um arquivo `.env` no seu projeto:

    ```bash theme={"system"}
    VENICE_API_KEY=your-api-key-here
    ```
  </Step>

  <Step title="Instale o SDK">
    A Venice é compatível com a OpenAI, então você pode usar o SDK da OpenAI. Se preferir usar cURL ou requisições HTTP diretas, você pode pular esta etapa.

    <CodeGroup>
      ```bash Python theme={"system"}
      pip install openai
      ```

      ```bash Node.js theme={"system"}
      npm install openai
      ```
    </CodeGroup>
  </Step>

  <Step title="Envie sua primeira requisição">
    <CodeGroup>
      ```python Python theme={"system"}
      import os
      from openai import OpenAI

      client = OpenAI(
          api_key=os.getenv("VENICE_API_KEY"),
          base_url="https://api.venice.ai/api/v1"
      )

      completion = client.chat.completions.create(
          model="zai-org-glm-5",
          messages=[
              {"role": "system", "content": "You are a helpful AI assistant"},
              {"role": "user", "content": "Why is privacy important?"}
          ]
      )

      print(completion.choices[0].message.content)
      ```

      ```javascript Node.js theme={"system"}
      import OpenAI from 'openai';

      const client = new OpenAI({
          apiKey: process.env.VENICE_API_KEY,
          baseURL: 'https://api.venice.ai/api/v1'
      });

      const completion = await client.chat.completions.create({
          model: 'zai-org-glm-5',
          messages: [
              { role: 'system', content: 'You are a helpful AI assistant' },
              { role: 'user', content: 'Why is privacy important?' }
          ]
      });

      console.log(completion.choices[0].message.content);
      ```

      ```bash cURL theme={"system"}
      curl https://api.venice.ai/api/v1/chat/completions \
        -H "Authorization: Bearer $VENICE_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{
          "model": "zai-org-glm-5",
          "messages": [
            {"role": "system", "content": "You are a helpful AI assistant"},
            {"role": "user", "content": "Why is privacy important?"}
          ]
        }'
      ```
    </CodeGroup>

    **Papéis das mensagens:**

    * `system` - Instruções sobre como o modelo deve se comportar
    * `user` - Seus prompts ou perguntas
    * `assistant` - Respostas anteriores do modelo (para conversas de múltiplos turnos)
    * `tool` - Resultados de chamadas de função (ao usar ferramentas)
  </Step>

  <Step title="Troque de modelo alterando o ID do modelo">
    Toda requisição inclui um ID de `model`. Para usar um modelo diferente, altere o valor de `model` na sua requisição. Escolhas populares:

    * `zai-org-glm-5` - Modelo padrão para a maioria dos casos de uso
    * `kimi-k2-6` - Raciocínio robusto para tarefas mais complexas
    * `claude-opus-4-8` - Modelo de alta inteligência para tarefas complexas
    * `venice-uncensored-1-2` - Modelo sem censura da Venice

    <Card title="Ver todos os modelos" icon="database" href="/overview/models">
      Navegue pela lista completa de modelos com preços, capacidades e limites de contexto
    </Card>
  </Step>

  <Step title="Use os Venice Parameters">
    Você pode optar por habilitar recursos específicos da Venice, como busca na web, usando `venice_parameters`:

    <CodeGroup>
      ```python Python theme={"system"}
      import os
      from openai import OpenAI

      client = OpenAI(
          api_key=os.environ.get("VENICE_API_KEY"),
          base_url="https://api.venice.ai/api/v1"
      )

      completion = client.chat.completions.create(
          model="zai-org-glm-5",
          messages=[
              {"role": "user", "content": "What are the latest developments in AI?"}
          ],
          extra_body={
              "venice_parameters": {
                  "enable_web_search": "auto",
                  "include_venice_system_prompt": True
              }
          }
      )

      print(completion.choices[0].message.content)
      ```

      ```javascript Node.js theme={"system"}
      import OpenAI from 'openai';

      const client = new OpenAI({
          apiKey: process.env.VENICE_API_KEY,
          baseURL: 'https://api.venice.ai/api/v1'
      });

      const completion = await client.chat.completions.create({
          model: 'zai-org-glm-5',
          messages: [
              { role: 'user', content: 'What are the latest developments in AI?' }
          ],
          venice_parameters: {
              enable_web_search: 'auto',
              include_venice_system_prompt: true
          }
      });

      console.log(completion.choices[0].message.content);
      ```

      ```bash cURL theme={"system"}
      curl https://api.venice.ai/api/v1/chat/completions \
        -H "Authorization: Bearer $VENICE_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{
          "model": "zai-org-glm-5",
          "messages": [
            {"role": "user", "content": "What are the latest developments in AI?"}
          ],
          "venice_parameters": {
            "enable_web_search": "auto",
            "include_venice_system_prompt": true
          }
        }'
      ```
    </CodeGroup>

    Veja todos os [parâmetros disponíveis](https://docs.venice.ai/api-reference/api-spec#venice-parameters).
  </Step>

  <Step title="Habilite o streaming (opcional)">
    Faça o streaming das respostas em tempo real usando `stream=True`:

    <CodeGroup>
      ```python Python theme={"system"}
      import os
      from openai import OpenAI

      client = OpenAI(
          api_key=os.environ.get("VENICE_API_KEY"),
          base_url="https://api.venice.ai/api/v1"
      )

      stream = client.chat.completions.create(
          model="zai-org-glm-5",
          messages=[{"role": "user", "content": "Write a short story about AI"}],
          stream=True
      )

      for chunk in stream:
          if chunk.choices and chunk.choices[0].delta.content is not None:
              print(chunk.choices[0].delta.content, end="")
      ```

      ```javascript Node.js theme={"system"}
      import OpenAI from 'openai';

      const client = new OpenAI({
          apiKey: process.env.VENICE_API_KEY,
          baseURL: 'https://api.venice.ai/api/v1'
      });

      const stream = await client.chat.completions.create({
          model: 'zai-org-glm-5',
          messages: [{ role: 'user', content: 'Write a short story about AI' }],
          stream: true
      });

      for await (const chunk of stream) {
          if (chunk.choices && chunk.choices[0]?.delta?.content) {
              process.stdout.write(chunk.choices[0].delta.content);
          }
      }
      ```

      ```bash cURL theme={"system"}
      curl https://api.venice.ai/api/v1/chat/completions \
        -H "Authorization: Bearer $VENICE_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{
          "model": "zai-org-glm-5",
          "messages": [
            {"role": "user", "content": "Write a short story about AI"}
          ],
          "stream": true
        }'
      ```
    </CodeGroup>
  </Step>

  <Step title="Personalize o comportamento da resposta (opcional)">
    Controle como o modelo responde com parâmetros como temperature, max tokens e outros:

    <CodeGroup>
      ```python Python theme={"system"}
      import os
      from openai import OpenAI

      client = OpenAI(
          api_key=os.environ.get("VENICE_API_KEY"),
          base_url="https://api.venice.ai/api/v1"
      )

      completion = client.chat.completions.create(
          model="zai-org-glm-5",
          messages=[
              {"role": "system", "content": "You are a creative storyteller"},
              {"role": "user", "content": "Tell me a creative story"}
          ],
          temperature=0.8,
          max_tokens=500,
          top_p=0.9,
          frequency_penalty=0.5,
          presence_penalty=0.5,
          extra_body={
              "venice_parameters": {
                  "include_venice_system_prompt": False
              }
          }
      )

      print(completion.choices[0].message.content)
      ```

      ```javascript Node.js theme={"system"}
      import OpenAI from 'openai';

      const client = new OpenAI({
          apiKey: process.env.VENICE_API_KEY,
          baseURL: 'https://api.venice.ai/api/v1'
      });

      const completion = await client.chat.completions.create({
          model: 'zai-org-glm-5',
          messages: [
              { role: 'system', content: 'You are a creative storyteller' },
              { role: 'user', content: 'Tell me a creative story' }
          ],
          temperature: 0.8,
          max_tokens: 500,
          top_p: 0.9,
          frequency_penalty: 0.5,
          presence_penalty: 0.5,
          venice_parameters: {
              include_venice_system_prompt: false
          }
      });

      console.log(completion.choices[0].message.content);
      ```

      ```bash cURL theme={"system"}
      curl https://api.venice.ai/api/v1/chat/completions \
        -H "Authorization: Bearer $VENICE_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{
          "model": "zai-org-glm-5",
          "messages": [
            {"role": "system", "content": "You are a creative storyteller"},
            {"role": "user", "content": "Tell me a creative story"}
          ],
          "temperature": 0.8,
          "max_tokens": 500,
          "top_p": 0.9,
          "frequency_penalty": 0.5,
          "presence_penalty": 0.5,
          "stream": false,
          "venice_parameters": {
            "include_venice_system_prompt": false
          }
        }'
      ```
    </CodeGroup>

    Confira a [documentação de Chat Completions](/api-reference/endpoint/chat/completions) para mais informações sobre todos os parâmetros suportados.
  </Step>
</Steps>

***

## Próximos passos

Agora que você fez suas primeiras requisições, explore mais do que a API Venice tem a oferecer:

<CardGroup cols={2}>
  <Card title="Explorar modelos" icon="database" href="/overview/models">
    Compare todos os modelos disponíveis com suas capacidades, preços e limites de contexto
  </Card>

  <Card title="Referência da API" icon="code" href="/api-reference/api-spec">
    Explore a documentação detalhada da API com todos os endpoints e parâmetros
  </Card>

  <Card title="Respostas estruturadas" icon="brackets-curly" href="/guides/features/structured-responses">
    Aprenda a obter respostas JSON com schemas garantidos
  </Card>

  <Card title="Guia de agentes de IA" icon="robot" href="/guides/integrations/ai-agents">
    Construa com apps de agentes, agentes de código, ferramentas MCP, skills e fluxos crypto
  </Card>
</CardGroup>

### Recursos adicionais

<CardGroup cols={2}>
  <Card title="Rate Limiting" icon="gauge" href="/api-reference/rate-limiting">
    Entenda os limites de taxa e as melhores práticas para uso em produção
  </Card>

  <Card title="Códigos de erro" icon="triangle-exclamation" href="/api-reference/error-codes">
    Referência para lidar com erros da API e solucionar problemas
  </Card>

  <Card title="Coleção do Postman" icon="bolt" href="/guides/getting-started/postman">
    Importe nossa coleção completa do Postman para testes fáceis
  </Card>

  <Card title="Privacidade e segurança" icon="shield" href="/overview/privacy">
    Saiba mais sobre a arquitetura da Venice focada em privacidade e o tratamento de dados
  </Card>
</CardGroup>

***

## Precisa de ajuda?

* **Comunidade no Discord**: Entre no nosso [servidor do Discord](https://discord.gg/askvenice) para suporte e discussões
* **Documentação**: Navegue pela nossa [referência completa da API](/api-reference/api-spec)
* **Página de status**: Verifique o status do serviço em [veniceai-status.com](https://veniceai-status.com)
* **Twitter**: Siga [@AskVenice](https://x.com/AskVenice) para atualizações

<Resources />