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

# Encurtar um Link

> Esse endpoint cria um link curto

### Corpo da requisição

<ParamField body="link" type="string">
  É o link longo que você quer encurtar.
</ParamField>

<ParamField body="token" type="string">
  Texto opcional para identificar o seu link curto. Será gerado automaticamente se vazio.
</ParamField>

<ParamField body="password" type="string">
  Texto opcional para proteger o seu link curto.
</ParamField>

<ParamField body="expire_at" type="timestamp">
  Data opcional para expirar seu link curto. Segue o [formato ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) para datas.
</ParamField>

<ParamField body="tag_id" type="string">
  Identificador da Tag que deseja associar seu link curto.
</ParamField>

### Resposta

<ResponseField name="status" type="string">
  Indica se a requisição foi bem sucedida. OK para quando for bem sucedida, e ERROR para quando não for.
</ResponseField>

<ResponseField name="data" type="object">
  <Expandable title="Link Object">
    <ResponseField name="id" type="string">
      Esse é o ID interno do link criado. Você não precisa memorizar esse dado
    </ResponseField>

    <ResponseField name="destination" type="string">
      É o destino do seu link curto (o link longo).
    </ResponseField>

    <ResponseField name="token" type="string">
      O identificador do seu link curto.
    </ResponseField>

    <ResponseField name="short_link" type="string">
      É o endereço compartilhável do seu link curto. Você pode copiar esse valor e compartilhar com sua audiência.
    </ResponseField>

    <ResponseField name="domain" type="string">
      Esse é o domínio utilizado para criar seu link curto.
    </ResponseField>

    <ResponseField name="domain_id" type="string">
      Esse é o ID interno do domínio utilizado para criar seu link curto. Você não precisa memorizar esse valor.
    </ResponseField>

    <ResponseField name="password" type="boolean">
      Indica se o link criado é protegido por senha ou não.
    </ResponseField>

    <ResponseField name="created_at" type="timestamp">
      Data de criação do link curto.
    </ResponseField>

    <ResponseField name="updated_at" type="timestamp">
      Data da última atualização de um link curto.
    </ResponseField>

    <ResponseField name="clicks" type="number">
      O número de cliques que esse link curto já teve.
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash theme={null}
  curl -X POST -H 'Content-Type: application/json' \
  -H 'X-Curto-Api-Key: <your_key>' \
  -d '{ "link": "<your_destination>" }' \
  https://api.curto.io/v1/links
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "id": "<link_id>",
      "destination": "<your_destination>",
      "token": "D7tX8",
      "short_link": "https://curr.to/D7tX8",
      "domain_id": "<domain_id>",
      "domain": "curr.to",
      "password": false,
      "created_at": "2023-06-21T20:26:04.865908",
      "updated_at": "2023-06-21T20:26:04.865922",
      "clicks": 0
    },
    "status": "OK"
  }
  ```
</ResponseExample>