Skip to main content
POST
/
sessions
/
{id}
/
scratchpad
Seed or update scratchpad
curl --request POST \
  --url https://app.harmonica.chat/api/v1/sessions/{id}/scratchpad \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "mode": "seed"
}'
{
  "status": "completed",
  "themes": 123,
  "participants": 123,
  "batches_processed": 123,
  "batches_total": 123
}

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.

Path Parameters

​
id
string<uuid>
required

Session ID

Body

application/json
​
mode
enum<string>
default:seed

Processing mode

Available options:
seed,
update,
status

Response

Scratchpad result

​
status
enum<string>
required

completed — all messages processed. partial — timed out, call again to continue. no_data — no user messages in session. exists/empty — status mode response.

Available options:
completed,
partial,
no_data,
exists,
empty
​
themes
integer
required

Number of themes identified

​
participants
integer
required

Number of participants tracked

​
batches_processed
integer

Batches completed in this call

​
batches_total
integer

Total batches needed for remaining messages