GET
/
dictionaries
/
{dictionary_id}
/
full-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

200
application/json

Successful Response

The response is of type object.