v2

latestOpenAPI 3.1.02026-07-3171165552.0 KB
Assistant

Query Assistant For Polling

Submit a question to the scite Assistant. Returns a task ID that you poll via GET /api_partner/assistant/tasks/{task_id}.

Required Fields

turns — Conversation History

The conversation history as a list of turn objects. Each turn has a role ("user" or "assistant") and content. For a new conversation, provide a single user turn:

{
  "turns": [{"role": "user", "content": "How does protein structure affect function?"}]
}

For multi-turn conversations, include the full history. Assistant turns should include references, searchStrategy, model, settings, and publicationsConsulted from previous responses.

userInput — Current Question

The current user question (should match the last user turn's content). Used independently for search strategy generation and tool selection.


Reference Behavior Control

FieldTypeDefaultDescription
alwaysUseReferencesboolfalseForce reference retrieval even for non-scientific questions
neverUseReferencesboolfalseSkip reference retrieval entirely (takes precedence over alwaysUseReferences)
numReferencesint25Maximum reference passages to include in LLM context
referenceCheckslist[str][]Celery task IDs from uploaded documents (reference check feature)
searcheslist[str][]Pre-defined search queries (skips auto-generation)

Search Filtering

FieldTypeDefaultDescription
yearFrom / yearTostr or nullnullFilter by date range (4-digit year or ISO date)
topicslist[str][]Filter by research topics
citationSectionslist[str][]Filter citations by paper section: results, discussion, conclusion, methods, introduction
publicationTypeslist[str][]Filter by type: review, systematic review, meta-analysis, practice guideline, journal-article, etc.
journalslist[str][]Filter to specific journal names
openAccessOnlyboolfalseOnly return open access publications
abstractsOnlyboolfalseOnly use paper abstracts (excludes citation statements)
fullTextsOnlyboolfalseOnly use citation statements (excludes abstracts)

Paper Selection

FieldTypeDefaultDescription
doislist[str][]Specific DOIs to scope the search to. DOIs in userInput are auto-extracted and merged.
dashboardslist[int][]Collection (dashboard) IDs to pull DOIs from. Requires authenticated user with access.

Result Ranking — rankBy

Controls how retrieved results are ranked before being passed to the LLM. Default: "all".

ValueRanking Strategy
allBalanced: relevance + total citations + scite index + date + supporting + contrasting
relevanceSemantic relevance only
dateRecency + relevance
citationsTotal citation count + relevance
supporting-citationsSupporting citation count + relevance
contrasting-citationsContrasting citation count + relevance
journal-rankScite journal index + relevance

Response Configuration

FieldTypeDefaultDescription
answerLengthstr"short""short" (~100-200 words), "medium" (comprehensive), or "long" (exhaustive)
modelstr or nullgpt-5-nano-2025-08-07LLM model for response generation (see below)
reasoningEffortstr or nullnull"minimal", "low", "medium", or "high" — only for reasoning models

Available Models

Model IDProviderNotes
claude-sonnet-4-6Anthropic200K context, 64K max output
claude-opus-4-6Anthropic200K context, 128K max output
claude-sonnet-4-5-20250929Anthropic200K context, 64K max output
claude-opus-4-5-20251101Anthropic200K context, 64K max output
claude-haiku-4-5-20251001Anthropic200K context, 64K max output
gpt-5-nano-2025-08-07OpenAIDefault. 400K context. Reasoning model
gpt-5-mini-2025-08-07OpenAI400K context. Reasoning model
gpt-5.2-2025-12-11OpenAI400K context. Reasoning model. Supports reasoningEffort

If one provider fails, the system automatically falls back to the other. Unsupported or retired model strings automatically fall back to the default (gpt-5-nano-2025-08-07).


Structured Response Mode

FieldTypeDefaultDescription
useStructuredResponseboolfalseReturn per-reference structured data instead of prose
jsonResponseTypestr or nullnullnull (full detail), "concise", or "boolean" (yes/no screening)
reprocessTurnIdxint or nullnullIndex of an existing turn to reprocess
columnSlugstr or nullnullSlug of a specific column to reprocess

Patent Modes

FieldTypeDefaultDescription
usePatentModeboolfalseSearch patents only (no academic papers)
useMixedPatentModeboolfalseSearch both patents and academic papers

Session Management

FieldTypeDefaultDescription
sessionIdint or nullnullExisting session ID to continue a conversation

Response

Returns {"id": "<task_id>"}. If the user is rate-limited, also includes "usage": {"used": N, "max": M}.


Examples

Basic single question:

{
  "turns": [{"role": "user", "content": "What is the effect of exercise on depression?"}],
  "userInput": "What is the effect of exercise on depression?"
}

DOI-scoped question:

{
  "turns": [{"role": "user", "content": "Summarize the key findings"}],
  "userInput": "Summarize the key findings",
  "dois": ["10.1002/cepa.3344", "10.1002/hsr2.70931"]
}

Filtered search:

{
  "turns": [{"role": "user", "content": "What do systematic reviews say about mindfulness for anxiety?"}],
  "userInput": "What do systematic reviews say about mindfulness for anxiety?",
  "publicationTypes": ["systematic review", "meta-analysis"],
  "yearFrom": "2020",
  "rankBy": "supporting-citations",
  "answerLength": "long"
}

Structured response (table mode):

{
  "turns": [{"role": "user", "content": "Does each paper support the hypothesis that X causes Y?"}],
  "userInput": "Does each paper support the hypothesis that X causes Y?",
  "useStructuredResponse": true,
  "jsonResponseType": "boolean",
  "dois": ["10.1234/a", "10.1234/b", "10.1234/c"]
}
post/api_partner/assistant/poll

Headers

authorizationstring

Set to Bearer <token> to pass token for authorization.

Set to Bearer <token> to pass token for authorization.

Request body

alwaysUseReferencesboolean
neverUseReferencesboolean
abstractsOnlyboolean
fullTextsOnlyboolean
numReferencesinteger
rankBy'all' | 'relevance' | 'date' | 'citations' | 'supporting-citations' | 'contrasting-citations' | 'journal-rank'
answerLength'short' | 'medium' | 'long'
modelstring nullable
reasoningEffort'minimal' | 'low' | 'medium' | 'high'
citationStyle'apa' | 'ieee' | 'mla' | 'ama' | 'chicago' | 'harvard' | 'vancouver' | 'bibtex'
yearFromstring nullable
yearTostring nullable
topicsstring[]
journalsstring[]
citationSectionsstring[]
publicationTypesstring[]
dashboardsinteger[]
referenceChecksstring[]
doisstring[]
useStructuredResponseboolean
usePatentModeboolean
useMixedPatentModeboolean
sessionIdinteger nullable
userInputstring required
searchesstring[]
openAccessOnlyboolean
jsonResponseType'concise' | 'boolean' nullable
reprocessTurnIdxinteger nullable
columnSlugstring nullable
anonIdstring nullable
recaptchaTokenstring nullable
countrystring nullable
saveSessionboolean

Response

Successful Response

idstring nullable
statusstring nullable
errorstring nullable