retrieval

List retrieval entries

Returns paginated retrieval entries. Each entry represents an ingested document or text. Filter by namespace, content_type, or free-text search on the entry ID.

Required permission: retrieval.manage.

get/v1/projects/{project_id}/retrieval/entries

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/retrieval/entries
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

Query parameters

environment_idstring uuid required

Environment ID from GET /environments.

namespacestring nullable

Only entries in this namespace or its child namespaces.

content_typestring nullable

Only entries of this type: text (text uploads and plain-text files), pdf, or image.

searchstring nullable

Case-insensitive match anywhere in the entry ID. % and _ act as wildcards.

limitinteger

Maximum number of entries to return.

offsetinteger

Number of entries to skip.

sort_by'entry' | 'chunks' | 'namespace' | 'created' nullable

Sort key: entry (entry ID), chunks (chunk count), namespace, or created (first ingestion time). Defaults to created.

sort_dir'asc' | 'desc' nullable

Sort direction. Defaults to desc.

Response

Successful Response

totalinteger required

Entries matching the filters across all pages.

Changes

No recorded changes to this operation across all 1 revision of this API.