Skip to main content
POST
/
create-configuration
Create a Configuration
curl --request POST \
  --url https://api.heify.com/create-configuration \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "tag": "Customer Support - Technical Issues",
  "vocabulary": [
    "firewall",
    "VPN",
    "authentication"
  ],
  "extraction_fields": [
    {
      "name": "ticket_id",
      "type": "string",
      "description": "The support ticket number mentioned in the conversation"
    },
    {
      "name": "issue_resolved",
      "type": "boolean",
      "description": "Whether the technical issue was resolved during the call"
    }
  ],
  "webhooks": {
    "success_url": "https://myservice.com/webhooks/transcription/success",
    "error_url": "https://myservice.com/webhooks/transcription/error"
  },
  "summary": true,
  "summary_language": "en"
}'
{
  "message": "Configuration created successfully",
  "configuration_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
For a detailed explanation of the Configuration and its parameters, please consult the Configuration Object.

Authorizations

x-api-key
string
header
required

Body

application/json
tag
string
required

A descriptive name for the configuration (e.g., "Sales Call Analysis").

Maximum length: 255
vocabulary
string[]

An array of custom words, phrases, or proper nouns to improve recognition accuracy.

extraction_fields
object[]

A list of structured data fields for the AI to extract from the transcript. A maximum of 20 fields can be defined.

Maximum length: 20
webhooks
object

A set of URLs for receiving success or error notifications. Both URLs must be valid HTTPS URLs.

summary
boolean
default:false

If true, a summary of the transcription will be generated.

summary_language
string
default:df

The language for the generated summary. Use "df" for auto-detect. See documentation for supported languages.

analytics_language
string
default:df

The language for analytics processing. Use "df" for auto-detect. See documentation for supported languages.

Response

200 - application/json

Configuration created successfully.

message
string

A confirmation message indicating success.

configuration_id
string<uuid>

The unique identifier (UUID) for the created configuration.