Archive API docs
    Jump to

    Narrow by kind with a prefix — q: queries, m: mutations, t: types, g: guides, f: fields and arguments.

    Jump to examples ↓
    Query

    deepResearchTemplates

    List the Deep Research templates this workspace can run. A template is listed when it runs on at least one DeepResearchInputType kind and states its audienceComments and brandThreads as DeepResearchSupport values.

    Arguments

    Object, input and enum types open in place — use + to reveal their fields. A type that is already open above the row stops at a ↻ circular marker, and anything nested past the depth limit links out to its own page instead.

    inputType DeepResearchInputType
    Only templates that run on this source.

    Returns

    Returns [DeepResearchTemplate!]!.

    audienceComments DeepResearchSupport!
    Whether the report reads the comments under each post (includeComments).
    brandThreads DeepResearchSupport
    For BRAND reports: whether it reads the comment threads on the brands' posts.
    description String
    What the report covers.
    inputTypes [DeepResearchInputType!]!
    The sources this template runs on in this workspace, among the DeepResearchInputType kinds. A template that runs on none of them is not listed.
    name String!
    Display name.
    slug String!
    Template identifier. Pass it as templateSlug to deepResearchQuote and createDeepResearchReport.