SOURCELY API PREVIEW
Enums
Exact accepted and returned values, with a plain-language explanation for each.
Values are case-sensitive. Send and compare these exact strings. Field names use snake_case. The current RelevanceRating values are human-readable labels with spaces; a future naming change must be versioned and is not applied to these examples.
CitationFormat
| Value | Meaning |
|---|---|
apa7 | American Psychological Association, 7th edition. |
mla9 | Modern Language Association, 9th edition. |
ieee | IEEE citation style. |
harvard | Harvard author–date style. |
bibtex | BibTeX bibliography entry. |
EnrichmentLevel
| Value | Meaning |
|---|---|
none | Return source metadata and requested citations without analysis. |
low | Populate relevance only; other analysis fields are null. |
medium | Analyze title/abstract, with local fallback when model analysis is unavailable. |
high | Attempt full-text analysis and final reranking; may fall back to abstract/local analysis. |
Granularity
| Value | Meaning |
|---|---|
document | Find sources for the complete input. |
claim | Identify claims and find sources for the selected claims. |
JobStatus
| Value | Meaning |
|---|---|
queued | Accepted and waiting to start. |
running | Search work is in progress. |
partial | Some results may be usable while other requested work remains. The current worker does not publish intermediate track progress. |
completed | The search finished. Inspect tracks and searched flags for per-claim coverage. |
failed | The search failed. HTTP 200 on a status read does not imply search success. |
PaperTypeFilter
| Value | Meaning |
|---|---|
research | Research papers. |
review | Review papers and related review classifications. |
RelevanceRating
| Value | Meaning |
|---|---|
Perfectly Relevant | Strongest relevance label. |
Relevant | Relevant to the research text. |
Somewhat Relevant | Partially relevant to the research text. |
Not Relevant | Not considered relevant to the research text. |
SearchMode
| Value | Meaning |
|---|---|
quick | One Google Scholar page per keyword, Semantic Scholar as fallback, provider order kept. |
deep | Wide retrieval from Semantic Scholar and three Scholar pages per keyword, a model-chosen shortlist of 15, full-text analysis and a final rerank. |
TrackStatus
| Value | Meaning |
|---|---|
pending | This track has not started; an unsearched claim may stay pending. |
running | Work on this track is in progress. |
done | This track finished. |
failed | This track failed; inspect its error when available. |
Webhook events belong to a later release and are not part of these two endpoints.