Skip to main content
POST
/
sessions
Create session
curl --request POST \
  --url https://app.harmonica.chat/api/v1/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "topic": "<string>",
  "goal": "<string>",
  "context": "<string>",
  "critical": "<string>",
  "prompt": "<string>",
  "template_id": "<string>",
  "questions": [
    {
      "label": "<string>"
    }
  ],
  "cross_pollination": false
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "topic": "<string>",
  "goal": "<string>",
  "status": "active",
  "participant_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "join_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key authentication. Pass your key as a Bearer token. Keys use the format hm_live_<32 hex chars>. Generate keys from your Harmonica dashboard settings.

Body

application/json

Request body for creating a new session.

​
topic
string
required

Session topic / title

​
goal
string
required

What the session aims to achieve

​
context
string

Background context for participants (e.g. SESSION.md from a prior session)

​
critical
string

Critical question or constraint

​
prompt
string

Custom facilitation prompt. If omitted, a default facilitation prompt is used.

​
template_id
string

ID of a template to use

​
questions
object[]

Pre-session questions shown to participants before they join

​
cross_pollination
boolean
default:false

Enable cross-pollination of ideas between participant threads

Response

Session created

Session object returned after creation. Extends SessionListItem with a join URL.

​
id
string<uuid>
required
​
topic
string
required
​
goal
string
required
​
status
enum<string>
required
Available options:
active
​
participant_count
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
join_url
string<uri>
required

Direct URL for participants to join the session