Sign in
document

Get Documents

Get one or more documents by external IDs.

get/api/document/

Query parameters

external_idsstring[] required

Headers

workspace-keystring

Response

Successful Response

external_idstring required
workspace_ext_idstring required
file_namestring nullable
statusstring nullable
n_pagesinteger nullable
n_chunksinteger nullable
tokensinteger nullable
file_typestring nullable
file_sizeinteger nullable
storage_typestring nullable
storage_uristring nullable
sharedboolean nullable
re_ocredboolean nullable
config_ext_idstring nullable
created_by_ext_idstring required
updated_by_ext_idstring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

Changed in 6 of the 34 revisions of this API.2112

  • 249354af19dc1See the full diff
    • ○

      added the optional property items/doctags/items/citations to the response with the 200 status

      response-optional-property-added

  • 1c863a2a0ea713See the full diff
    • ●

      removed the optional property items/doc_metadata/anyOf[subschema #1: DocMetadata]/doc_summary from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property items/doc_metadata/anyOf[subschema #1: DocMetadata]/doc_author to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/doc_metadata/anyOf[subschema #1: DocMetadata]/doc_nature to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/doc_metadata/anyOf[subschema #1: DocMetadata]/doc_subject to the response with the 200 status

      response-optional-property-added

  • aa4b06f8dede3See the full diff
    • ○

      added the optional property items/updated_by_ext_id to the response with the 200 status

      response-optional-property-added

    • ○

      the response property items/created_by_ext_id became required for the status 200

      response-property-became-required

    • ○

      response property items/created_by_ext_id list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7073d86523862See the full diff
    • ▲

      removed the required property items/doc_date from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property items/title from the response with the 200 status

      response-required-property-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 11521d46f96b4See the full diff
    • ○

      added the optional property items/doc_metadata to the response with the 200 status

      response-optional-property-added

    • ○

      the response optional property items/doc_date became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      the response property items/doc_date became required for the status 200

      response-property-became-required

    • ○

      the response required property items/title became read-only for the status 200

      response-required-property-became-read-only

  • 05f131dd000a1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog