Update document file

PATCH

/v1/convai/knowledge-base/:documentation_id/update-file

PATCH

/v1/convai/knowledge-base/:documentation_id/update-file

$ curl -X PATCH https://api.elevenlabs.io/v1/convai/knowledge-base/21m00Tcm4TlvDq8ikWAM/update-file \
>      -H "Content-Type: multipart/form-data" \
>      -F file=@SGVsbG8gV29ybGQ=

1 {
2   "type": "url",
3   "access_info": {
4     "is_creator": true,
5     "creator_name": "John Doe",
6     "creator_email": "john.doe@example.com",
7     "role": "admin",
8     "anonymous_access_level_override": "admin",
9     "access_source": "creator"
10   },
11   "extracted_inner_html": "<p>Project Plan for Q3 2024 outlining milestones and deliverables.</p>",
12   "id": "21m00Tcm4TlvDq8ikWAM",
13   "metadata": {
14     "created_at_unix_secs": 1688208000,
15     "last_updated_at_unix_secs": 1719744000,
16     "size_bytes": 245760
17   },
18   "name": "Project Plan Q3 2024",
19   "supported_usages": [
20     "prompt"
21   ],
22   "url": "https://docs.example.com/project-plan-q3-2024.pdf",
23   "auto_sync_info": {
24     "minimum_frequency_days": 7,
25     "auto_remove": true,
26     "consec_failures": 0,
27     "next_refresh_by": 1720339200
28   },
29   "folder_parent_id": "folder_9X7b2LkPq3",
30   "folder_path": [
31     {
32       "id": "folder_root",
33       "name": "Corporate Documents"
34     }
35   ]
36 }

Update the source file of a file document. The document name, content, and metadata are updated to reflect the new file. Any manual content edits will be overwritten.

Path parameters

documentation_idstringRequired

The id of a document from the knowledge base. This is returned on document addition.

Request

This endpoint expects a multipart form containing a file.

filefileRequired

Documentation that the agent will have access to in order to interact with users.

Response

Successful Response

urlobject

fileobject

textobject

folderobject

Errors

422

Document Update File Request Unprocessable Entity Error

Path parameters

Headers

Request

Response

Errors