Skip to main content
GET
/
dictionaries
/
{dictionary_id}
/
full-details
Get Dictionary Details
curl --request GET \
  --url https://client.camb.ai/apis/dictionaries/{dictionary_id}/full-details \
  --header 'x-api-key: <api-key>'
{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "dictionary_terms": {
    "translation": "<string>",
    "language": 1
  }
}

​
Overview

This endpoint provides you with complete access to a dictionary’s content, returning detailed information about the dictionary itself along with all its terms and definitions. Think of this as opening up a physical dictionary and having access to browse through all its entries, but with the added convenience of being able to search for specific terms or limit how many results you see at once.

​
Understanding Dictionary Details

When you request full details for a dictionary, you’re essentially asking the system to compile a comprehensive view that includes both the dictionary’s metadata (information about the dictionary itself) and its complete content. This content consists of all the dictionary’s terms along with their corresponding translations or definitions. Think of it as getting both the book’s cover information and all the pages inside, delivered together in one complete package. This comprehensive approach is particularly valuable when you’re building multilingual applications, translation tools, or terminology management systems where you need access to both the source terms and their translated equivalents. The full details endpoint delivers this rich content in a structured format that makes it easy to work with term-translation pairs programmatically. The “full details” approach means you get everything in one request rather than having to make separate calls for dictionary information and then additional calls for each term and its translations. This design helps reduce the number of API calls your application needs to make, which improves performance and simplifies your code while giving you complete access to the dictionary’s linguistic content.

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.

Path Parameters

​
dictionary_id
integer
required

This parameter tells the API exactly which dictionary you're interested in. Each dictionary in the system has a unique numerical ID that serves as its primary identifier.

Query Parameters

​
limit
integer | null

Limit how many terms are returned when fetching the dictionary details. You can specify exactly how many terms you want to see. For example, setting limit=50 will return only the first 50 terms from the dictionary. This is especially useful for implementing pagination in user interfaces or when you only need a sample of the dictionary's content.

​
search_term
string | null

When you provide a search term, the API acts like a search function within the dictionary. Rather than returning all terms, it will filter the results to show only those terms that match or contain your search string. This transforms the endpoint from a 'show me everything' request into a 'show me what I'm looking for' request, making it much more efficient when you're looking for specific terminology.

Response

Successful Response

​
id
integer

The Dictionary's Unique Identifier. This integer value serves as the dictionary's permanent address in the system. Once assigned, this ID never changes - It's how the system definitively identifies this particular collection of terms.

​
name
string

The Dictionary's Display Name. This string contains the human-readable name that identifies the dictionary to users. Unlike the ID, which is purely functional, the name is designed to be meaningful to people who are choosing which dictionary to work with.

​
description
string | null

Detailed Dictionary Information. This optional field can contain a longer explanation of what the dictionary covers, its intended audience, or special characteristics that set it apart from other dictionaries. The description might explain the scope of terms included, the expertise level assumed, or specific domains covered.

​
created_at
string<date-time>

Dictionary Creation Timestamp. This date-time value tells you exactly when someone first created this dictionary in the system. Understanding creation dates helps you gauge how established a dictionary is and can be useful for administrative purposes, auditing, or simply satisfying curiosity about a dictionary's history. The timestamp includes both date and time information, giving you precise historical context.

​
updated_at
string<date-time>

Last Modification Timestamp. Perhaps one of the most practically useful pieces of metadata, this timestamp shows when someone last made changes to the dictionary. This could mean adding new terms, modifying existing definitions, updating the dictionary's name or description, or any other modification. For applications where content freshness matters, this timestamp helps you and your users understand how current the dictionary's information might be.

​
dictionary_terms
TermTranslation · object

Represents a single translation of a term into a specific target language. Each object contains the translated text along with its corresponding language identifier, enabling multilingual term management and localization workflows.