Create dictionary entry — Brigg developers

Access & visibility

Allow meetings.CreateDictionaryEntry on your API key. Resource read permissions: core:DictionaryEntry. Resource write permissions: core:DictionaryEntry.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

dataDictionaryEntryRequired

The record's fields.

DictionaryEntry

Recognition vocabulary3 fields

phrasestringRequired

Correct spelling of the name or term to recognize.

sounds_likearray of stringOptional

Alternative phonetic spellings used to recognize the phrase in speech.

languagestringOptional

Recognition language code, for example en for English or no for Norwegian. Omit when the term is not tied to a language. This field is an open string, not a closed enum.

privatebooleanOptional

Defaults to false: the record is shared with the workspace. True assigns private ownership to the approved acting member and requires member delegation. This is independent of created_by provenance.

Choose ownership deliberately

Omitting private, or setting it to false, creates a workspace-shared record. Set private: true to create a record owned by the approved acting member. Private records require member delegation; a workspace-only credential cannot own a personal record. The credential’s exact resource grants authorize the write; private ownership and project membership remain enforced.

A create is a new record, not an upsert. Reuse the same idempotency key only for retries of that logical creation. For recurring synchronization, use the resource’s upsert operation when available: it matches a permanent external reference. Otherwise keep the returned record ID and use the corresponding update operation for subsequent changes.

Response

Returns 200 OK with a JSON body.

Record metadata sits outside data. Timestamps created_at and updated_at are Unix milliseconds. Optional business fields may be absent; absence does not mean false or zero. A field accepts null only when its type includes null.

Dictionary entries help meeting transcription recognize names and specialist terms. phrase is the spelling to keep; sounds_like supplies alternative pronunciations. Editing the dictionary does not rewrite previously saved transcripts.

itemDictionaryEntryRecordRequired

The requested record, including its metadata and data fields.

DictionaryEntryRecord

idstringRequired

Stable core:DictionaryEntry record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited.

created_atnumberRequired

Time the record was created, in Unix milliseconds.

updated_atnumberRequired

Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads.

created_bystring or nullRequired

Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID.

privatebooleanRequired

True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules.

dataDictionaryEntryRequired

The record's fields.

DictionaryEntry

Recognition vocabulary3 fields

phrasestringRequired

Correct spelling of the name or term to recognize.

sounds_likearray of stringOptional

Alternative phonetic spellings used to recognize the phrase in speech.

languagestringOptional

Recognition language code, for example en for English or no for Norwegian. Omit when the term is not tied to a language. This field is an open string, not a closed enum.

Errors & retries

Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying. Reuse the original Idempotency-Key.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "phrase": {
          "type": "string",
          "description": "Correct spelling of the name or term to recognize."
        },
        "sounds_like": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Alternative phonetic spellings used to recognize the phrase in speech."
        },
        "language": {
          "type": "string",
          "description": "Recognition language code, for example en for English or no for Norwegian. Omit when the term is not tied to a language. This field is an open string, not a closed enum."
        }
      },
      "required": [
        "phrase"
      ],
      "additionalProperties": false,
      "description": "The record's fields.",
      "title": "DictionaryEntry"
    },
    "private": {
      "type": "boolean",
      "description": "Defaults to false: the record is shared with the workspace. True assigns private ownership to the approved acting member and requires member delegation. This is independent of created_by provenance."
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "data": {
        "phrase": "Northstar",
        "sounds_like": [
          "north star"
        ],
        "language": "en"
      }
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "item": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable core:DictionaryEntry record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited."
        },
        "created_at": {
          "type": "number",
          "description": "Time the record was created, in Unix milliseconds."
        },
        "updated_at": {
          "type": "number",
          "description": "Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads."
        },
        "created_by": {
          "type": [
            "string",
            "null"
          ],
          "description": "Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID."
        },
        "private": {
          "type": "boolean",
          "description": "True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules."
        },
        "data": {
          "type": "object",
          "properties": {
            "phrase": {
              "type": "string",
              "description": "Correct spelling of the name or term to recognize."
            },
            "sounds_like": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Alternative phonetic spellings used to recognize the phrase in speech."
            },
            "language": {
              "type": "string",
              "description": "Recognition language code, for example en for English or no for Norwegian. Omit when the term is not tied to a language. This field is an open string, not a closed enum."
            }
          },
          "required": [
            "phrase"
          ],
          "additionalProperties": false,
          "description": "The record's fields.",
          "title": "DictionaryEntry"
        }
      },
      "required": [
        "id",
        "created_at",
        "updated_at",
        "created_by",
        "private",
        "data"
      ],
      "additionalProperties": false,
      "description": "The requested record, including its metadata and data fields.",
      "title": "DictionaryEntryRecord"
    }
  },
  "required": [
    "item"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "item": {
        "id": "e_dictionaryentry_example",
        "created_at": 1791276900000,
        "updated_at": 1791280800000,
        "created_by": "a_jamie",
        "private": false,
        "data": {
          "phrase": "Northstar",
          "sounds_like": [
            "north star"
          ],
          "language": "en"
        }
      }
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/meetings.CreateDictionaryEntry' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "data": {
    "phrase": "Northstar",
    "sounds_like": [
      "north star"
    ],
    "language": "en"
  }
}'

TypeScript

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/meetings.CreateDictionaryEntry", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "data": {
      "phrase": "Northstar",
      "sounds_like": [
        "north star"
      ],
      "language": "en"
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "data": {
    "phrase": "Northstar",
    "sounds_like": [
      "north star"
    ],
    "language": "en"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/meetings.CreateDictionaryEntry",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/meetings.CreateDictionaryEntry' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "data": {
    "phrase": "Northstar",
    "sounds_like": [
      "north star"
    ],
    "language": "en"
  }
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/meetings.CreateDictionaryEntry", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "data": {
      "phrase": "Northstar",
      "sounds_like": [
        "north star"
      ],
      "language": "en"
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "data": {
    "phrase": "Northstar",
    "sounds_like": [
      "north star"
    ],
    "language": "en"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/meetings.CreateDictionaryEntry",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "item": {
    "id": "e_dictionaryentry_example",
    "created_at": 1791276900000,
    "updated_at": 1791280800000,
    "created_by": "a_jamie",
    "private": false,
    "data": {
      "phrase": "Northstar",
      "sounds_like": [
        "north star"
      ],
      "language": "en"
    }
  }
}

Illustrative values, not a live response.