🐇Quick Start

1. Get your API key

Your API requests are authenticated using API keys.

Any request that doesn't include an API key will return an error.

ListenUp! API keys should be passed in the Authorization HTTP header in this format:

Bearer <your-api-key>

You can generate an API key in ListenUp! from Settings -> Integrations -> ListenUp! API -> Generate API Key

To initiate the generation of an API key for your organization, please click on "Connect".

Ensure to save your API key in a secure location (you won't be able to view it again for security reasons), and refrain from sharing it with anyone outside of your organization!

2. List all your organization's spaces

First, let's list all of your organization's spaces so that we can retrieve the spaceId we need to later create a text capture.

GET https://api.listenup.ai/v1/spaces

200 Success

{
  "spaces": [
    {
      "id": 7189,
      "name": "My Main Space",
      "created_at": "2024-03-19T10:05:30.584978+01:00"
    },
    {
      "id": 7190,
      "name": "My Secondary Space",
      "created_at": "2024-03-20T10:05:30.584978+01:00"
    },
  ]
}

3. Create a text capture in a specific space

Now that we have all our organizational spaces available, let's create a text capture in one of them!

POST https://api.listenup.ai/v1/spaces/{spaceId}/captures/text

Request Body

Name	Type	Description	Required?
title	string	The name of the capture
source	string	The source of the capture. (can be customized) For instance, you could use "in-app-feedback". If left empty, it will default to "listenupAPI".
text_blocs	object array	The array of blocs you capture will contain (e.g. Speaker 1: blabla, Speaker 2: blablabla ..) 70% of the time you only need one big bloc Each bloc should be in the following format: { body: string, person?: { email?: string } } The body can be plain text or HTML string For instance: <p>hello <strong>there!</strong></p> ListenUp! will automatically attempt to map the bloc to an existing member or user of your space using the provided person information (email ..), or create a new user if none exists. If no user is set, no automatic linking of user or member will occur.

200 capture successfully created

{
  "capture": {
    "id": 37603,
    "title": "Feedback from Annette",
    "capture_source": "listenupAPI",
    "created_at": "2024-05-05T01:42:50.930885+02:00"
  }
}