Skip to main content

DocumentListResponse

documents object[]required
  • Array [
  • auto_tags object[]
  • Array [
  • applied_at object
    anyOf
    string
    confidence_score object
    anyOf
    number
    extracted_valueExtracted Valuerequired
    Example: Jane Doe
    nameNamerequired
    Example: Executives
    tag_type object
    anyOf
    string
    property name*any
  • ]
  • character_count object
    anyOf
    integer
    communication_type object
    anyOf
    string
    company object
    anyOf
    string
    content object

    Full text; omitted by list endpoints in light mode.

    anyOf
    string
    content_type object
    anyOf
    string
    created_at object
    anyOf
    string
    executive object

    Executive the document is attributed to.

    anyOf
    string
    extracted_at object
    anyOf
    string
    extracted_date object

    When the content was published, as extracted.

    anyOf
    string
    idIdrequired
    Example: c0a8e2f4-1b7d-4e2a-8c9f-5d6e7a8b9c01
    is_narrative_testing_upload object
    anyOf
    boolean
    media_provenance object

    owned, earned or paid.

    anyOf
    string
    processing_status object

    fetching or enhancing while ingestion runs, failed on error, null when done.

    anyOf
    string
    source_url object
    anyOf
    string
    tagsstring[]
    titleTitlerequired
    Example: Acme Q3 earnings call transcript
    updated_at object
    anyOf
    string
    url object
    anyOf
    string
    word_count object
    anyOf
    integer
    workspace_idWorkspace Idrequired
    property name*any
  • ]
  • pagination objectrequired
    pagePagerequired

    Page number, 1-based.

    per_pagePer Pagerequired

    Items per page.

    total_countTotal Countrequired

    Items across all pages.

    total_pagesTotal Pagesrequired
    property name*any
    property name*any
    DocumentListResponse
    {
    "documents": [
    {
    "auto_tags": [
    {
    "applied_at": "string",
    "confidence_score": 0,
    "extracted_value": "Jane Doe",
    "name": "Executives",
    "tag_type": "string"
    }
    ],
    "character_count": 0,
    "communication_type": "string",
    "company": "string",
    "content": "string",
    "content_type": "transcript",
    "created_at": "string",
    "executive": "string",
    "extracted_at": "string",
    "extracted_date": "string",
    "id": "c0a8e2f4-1b7d-4e2a-8c9f-5d6e7a8b9c01",
    "is_narrative_testing_upload": true,
    "media_provenance": "string",
    "processing_status": "string",
    "source_url": "https://investors.example.com/q3-call",
    "tags": [
    "string"
    ],
    "title": "Acme Q3 earnings call transcript",
    "updated_at": "string",
    "url": "string",
    "word_count": 4210,
    "workspace_id": "string"
    }
    ],
    "pagination": {
    "page": 0,
    "per_page": 0,
    "total_count": 0,
    "total_pages": 0
    }
    }