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

# Get API Key

> Learn how to get and manage your TaamCloud API keys

## Getting Your First API Key

<Steps>
  <Step title="Visit TaamCloud">
    Go to [TaamCloud Platform](https://app.gately.ai/)
  </Step>

  <Step title="Access Developer Portal">
    After logging in, go to [Settings > Developer Portal](https://app.gately.ai/dashboard/settings/organization/developers)
  </Step>

  <Step title="Generate API Key">
    1. Navigate to API Keys section
    2. Click "Generate New Key" button
    3. Save your key securely - it won't be shown again!
  </Step>

  <Step title="Test Your Key">
    Try a simple API request:

    ```bash theme={null}
    curl https://api.gately.ai/v1/models \
      -H "Authorization: Bearer YOUR_API_KEY"
    ```
  </Step>
</Steps>

<Note>
  Save your API key securely - it won't be shown again!
</Note>

### Using Your API Key

Include your API key in the Authorization header:

```bash theme={null}
curl https://api.gately.ai/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
```

### Authentication Requirements

<AccordionGroup>
  <Accordion title="Endpoints Requiring Auth" icon="lock">
    The following endpoints require authentication:

    * Chat Completions (`/v1/chat/completions`)
    * Embeddings (`/v1/embeddings`)
    * Image Generation (`/v1/images/generations`)
    * Model List (`/v1/models`)
    * Music Generation (`/suno/submit/music`)
    * Reranking (`/v1/rerank`)
  </Accordion>

  <Accordion title="No Auth Required" icon="lock-open">
    These endpoints don't require authentication:

    * File Upload (`/upload`)
    * Web Crawling (`/v1/crawl`)
    * Web Scraping (`/v1/scrape`)
    * Site Mapping (`/v1/map`)
  </Accordion>
</AccordionGroup>

### Best Practices

1. **Key Security**
   * Never share your API keys
   * Don't commit keys to version control
   * Use environment variables
   * Rotate keys periodically

2. **Rate Limiting**
   * Monitor your usage
   * Implement backoff strategies
   * Contact support for limit increases

3. **Error Handling**
   * Handle authentication errors (401)
   * Check for expired keys
   * Implement key rotation logic

### Managing Multiple Keys

You can generate multiple API keys for different purposes:

* Development vs. Production
* Different applications
* Service isolation

### Revoking Keys

If a key is compromised:

1. Log into the Developer Portal
2. Find the compromised key
3. Click "Revoke Key"
4. Generate a new key
5. Update your applications

<Warning>
  Revoked keys cannot be restored. Make sure to update your applications before revoking a key.
</Warning>