Vocabularies

Submit Custom Vocabulary

Submits a Custom Vocabulary for asynchronous processing.

SecurityAccessToken

Request

Request Body schema: application/json

Custom Vocabulary Definition

metadata	string or null <= 512 characters Optional metadata that was provided during submission
callback_url	string or null <= 1024 characters Deprecated Deprecated. Use notification_config instead. Optional callback url to invoke when processing is complete. If this parameter is used to pass in the callback url, the callback url will be visible in the response. It is recommended to provide webhooks with the `notification_config` parameter as authorization headers can be included and both the callback url and auth headers will be encrypted when stored.
	object or null Optional configuration for a callback url to invoke when processing is complete, in addition to auth headers if they are needed to invoke the callback url. Cannot be set if `callback_url` is set. This option will not be visible in the submission response.
strict	boolean If true, only exact phrases will be used as custom vocabulary, i.e. phrases will not be split into individual words for processing. By default is enabled.
required	Array of objects [ 1 .. 50 ] items

Responses

200

Custom Vocabulary Job Details

400

Bad Request

401

Request Unauthorized

403

User does not have permission to access this deployment

404

Deployment does not support this API

post/vocabularies

Request samples

application/json

{"metadata": "example metadata",
"notification_config": {"url": "https://www.example.com/callback",
"auth_headers": {"Authorization": "Bearer <token>"
}
},
"custom_vocabularies": [{"phrases": ["Paul McCartney",
"Amelia Earhart",
"Weiss-Bergman",
"BLM"
]
}
]
}

Response samples

200
400
401
403
404

application/json

{"id": "cvUmx5c6F7pH7r",
"status": "in_progress",
"created_on": "2018-05-05T23:23:22.29Z",
"callback_url": "https://www.example.com/callback"
}

Get List of Custom Vocabularies

Gets a list of most recent custom vocabularies' processing information

SecurityAccessToken

Request

query Parameters

limit

integer [ 0 .. 1000 ]

Limits the number of custom vocabulary details returned, default is 100, max is 1000

Responses

200

List of Custom Vocabularies' Processing Details

400

Bad Request

401

Request Unauthorized

403

User does not have permission to access this deployment

404

Deployment does not support this API

get/vocabularies

Request samples

Response samples

200
400
401
403
404

application/json

[{"id": "cvUmx5c6F7pH7r",
"status": "in_progress",
"created_on": "2018-05-05T23:23:22.29Z",
"callback_url": "https://www.example.com/callback"
},
{"id": "cvx5c6F7pcvUmH",
"status": "complete",
"created_on": "2018-05-05T23:23:22.29Z",
"completed_on": "2018-05-05T23:45:13.41Z",
"callback_url": "https://www.example.com/callback"
},
{"id": "cv6F7aspH7rUmx",
"status": "failed",
"created_on": "2018-05-05T23:23:22.29Z",
"completed_on": "2018-05-05T23:23:24.11Z",
"failure": "internal_processing",
"failure_detail": "Internal processing failure"
}
]

Get Custom Vocabulary

Gets the custom vocabulary processing information

SecurityAccessToken

Request

path Parameters

id

required

string

Id of a custom vocabulary

Responses

200

Custom Vocabulary Job Details

401

Request Unauthorized

403

User does not have permission to access this deployment

404

Custom Vocabulary Not Found

get/vocabularies/{id}

Request samples

Response samples

200
401
403
404

application/json

{"id": "cvUmx5c6F7pH7r",
"status": "in_progress",
"created_on": "2018-05-05T23:23:22.29Z",
"callback_url": "https://www.example.com/callback"
}

Delete Custom Vocabulary

Deletes a custom vocabulary. All data related to the custom vocabulary, such as webhooks and metadata, will be permanently deleted. A custom vocabulary can only be deleted once it's completed (either with success or failure).

SecurityAccessToken

Request

path Parameters

id

required

string

Id of a custom vocabulary

Responses

204

Custom vocabulary was successfully deleted

401

Request Unauthorized

403

User does not have permission to access this deployment

404

Custom Vocabulary Not Found

409

Invalid Deletion State

delete/vocabularies/{id}

Request samples

Response samples

401
403
404
409

application/problem+json

{"title": "Authorization has been denied for this request",
"status": 401
}