Skip to content

SourceFinder API

OpenAPI reference for the SourceFinder service.

Base URL

text
https://api.coinpost.ai/sourcefinder

Authentication

Send the API key in the CP-X-API-KEY header.

Example format:

text
CP-X-API-KEY: <your-api-key>

Endpoints

  • GET /health — Health check
  • POST /sources — Submit an asynchronous source-finding job
  • GET /sources/{id} — Get source-finding job status or result
  • POST /entities/extractions — Submit an asynchronous entity extraction job
  • GET /entities/extractions/{id} — Get entity extraction job status or result
  • GET /entities — List aggregated entities observed in recent tasks

Request Notes

  • POST /sources requires at least one of title, content, or source_urls
  • Optional request-level LLM overrides belong under llm
  • collected_at can provide a reference timestamp for incomplete or relative dates
  • Entity extraction is asynchronous because it runs the planner LLM path: call POST /entities/extractions with text, then poll GET /entities/extractions/{id} with the returned job_id
  • Source-finding job IDs and entity extraction job IDs use separate result endpoints

Response Convention

  • Job responses wrap data in a data field; /health returns service metadata directly
  • Error responses return error with a message string
  • Job results include a status field (pending, processing, completed, failed)
  • Completed source-finding results can include primary_sources, original_urls, metrics, and truth_assessment; completed entity extraction results include entities