retrieval

Upload file for retrieval

Uploads a file of up to 25 MB as multipart form data for managed semantic retrieval. Supported formats are PDF, PNG, JPG/JPEG, GIF, WebP, TXT, Markdown, CSV, JSON, JSONL, YAML, and LOG. The file is processed, chunked, and embedded asynchronously; the entry appears in GET /retrieval/entries once indexing finishes.

Required permission: retrieval.manage.

post/v1/projects/{project_id}/retrieval/file

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/retrieval/file
  • 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

Dot-separated namespace such as docs.api, up to 10 levels. Omit for the default namespace.

entry_idstring nullable

Entry identifier. Uploading again with the same ID and namespace replaces the entry. Defaults to the file name.

Response

Successful Response

job_idstring required

ID of the ingestion job that chunks and indexes the content.

statusstring required

Job status at submission, pending.

entry_idstring required

Entry the content is stored under. Generated when not supplied.

Changes

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