GET
/
dictionaries
/
{dictionary_id}
curl --request GET \
  --url https://client.camb.ai/apis/dictionaries/{dictionary_id} \
  --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"
}

​
Overview

Think of this endpoint as looking at the cover and introduction of a book before deciding whether to read the entire thing. When you need to understand what a dictionary contains and when it was created or last modified, but don’t need to see all its terms and definitions, this endpoint provides exactly that focused information. This summary approach serves a fundamentally different purpose than retrieving full dictionary details. While the full details endpoint gives you everything including all terms and definitions, this summary endpoint focuses exclusively on the dictionary’s identifying characteristics and metadata. This distinction becomes important when you’re building applications that need to display dictionary information efficiently or when you’re working with multiple dictionaries and need to present them in lists or selection interfaces.

​
Understanding Dictionary Metadata

Every dictionary in the system carries essential information about itself, separate from the actual terms and definitions it contains. This metadata tells the story of the dictionary: what it’s called, what it’s intended for, when it was created, and when someone last made changes to it. Understanding this information helps you and your users make informed decisions about which dictionaries to work with and whether the content might be current for your needs. The metadata approach also supports better application architecture. Instead of loading potentially thousands of dictionary terms just to show a user what dictionaries are available, you can quickly retrieve just the summary information for multiple dictionaries, creating responsive user interfaces that load quickly and provide clear choices.

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.

Response

200
application/json

Successful Response

The response is of type object.