Skip to navigation
Agents (Research preview)Knowledge store items

Create a knowledge store item

This method adds an asset to a knowledge store for processing. The operation is asynchronous. The item is created immediately with the queued status and processed in the background.

Asset size limits:

  • Video: Up to 10 GB
  • Images: Up to 32 MB

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Keys page.

Path parameters

knowledge_store_idstringRequired
The unique identifier of the knowledge store.

Request

This endpoint expects an object.
asset_idstringRequired
The unique identifier of the asset to add to the knowledge store.
asset_typeenumOptional
The type of item to create.
Allowed values:
metadatamap from strings to strings or integers or doubles or booleans or lists of stringsOptional

Custom metadata for the item, as user-defined key-value pairs. Up to 50 pairs, keys up to 128 characters, string values up to 8192 characters. Keys are strings; values can be a string, a number, a boolean, or an array of strings. A nested object, an array containing anything other than strings, and a null value are rejected. An integer must fit in 53 bits (-9007199254740991 to 9007199254740991). Send a wider integer, or an identifier that must be preserved verbatim, as a string.

Response headers

LocationstringOptional

The URL of the knowledge store item. Format: /knowledge-stores/{knowledge_store_id}/items/{item_id}.

Response

The item creation request has been accepted and is processing.
asset_typeenum
The type of item.
Allowed values:
_idstringOptional
The unique identifier of the knowledge store item.
asset_idstringOptional
The unique identifier of the source asset.
statusenumOptionalRead-only

The processing status of the item. For the meaning of each value, see the Item statuses section on The knowledge store item object page.

Allowed values:
system_metadataobjectOptionalRead-only

System-generated media metadata for the source asset. Its asset_type field always matches the item's top-level asset_type field.

metadatamap from strings to strings or integers or doubles or booleans or lists of stringsOptional

Custom metadata for the item. Keys are strings; each value is a string, a number, a boolean, or an array of strings.

created_atstringOptionalformat: "date-time"
The date and time when the item was created, in the RFC 3339 format.
updated_atstringOptionalformat: "date-time"
The date and time when the item was last updated, in the RFC 3339 format.

Errors

400
Bad Request Error