Browse the api reference

Get Document

get/v1/graphs/{graph_id}/documents/{document_id}

Part of Documents.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
graph_idrequiredstringGraph Id
document_idrequiredstringDocument Id

Example request

curl
curl -X GET "https://api.robosystems.ai/v1/graphs/{graph_id}/documents/{document_id}" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY"

Responses

200 Successful Response

FieldTypeDescription
idrequiredstring
graph_idrequiredstring
user_idrequiredstring
titlerequiredstring
contentrequiredstring
tagsoptionalstring[]
folderoptionalstring
external_idoptionalstring
source_typerequiredstring
source_provideroptionalstring
sections_indexedrequiredinteger
fileoptionalDocumentFileInfo

The stored file, for a document that is one; its content is empty. Download it from GET /documents/{document_id}/file.

DocumentFileInfo fields
FieldTypeDescription
file_namerequiredstring

The file's name as uploaded.

content_typerequiredstring

The file's media type.

size_bytesrequiredinteger

The stored file's size.

sha256requiredstring

Hex SHA-256 of the stored bytes, taken when the upload completed. A stored file never changes, so this identifies it.

evidence_foroptionalDocumentEvidence[]

The live events that name this document as their evidence (an invoice, a bill, a statement balance), newest first, at most 50. While any are listed, the document cannot be deleted.

DocumentEvidence fields
FieldTypeDescription
event_idrequiredstring
event_typerequiredstring
statusrequiredstring
occurred_atrequiredstring
created_atrequiredstring
updated_atrequiredstring
StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
422Validation Error
429Rate limit exceeded
500Internal server error