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

# API de Embeddings

> Use as rotas de embeddings da CometAPI para criar vetores para busca semântica, clustering, recomendações e fluxos de retrieval.

Use embeddings da CometAPI quando seu app precisar de vetores para busca semântica, clustering, recomendações ou retrieval. Envie texto para `/v1/embeddings`, armazene o vetor retornado e faça buscas nele com seu banco de dados vetorial.

## Criar um embedding

Use um model ID com suporte a embedding da [página Models](/pt/overview/models) ou do [diretório de modelos](https://www.cometapi.com/models/). Os exemplos abaixo chamam a API de Embeddings compatível com OpenAI.

<Note>
  Estes exemplos usam o placeholder `your-embedding-model-id`. Substitua-o por um model ID de embedding disponível na [página Models](/pt/overview/models) ou no [diretório de modelos](https://www.cometapi.com/models/) antes de executar a requisição.
</Note>

<Tip>
  Abra [Create embeddings](/api/text/embeddings) para usar o playground e o schema do endpoint.
</Tip>

<CodeGroup>
  ```python Python theme={null}
  import os
  import requests

  response = requests.post(
      "https://api.cometapi.com/v1/embeddings",
      headers={
          "Authorization": "Bearer " + os.environ["COMETAPI_KEY"],
          "Content-Type": "application/json",
      },
      json={
          "model": "your-embedding-model-id",
          "input": "CometAPI lets developers use many model providers.",
      },
      timeout=30,
  )

  response.raise_for_status()
  result = response.json()
  print(len(result["data"][0]["embedding"]))
  ```

  ```javascript Node.js theme={null}
  const response = await fetch("https://api.cometapi.com/v1/embeddings", {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.COMETAPI_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      model: "your-embedding-model-id",
      input: "CometAPI lets developers use many model providers.",
    }),
  });

  if (!response.ok) {
    throw new Error(await response.text());
  }

  const result = await response.json();
  console.log(result.data[0].embedding.length);
  ```

  ```bash cURL theme={null}
  curl https://api.cometapi.com/v1/embeddings \
    -H "Authorization: Bearer $COMETAPI_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "model": "your-embedding-model-id",
      "input": "CometAPI lets developers use many model providers."
    }'
  ```
</CodeGroup>

## Exemplo de resposta

Uma resposta bem-sucedida pode ser assim. A resposta inclui um vetor para cada item de entrada; o vetor abaixo foi encurtado para facilitar a leitura:

```json theme={null}
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        -0.0021,
        -0.0491,
        0.0209
      ]
    }
  ],
  "model": "your-embedding-model-id",
  "usage": {
    "prompt_tokens": 10,
    "total_tokens": 10
  }
}
```

## Entrada em lote

Envie um array de strings quando quiser vários vetores em uma única requisição:

```bash cURL theme={null}
curl https://api.cometapi.com/v1/embeddings \
  -H "Authorization: Bearer $COMETAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-embedding-model-id",
    "input": [
      "Create an API key",
      "Change the base URL",
      "Retry after a rate limit"
    ]
  }'
```

## Exemplos de registros de modelo

<Info>
  Este exemplo de resposta do catálogo de modelos mostra o envelope de `/api/models` e o formato de um registro de modelo de embedding compatível com OpenAI. Alguns registros de embedding usam `model_type` vazio; escolha um modelo de embedding pelo ID e pelo suporte ao endpoint, em vez de depender apenas desse campo.
</Info>

```bash cURL theme={null}
curl https://api.cometapi.com/api/models
```

```json theme={null}
{
  "success": true,
  "page": 1,
  "page_size": 20,
  "total": 302,
  "data": [
    {
      "created": 1757904564,
      "id": "your-embedding-model-id",
      "code": "your-embedding-model-id",
      "provider": "ExampleProvider",
      "provider_code": "example",
      "name": "Example embedding model",
      "model_type": "embedding",
      "features": [
        "text-embedding"
      ],
      "endpoints": [
        "openai"
      ],
      "pricing": {
        "currency": "USD / M Tokens",
        "input": 0.1,
        "output": null,
        "per_request": null,
        "per_second": null
      }
    }
  ]
}
```

## Erros comuns

<AccordionGroup>
  <Accordion title="Input too long">
    Divida documentos longos em partes antes de gerar embeddings.
  </Accordion>

  <Accordion title="Wrong model type">
    Escolha um modelo com capacidade de embedding no diretório de modelos.
  </Accordion>

  <Accordion title="Vector dimensions mismatch">
    Mantenha o mesmo modelo e as mesmas dimensões para um índice vetorial.
  </Accordion>

  <Accordion title="Missing API key">
    Envie `Authorization: Bearer $COMETAPI_KEY`.
  </Accordion>
</AccordionGroup>

## Códigos de erro e estratégia de retry

<AccordionGroup>
  <Accordion title="400">
    Não tente novamente até que a entrada, o model ID ou a configuração de dimensões seja corrigida.
  </Accordion>

  <Accordion title="401">
    Não tente novamente até que a chave de API esteja presente e seja válida.
  </Accordion>

  <Accordion title="404">
    Verifique a URL base, o caminho e o model ID antes de tentar novamente.
  </Accordion>

  <Accordion title="429">
    Tente novamente com exponential backoff e reduza o tamanho do lote ou a concorrência.
  </Accordion>

  <Accordion title="500 or 503">
    Tente novamente com backoff para erros transitórios do provedor ou do serviço.
  </Accordion>
</AccordionGroup>

<Tip>
  Para padrões de implementação, consulte [Error codes and retry strategy](/pt/guides/error-codes-and-retry-strategy) e [Rate limits and concurrency](/pt/guides/rate-limits-and-concurrency).
</Tip>

## Preços e diretório de modelos

<CardGroup cols={3}>
  <Card title="Models page" icon="list" href="/overview/models">
    Leia como a CometAPI expõe model IDs na documentação.
  </Card>

  <Card title="Model directory" icon="puzzle-piece" href="https://www.cometapi.com/models/">
    Navegue pela disponibilidade e pelas capacidades dos modelos.
  </Card>

  <Card title="Pricing" icon="tag" href="https://www.cometapi.com/pricing/">
    Verifique os preços antes de chamar um modelo.
  </Card>
</CardGroup>