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

# Connect SearchOS with API Key – StackOne Hub

> Link a SearchOS account in the StackOne Hub using API Key. End-user guide to authorize the integration and start using SearchOS actions.

## Generating an API key

An API key gives access to your SearchOS workspace's candidates, companies, contacts, vacancies and campaigns.

**1. Create the key**

Sign in to your [SearchOS account](https://search-os.io/login), then go to **Settings** > **Workspace & team**. Scroll to **Developer** > **API keys**.

<ul>
  <li>**Key name (e.g. Zapier)**: `StackOne Integration`</li>
  <li>Click **Create key**.</li>
</ul>

![SearchOS Workspace & team settings with the API key name field and Create key button highlighted](https://mintcdn.com/stackone-60/XCCn6S74hKoKhOwb/connectors/searchos/images/custom-config-create-key.png?fit=max\&auto=format\&n=XCCn6S74hKoKhOwb\&q=85\&s=ed4c9a291f9faa3de8271c2d5700d7bb)

**2. Copy the key**

The new key appears above the keys list.

<ul>
  <li>Click **Copy** next to the new key.</li>
  <li>Copy the **API Key** across.</li>
  <li>The key is shown once and cannot be retrieved later. If you lose it, click **Revoke** on that key and create another.</li>
</ul>

![SearchOS API keys list showing the new key with the Copy button highlighted](https://mintcdn.com/stackone-60/XCCn6S74hKoKhOwb/connectors/searchos/images/custom-config-copy-key.png?fit=max\&auto=format\&n=XCCn6S74hKoKhOwb\&q=85\&s=2d2a416cf7789409b0060b88dc122d9b)

## Link the Account

**1. Connect**

<ul>
  <li>Click **Connect**.</li>
  <li>If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider's authorization flow.</li>
  <li>Once authorization is successful, you will see a confirmation popup.</li>
</ul>

**2. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Next Steps

> [card] [Webhooks setup](https://docs.stackone.com/connectors/searchos/guides/webhook-setup.md)
>
> Configure receiving Events for SearchOS into StackOne.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.