Update Document

Update the content and/or the metadata of a Document

PUT /v1/apps/{app_id}/users/{user_id}/collections/{collection_id}/documents/{document_id}

JavaScript

JavaScript

import Honcho from 'honcho-ai';

const client = new Honcho({
  apiKey: process.env['HONCHO_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const document = await client.apps.users.collections.documents.update(
    'app_id',
    'user_id',
    'collection_id',
    'document_id',
  );

  console.log(document.id);
}

main();

200

{
  "id": "<string>",
  "content": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "collection_id": "<string>",
  "app_id": "<string>",
  "user_id": "<string>",
  "metadata": {}
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

app_id · string · required

ID of the app

user_id · string · required

ID of the user

collection_id · string · required

ID of the collection

document_id · string · required

ID of the document to update

Body

application/json

Updated document parameters

metadata · Metadata · object

content · string | null

Required string length: 1 - 100000

Response

200

application/json

Successful Response

id · string · required

content · string · required

created_at · string<date-time> · required

collection_id · string · required

app_id · string · required

user_id · string · required

metadata · Metadata · object