Skip to main content

List all documents from a project​

List all documents from a project

Path Parameters
  • project_id integer required

    ID of the project to get

Query Parameters
  • details string

    Possible values: [segments, meta, tags]

    Which details should return. Values might be any combination of 'segments', 'meta' and 'tags'.

    • segments: Show segments of a document
    • meta: Show all the additional attributes that were originally given as the document was uploaded
    • tags: Show tags of a document
  • search string

    Search by name

  • annotation_id integer

    Filter by annotation ID

  • analysis_id integer

    Filter by analysis ID

  • group_id integer

    Filter by group ID

  • grouped boolean

    If true, return only documents that belong to a group

  • analysed boolean

    If true, return only documents that belong to an analysis

  • offset integer

    An offset is simply the number of records you wish to skip before selecting records.

  • limit integer

    Limit of entries that should be returned.

Responses

OK

Schema
  • documents object

    A document with the segments and tags

  • text string

    The document text

  • segments object[]

    list of segments

  • text string

    The segment text

  • span integer[]

    The interval at which the segment occurs in the original document

  • has_more boolean

    indicates if a new request with a different offset should be done to get more models.

  • offset integer

    An offset is simply the number of records you wish to skip before selecting records.

  • limit integer

    Limit of entries that should be returned.

  • count integer

    Number of objects returned

Loading...