Documents

Get a document

One document: title, source file name, status (pending, parsing, structuring, embedding, ready, failed), the error if it failed, its one-line summary and section count.

get/documents/{document_id}

Request

  • Base URL: https://app.jitprompt.com
  • URL: https://app.jitprompt.com/documents/{document_id}
  • Auth: HTTP bearer

Path parameters

document_idstring required

Response

Successful Response

idstring uuid required
namespace_idstring uuid required
titlestring nullable required
summarystring nullable required
source_namestring required
status'pending' | 'parsing' | 'structuring' | 'embedding' | 'ready' | 'failed' required
errorstring nullable required
created_atstring date-time required
updated_atstring date-time required
section_countinteger required

Changes

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