curl --request POST \
--url https://api.heify.com/create-participant \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"tag": "juan pedro",
"metadata": {
"role": "manager",
"language": "español",
"empresa": "leroy"
}
}
'{
"data": {
"message": "Participant created successfully",
"participant": {
"participant_id": "1f77a5f5-ac38-42c6-999d-45f02d11d121",
"tag": "juan pedro",
"metadata": {
"role": "manager",
"language": "español",
"empresa": "leroy"
},
"created_at": "2026-03-21T13:23:18.069124+00:00",
"updated_at": "2026-03-21T13:23:18.088360+00:00"
}
}
}Participants
Create Participant
Create a new participant profile to track a person across transcriptions — a support agent, salesperson, trainee, or any individual.
POST
/
create-participant
curl --request POST \
--url https://api.heify.com/create-participant \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"tag": "juan pedro",
"metadata": {
"role": "manager",
"language": "español",
"empresa": "leroy"
}
}
'{
"data": {
"message": "Participant created successfully",
"participant": {
"participant_id": "1f77a5f5-ac38-42c6-999d-45f02d11d121",
"tag": "juan pedro",
"metadata": {
"role": "manager",
"language": "español",
"empresa": "leroy"
},
"created_at": "2026-03-21T13:23:18.069124+00:00",
"updated_at": "2026-03-21T13:23:18.088360+00:00"
}
}
}For the full Participant data model, see Participant.
tag is trimmed of leading and trailing whitespace automatically.metadata values are always stored as strings, regardless of the input type. See Participant — metadata.Each account is limited to 200 participants. Returns
400 if the limit is reached.Authorizations
Body
application/json
Response
201 - application/json
Participant created successfully.
Show child attributes
Show child attributes