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

# Quickstart

> Authenticate and make your first Amplify API request.

## Prerequisites

Before you begin, you need:

* An Amplify account with API access
* An Amplify API key
* A command-line HTTP client such as `curl`

<Warning>
  Keep the API key and access token secret. Never expose either credential in browser code, public repositories, or client-side applications.
</Warning>

<Steps>
  <Step title="Store your API key">
    Store your API key in an environment variable so it does not appear directly in your source code.

    ```bash theme={null}
    export AMPLIFY_API_KEY="your_api_key"
    ```
  </Step>

  <Step title="Request an access token">
    Exchange the API key for an access token using the authentication endpoint.

    ```bash theme={null}
    TOKEN_RESPONSE=$(curl --silent --request POST "https://api.amplify.xyz/v1/auth" \
      --header "Content-Type: application/json" \
      --data "{\"api_secret_key\":\"$AMPLIFY_API_KEY\"}")
    ```

    A successful response contains the token at `data.access_token`, identifies its type as `Bearer`, and sets `expires_in` to `86400` seconds (24 hours).

    ```json theme={null}
    {
      "status": 1,
      "message": "Token Generate Successfully",
      "data": {
        "access_token": "YOUR_ACCESS_TOKEN",
        "token_type": "Bearer",
        "expires_in": 86400
      }
    }
    ```
  </Step>

  <Step title="Store the access token">
    Extract the access token with `jq` and store it for subsequent requests.

    ```bash theme={null}
    export AMPLIFY_ACCESS_TOKEN=$(echo "$TOKEN_RESPONSE" | jq -r '.data.access_token')
    ```
  </Step>

  <Step title="Make your first API request">
    Retrieve a list of phone numbers from the production API.

    ```bash theme={null}
    curl "https://api.amplify.xyz/v1/numbers?limit=10" \
      --header "Authorization: Bearer $AMPLIFY_ACCESS_TOKEN" \
      --header "Accept: application/json"
    ```
  </Step>

  <Step title="Inspect the response">
    A successful list response contains a `data` array and pagination metadata.

    ```json theme={null}
    {
      "data": [],
      "meta": {
        "total": 0,
        "next_cursor": "",
        "previous_cursor": "",
        "limit": 10,
        "request_id": "9b16f7a0-fdb4-457a-8cad-fa158c71cf78"
      }
    }
    ```
  </Step>
</Steps>

<Tip>
  Save the `meta.request_id` value when troubleshooting a request.
</Tip>

## Next steps

<CardGroup cols={2}>
  <Card title="List numbers" icon="phone" href="/api-reference/numbers/list-numbers">
    Review filters and the complete response schema.
  </Card>

  <Card title="Authentication" icon="key" href="/guides/authentication">
    Review the access-token flow and security guidance.
  </Card>

  <Card title="Requests and responses" icon="arrows-left-right" href="/guides/requests-and-responses">
    Learn the shared request and response formats.
  </Card>
</CardGroup>