> For the complete documentation index, see [llms.txt](https://communityone.gitbook.io/communityone/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://communityone.gitbook.io/communityone/feature-deepdive/api-integration.md).

# API Integration

### Getting Started

> **Click** [**here**](https://discord.com/oauth2/authorize?client_id=1069423090225918082\&permissions=275146722545\&integration_type=0\&scope=applications.commands+bot\&redirect_uri=https%3A%2F%2Fcommunityone.io%2Fdashboard%2Fbot-auth-complete%2F%3Fsource%3Dgitbook\&response_type=code) **to introduce our bot to your server.**

You can use API to create custom quests or get our analytics data. To get started, go to your **Dashboard => Overview ⇒ API Integration.**&#x20;

If this is your first time, you will see a pop-up where you can request an API key. Otherwise, when you navigate to the API Integration tab, you should see your API key.

<figure><img src="/files/sBSjLYwii4V4v2iF3u9N" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/HuAqIscAOM55zFcGqdgy" alt=""><figcaption></figcaption></figure>

#### Resources & Document <a href="#resources-and-document" id="resources-and-document"></a>

* API Documentation: <https://api.communityone.io/v1/documentation>
  * For custom quests: <https://api.communityone.io/v1/documentation#tag/Custom-Quests>. If you are using Cursor or any AI coding tool, download our openAPI JSON doc and let your AI code for you.
  * For analytics: <https://api.communityone.io/v1/documentation#tag/Analytics>

![](https://communityone.gitbook.io/communityone/~gitbook/image?url=https%3A%2F%2F3533212473-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FMmfBBh2ORXj35Ey5JhNd%252Fuploads%252FDhel9AoIBH1IbrnkgTpV%252Fimage.png%3Falt%3Dmedia%26token%3D32073cd1-48cf-4fe3-8ada-76aebcbb7db8\&width=768\&dpr=4\&quality=100\&sign=528ab1f3\&sv=2)

* Our python SDK is out (Custom Quests Only): <https://pypi.org/project/communityone/>

  * You should be able to integrate your quests with your Discord in 3 lines

  ![](https://communityone.gitbook.io/communityone/~gitbook/image?url=https%3A%2F%2F3533212473-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FMmfBBh2ORXj35Ey5JhNd%252Fuploads%252F7p2Tu3fmgZUXbuFbcDu6%252Fimage.png%3Falt%3Dmedia%26token%3Dd74a65a5-520f-4593-8f93-e29ac4f723f3\&width=768\&dpr=4\&quality=100\&sign=9966bdda\&sv=2)
* Javascript/Typescript SDK: <https://www.npmjs.com/package/communityone>!

#### First, Authentication: <a href="#first-authentication" id="first-authentication"></a>

Every server will be given a unique API key in its configuration dashboard.

You must include the API key directly in the header of every request to the API like this:

Copy

```
{"Authorization": "YOUR_API_KEY"}
```

If authentication fails, the server will receive a 401 Unauthorized response. Unauthorized (401) response:

Copy

```
{"detail": "Invalid API key"}
```

{% hint style="info" %}
Join [Discord](https://discord.gg/nVqt3z78Mw) for questions, comments, and a little gift <img src="https://fonts.gstatic.com/s/e/notoemoji/latest/1f381/512.gif" alt="🎁" data-size="line"> or back to [CommunityOne Home](https://communityone.io/)
{% endhint %}
