PUT /v1/documents/{id}/

Request

Base URL
https://api.ai.sakura.ad.jp
Auth
HTTP bearer
TypeScript
https://skmtc.dev/sakura/apis/sakura-ai-engine-rag-api/docs/v1/documents/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

A UUID string identifying this document.

Request body

idstring uuid required

created_atstring date-time required

status'pending' | 'processing' | 'available' | 'deleted' | 'error' required

pending - Pending
processing - Processing
available - Available
deleted - Deleted
error - Error

namestring required

modelstring required

chunk_sizeinteger required

chunk_countinteger required

tagsstring[]

contentstring required

error_messagestring required

Response

idstring uuid required

created_atstring date-time required

status'pending' | 'processing' | 'available' | 'deleted' | 'error' required

pending - Pending
processing - Processing
available - Available
deleted - Deleted
error - Error

namestring required

modelstring required

chunk_sizeinteger required

chunk_countinteger required

tagsstring[]

contentstring required

error_messagestring required

Changes

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