Skip to main content
POST
/
dictionaries
/
create-from-file
Create Dictionary From File
curl --request POST \
  --url https://client.camb.ai/apis/dictionaries/create-from-file \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form dictionary_file='@example-file' \
  --form 'dictionary_name=<string>' \
  --form 'dictionary_description=<string>'
{
  "message": "<string>",
  "status": "<string>"
}
What makes this file-based approach particularly valuable is its ability to scale dictionary creation efficiently. Rather than manually entering individual terms one by one, you can prepare comprehensive terminology collections offline using tools your team already knows, then upload complete dictionaries in a single operation. This batch approach becomes essential when working with specialized vocabularies, client-specific terminology, or industry jargon that requires precise handling across multiple audio processing tasks.

​
When to Use This Endpoint

Dictionary creation from files serves multiple strategic purposes in your content processing workflow. During project initialization phases, you might upload industry-specific glossaries that ensure consistent pronunciation of technical terms throughout your audio processing operations. When onboarding new clients, their existing terminology databases can be quickly transformed into CAMB.AI dictionaries that maintain brand consistency and domain expertise across all subsequent processing tasks. The file-based approach excels when you’re working with collaborative teams where subject matter experts can contribute terminology knowledge without needing direct access to the CAMB.AI platform. Rather than recreating extensive vocabulary collections manually, you can preserve existing organizational knowledge by transforming it into CAMB.AI-compatible formats and uploading it as structured dictionary resources.

​
File Format Requirements and Structure

The endpoint accepts both CSV and Excel file formats, providing flexibility for teams that work with different data preparation tools. Understanding the required structure becomes crucial for successful dictionary creation, as the system expects specific column arrangements and data formatting that enable proper term recognition and pronunciation guidance.
Your dictionary file must follow a structured format where each row represents a distinct term or pronunciation rule, and specific columns contain the information necessary for the AI systems to understand how to process that term.

​
Long-term Dictionary Management Considerations

File-based dictionary creation establishes the foundation for ongoing terminology resource management that evolves with your organizational needs and processing experience. Understanding how initial dictionary creation connects to long-term maintenance workflows helps you make strategic decisions about file organization and content structure that support sustainable terminology management practices.

Authorizations

​
x-api-key
string
header
required

The x-api-key is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.

Body

multipart/form-data
​
dictionary_file
file
required

CSV or Excel Sheet Matching the required structure for a dictionary.

​
dictionary_name
string
required

The name of the dictionary to be created. This is mainly used for organizational purposes.

Maximum string length: 100
​
dictionary_description
string | null

The description of the dictionary to be created. This is an optional field that is used to help you provide some info about your dictionaries for better organization.

Maximum string length: 1000

Response

Successful Response

A 201 status code indicates that your dictionary was created successfully and all terminology content from your uploaded file was processed and integrated into the CAMB.AI system. This represents the ideal outcome where file parsing, content validation, and dictionary population all completed without issues, resulting in a fully functional dictionary ready for immediate use across your audio processing tasks.

​
message
string

Human-readable feedback that communicates the outcome of the dictionary operation with actionable context for your application users. This message provides essential information about operation success, partial completion scenarios, or guidance for addressing any issues that occurred during processing.

​
status
string

Standardized operation outcome indicator that enables programmatic response handling across all dictionary management workflows. This status field provides consistent, machine-readable confirmation of operation results, allowing your application logic to branch appropriately between success scenarios, partial completion cases, and error conditions.