# ai_index_orgs_users_documents_update

Update a specific document embedding.

This endpoint allows updating various properties of a document embedding,
including its name, type, pathway, and training status.

Args:
    request: The HTTP request containing the updated document data.
    org: Organization key identifier.
    document_id: The ID of the document embedding to update.

Returns:
    Response: The updated document embedding information.

Raises:
    BadRequest: If the provided data is invalid.
    NotFound: If the specified document embedding does not exist.

Endpoint: PUT /api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/
Version: 3.59.0-ai-plus
Security: PlatformApiKeyAuthentication

## Path parameters:

  - `document_id` (string, required)

  - `org` (string, required)

  - `user_id` (string, required)

## Request fields (multipart/form-data):

  - `document_name` (string)
    The name of the document

  - `document_type` (string)
    The type of the document

  - `pathway` (string, required)
    The pathway to retrain the document in

  - `url` (string)
    The url of the document

  - `train` (boolean)
    The type of the document

  - `crawler_max_depth` (integer)
    The max depth of the crawler

  - `crawler_max_pages_limit` (integer)
    The max pages limit of the crawler

  - `crawler_max_concurrency` (integer)
    The max concurrency of the crawler

  - `crawler_match_patterns` (array)
    The patterns that the crawler should use to match urls. Patterns may be a glob pattern or a full regex pattern. Indicate the specified type in .

  - `crawler_use_glob_matching` (boolean)
    Whether to use glob patterns for the crawler

  - `access` (string)
    The access of the document.

*  - Public
*  - Private
    Enum: "public", "private"

  - `google_drive_auth_data` (any)
    Authentication and scoped details of google drive.

  - `dropbox_auth_data` (any)
    Authentication and scoped details of dropbox

## Response 200 fields (application/json):

  - `id` (integer, required)

  - `metadata` (any,null)

  - `document_name` (string,null)

  - `document_type` (string,null)

  - `training_status` (any,null)

  - `pathway` (string, required)

  - `url` (string,null)

  - `tokens` (integer,null)

  - `platform_key` (string, required)

  - `is_trained` (boolean)

  - `access` (any,null)

  - `crawler_max_depth` (integer,null)

  - `crawler_max_pages_limit` (integer,null)

  - `crawler_max_concurrency` (integer,null)

  - `crawler_match_patterns` (any)
    List of patterns that the crawler should use to match urls. 
        Patterns may be a glob pattern or a full regex pattern. 
        Indicate the specified type in .

  - `crawler_use_glob_matching` (boolean)