Sign in
/datastores/{id}/documents

Get Document Metadata

Get details of a given document, including its name and ingestion job status.

get/datastores/{datastore_id}/documents/{document_id}/metadata

Path parameters

datastore_idstring uuid required

Datastore ID of the datastore from which to retrieve the document

Datastore ID of the datastore from which to retrieve the document

document_idstring uuid required

Document ID of the document to retrieve details for

Document ID of the document to retrieve details for

Response

Successful Response

custom_metadataobject

Custom metadata for the document, provided by the user at ingestion time.Must be a JSON-serializable dictionary with string keys and simple primitive values (str, int, float, bool). The total size must not exceed 2 KB.The strings with date format must stay in date format or be avodied if not in date format.The 'custom_metadata.url' field is automatically included in returned attributions during query time, if provided.The default maximum metadata fields that can be used is 15, contact support if more is needed.

custom_metadata_configobject

A dictionary mapping metadata field names to the configuration to use for each field. If a metadata field is not present in the dictionary, the default configuration will be used. If the dictionary is not provided, metadata will be added in context for rerank and generation but will not be returned back to the user in retrievals in query API. Limits: - Maximum characters per metadata field (for prompt or rerank): 400 - Maximum number of metadata fields (for prompt or retrieval): 10 Contact support@contextual.ai to request quota increases.

idstring uuid required

ID of the document that was ingested

namestring required

User specified name of the document

status'pending' | 'processing' | 'retrying' | 'completed' | 'failed' | 'cancelled' required
created_atstring required

Timestamp of when the document was created in ISO format.

updated_atstring

Timestamp of when the document was modified in ISO format.

ingestion_configobject

Ingestion configuration for the document when the document was ingested. It may be different from the current datastore configuration.

has_accessboolean

Whether the user has access to this document.

Changes

Changed in 4 of the 21 revisions of this API.168

  • c8152db455001See the full diff
    • ▲

      response property custom_metadata/additionalProperties/ list-of-types was widened by adding types array to media type application/json of response 200

      response-property-list-of-types-widened

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

  • db7245c747723See the full diff
    • ○

      added the optional property custom_metadata_config to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property has_access to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property ingestion_config to the response with the 200 status

      response-optional-property-added

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

  • 17bdb8a33fb42See the full diff
    • ○

      api tag /datastores/{id}/documents added

      api-tag-added

    • ○

      api tag /datastores removed

      api-tag-removed

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

  • 5298551c424b63See the full diff
    • ●

      added the new cancelled enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new completed enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new failed enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new pending enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new processing enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new retrying enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property custom_metadata to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property updated_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property created_at to the response with the 200 status

      response-required-property-added

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