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

# Creating and Managing API Keys

> Step-by-Step Guide to Getting API Keys from the Kintsugi Platform

# Creating and Managing API Keys

<Note>
  **API keys authenticate your requests** to the Kintsugi API. This guide will walk you through creating, managing, and securing your API keys with screenshots and step-by-step instructions.
</Note>

API keys are essential for accessing the Kintsugi API programmatically. They provide secure authentication for your applications and integrations.

<CardGroup cols={2}>
  <Card title="Create Your First Key" icon="key" href="#create-a-new-api-key">
    Generate an API key in just a few clicks
  </Card>

  <Card title="Security Best Practices" icon="shield" href="#copy-and-secure-your-api-key">
    Keep your keys secure and compliant
  </Card>

  <Card title="API Reference" icon="code" href="/reference">
    Explore our comprehensive API docs
  </Card>

  <Card title="Test Your Key" icon="check-circle" href="/docs/making-authenticate-request-using-api-key">
    Verify your API key works correctly
  </Card>
</CardGroup>

## Create and manage keys in the Kintsugi app

Create and manage your API keys in the main Kintsugi app.

### Sign Up or Log In

<Steps>
  <Step>
    Visit the [Kintsugi Platform](https://app.trykintsugi.com/).
  </Step>

  <Step>
    If you don’t already have an account, click on the **Sign Up** button and follow the instructions to create an account.
  </Step>

  <Step>
    If you already have an account, click on the **Log In** button and enter your credentials to access the platform.
  </Step>
</Steps>

### Navigate to Configuration Section

<Steps>
  <Step>
    After logging in, locate the **Configuration option** in the bottom-left corner of the sidebar.

    <Frame>
      <img src="https://mintcdn.com/kintsugi/p4CB3kRGaA9X9Y_F/images/docs/dbab26c6d689638ebed26d64d568c8d7cfeb75cc6647d36f718e562888c5a750-Screenshot_2025-02-18_at_12.18.39_PM.png?fit=max&auto=format&n=p4CB3kRGaA9X9Y_F&q=85&s=28364abfcd42e8126ff5b47cd78b2a2b" alt="Configuration Section" width="558" height="716" data-path="images/docs/dbab26c6d689638ebed26d64d568c8d7cfeb75cc6647d36f718e562888c5a750-Screenshot_2025-02-18_at_12.18.39_PM.png" />
    </Frame>
  </Step>

  <Step>
    Under the **Configuration Section** locate API Keys as shown in the screenshot below.

    <Frame>
      <img src="https://mintcdn.com/kintsugi/p4CB3kRGaA9X9Y_F/images/docs/e18a5e4107601b7e80cf0081a44396bd1eb9fdb241702fa77cc08ef9d350e6f7-201c6286-a2bc-45d5-b4d8-3b36f4b05469.png?fit=max&auto=format&n=p4CB3kRGaA9X9Y_F&q=85&s=a38aa346c488328d92d12755e4754117" alt="API Keys Section" width="3200" height="379" data-path="images/docs/e18a5e4107601b7e80cf0081a44396bd1eb9fdb241702fa77cc08ef9d350e6f7-201c6286-a2bc-45d5-b4d8-3b36f4b05469.png" />
    </Frame>
  </Step>
</Steps>

### Access the API Keys Section

<Steps>
  <Step>
    Once in **Configuration Section** click API Keys section.
  </Step>

  <Step>
    Here, you can search, manage, and generate new API keys for your organization.

    <Frame>
      <img src="https://mintcdn.com/kintsugi/p4CB3kRGaA9X9Y_F/images/docs/99b23ff5ce71fd8b38cac8f8546350425a9d52e1311b64fbe1688c91c60f9f3a-Screenshot_2025-02-18_at_12.36.57_PM.png?fit=max&auto=format&n=p4CB3kRGaA9X9Y_F&q=85&s=36228638a2117f4a46b7d896d57cced0" alt="API Keys Section" width="2598" height="776" data-path="images/docs/99b23ff5ce71fd8b38cac8f8546350425a9d52e1311b64fbe1688c91c60f9f3a-Screenshot_2025-02-18_at_12.36.57_PM.png" />
    </Frame>
  </Step>
</Steps>

### Create a New API Key

<Steps>
  <Step>
    Click the **New** button to generate an API key.
  </Step>

  <Step>
    Once you click on **New**, you'll be prompted to select the expiration time for the API key.

    <Frame>
      <img src="https://mintcdn.com/kintsugi/p4CB3kRGaA9X9Y_F/images/docs/268ad200ccbde27ec7f8db440327f63161c8994cb76820b362926cd7217943ba-Screenshot_2025-02-18_at_12.43.31_PM.png?fit=max&auto=format&n=p4CB3kRGaA9X9Y_F&q=85&s=3c7de437c6356b8e8d895a0765d71b1f" alt="API Key Expiration" width="3022" height="1646" data-path="images/docs/268ad200ccbde27ec7f8db440327f63161c8994cb76820b362926cd7217943ba-Screenshot_2025-02-18_at_12.43.31_PM.png" />
    </Frame>
  </Step>

  <Step>
    Choose the expiration period that suits your needs. For example, if you want the key to be valid for a year, select One year.
  </Step>
</Steps>

### Copy and Secure Your API Key

1. Copy the API Key Immediately.

<Steps>
  <Step>
    Click the **copy icon** or **Manually copy API key** button to copy the key.
  </Step>

  <Step>
    You will not be able to view this key again, so ensure you store it in a secure location.
  </Step>

  <Step>
    After copying, click **Done** to exit the popup.

    <Frame>
      <img src="https://mintcdn.com/kintsugi/p4CB3kRGaA9X9Y_F/images/docs/d0c177de26067ee53e9f303435a767e600ef2c5750694d1b6181d32f1cd5d474-image.png?fit=max&auto=format&n=p4CB3kRGaA9X9Y_F&q=85&s=1c9cc2f1457f9df08065b984467c1b3d" alt="API Key Copied" width="3021" height="1084" data-path="images/docs/d0c177de26067ee53e9f303435a767e600ef2c5750694d1b6181d32f1cd5d474-image.png" />
    </Frame>
  </Step>
</Steps>

### Viewing and Managing Your API Keys

<Steps>
  <Step>
    You can view all generated API keys along with their **Key, Created Date, and Expiry Status**.
  </Step>

  <Step>
    Use the **search bar** to quickly find a specific key.
  </Step>

  <Step>
    To delete a key, click the three-dot menu (⋮) next to it and select **Delete API Key**.

    <Frame>
      <img src="https://mintcdn.com/kintsugi/p4CB3kRGaA9X9Y_F/images/docs/26e0e6cb1f35e3c7393300493a5f584edcd0781ecb2864d7d90074c9702332d9-image.png?fit=max&auto=format&n=p4CB3kRGaA9X9Y_F&q=85&s=632e56fb8b62991edf2315fcfd56566e" alt="API Key Management" width="2596" height="1046" data-path="images/docs/26e0e6cb1f35e3c7393300493a5f584edcd0781ecb2864d7d90074c9702332d9-image.png" />
    </Frame>
  </Step>
</Steps>

*API Keys are scoped to an organization and will remain active until the organization is deleted or the key is deleted. You can create multiple API keys to cycle them out periodically.*

<Info>
  *Users can only create API keys within a Test Organization or a Paid Organization. Creating API keys in other organization types is disabled.*
</Info>

## Next Steps

<CardGroup cols={3}>
  <Card title="Test Your Key" icon="check-circle" href="/docs/making-authenticate-request-using-api-key">
    Verify your API key works correctly
  </Card>

  <Card title="API Reference" icon="code" href="/reference">
    Explore available endpoints
  </Card>

  <Card title="Integration Guides" icon="plug" href="/docs/api-guides/planning-an-integration">
    Connect your applications
  </Card>
</CardGroup>

## Need Help?

<AccordionGroup>
  <Accordion title="Common Issues">
    <Tabs>
      <Tab title="Key Creation">
        * **Can't find API Keys section**: Check you're in a Test or Paid organization
        * **Permission denied**: Contact your organization admin
        * **Key not generating**: Try refreshing the page and try again
        * **Expiration options**: Choose based on your security requirements
      </Tab>

      <Tab title="Key Management">
        * **Can't find old key**: Keys are only shown once for security
        * **Key not working**: Check if it's expired or deleted
        * **Multiple keys**: Create new keys for different applications
        * **Key rotation**: Delete old keys and create new ones regularly
      </Tab>

      <Tab title="Security Concerns">
        * **Key compromised**: Delete immediately and create new key
        * **Suspicious activity**: Check usage logs in your dashboard
        * **Storage best practices**: Use environment variables, never hardcode
        * **Team access**: Share keys securely through password managers
      </Tab>
    </Tabs>
  </Accordion>

  <Accordion title="Get Support">
    <CardGroup cols={2}>
      <Card title="Email Support" icon="mail" href="mailto:success@trykintsugi.com">
        Get help from our support team
      </Card>

      <Card title="Live Chat" icon="message-circle" href="https://trykintsugi.com/support">
        Chat with us in real-time
      </Card>

      <Card title="API Documentation" icon="book" href="/reference">
        Browse our comprehensive API docs
      </Card>

      <Card title="Developer Community" icon="users" href="https://trykintsugi.com/community">
        Connect with other developers
      </Card>
    </CardGroup>
  </Accordion>
</AccordionGroup>
