SIJI RESEARCH API
Connect the industry to your research.
One API key, nine research operations. Start with the industry overview or go straight to a company or product you know.
Make your first request
Create an API key and store it in your tool’s secrets or connector settings. Manage API keys →
# Store your API key in a local environment variable.
export SIJI_API_KEY='YOUR_API_KEY'
curl --fail-with-body '<SIJI_ORIGIN>/v1/agent/world/overview' \
-H "X-API-Key: $SIJI_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: my-first-world-overview-001' \
--data '{}'Examples use the current site’s address. Reuse the idempotency key when retrying the same request; use a new key for a new request.
- Explore an industry
overview → changes / graph → facts → evidence- Research a known entity
search_entities → get_entities → graph / facts / evidence
Start with the industry overview
POST /v1/agent/world/overview returns categories, industry positions, companies, products and lightweight relationships. You can start with an empty JSON object.
Free can read this lightweight overview too. It returns the visible industry map in one response, rather than paginating through every fact. If delivery capacity is insufficient, check account usage, wait for capacity to return, or start with a specific company or product.
Choose an entity, retain its type and reference, then continue through the entity, graph, fact and evidence operations.
Follow the Context Memory research case →Nine research operations
| Operation | POST /v1/agent/ | Purpose |
|---|---|---|
get_world_overview | world/overview | Explore companies, products, industry positions and relationships |
search_entities | entities/search | Find entities by name, alias, code or topic |
get_entities | entities/get | Reopen entities from returned references |
list_changes | changes/list | Review recent changes or follow specific entities |
expand_graph | graph/expand | Follow relationships from a known entity |
trace_paths | graph/paths | Trace paths between entities or to a specific entity type |
get_facts | facts/get | Read facts, their states, time scope and references |
get_evidence | evidence/get | Retrieve evidence and sources behind facts and relationships |
compare | compare | Compare specific entities along a shared dimension |
Use each response as your next starting point
- Entities and relationships: Preserve returned types, references and relationship semantics for follow-up requests.
- Facts and evidence: Read each fact alongside its state, time scope, qualifiers and sources.
- Coverage: Keep partial, unknown and conflict states explicit to guide further research.
- Pagination: Reuse the returned cursor with the same request conditions to continue through results.
Authentication, retries and usage
Authenticate with X-API-Key. Store your key in your tool’s secrets or a server-side environment variable.
API keys in one account share its plan and RU allowance. Responses report usage; retry the same request with the same Idempotency-Key. Use a new value for a new request. When a request limit is reached, respect the response’s Retry-After header.
Free includes 300 RU per UTC calendar month. China-market Starter, Pro and Research Pro include 1,500, 6,000 and 20,000 RU per service month; Global-market allowances are 2,000, 6,250 and 18,000 RU. The plans page for your selected billing market is authoritative.
RU measures request usage; DU measures new content first delivered to your account. DU has separate rolling 31-day and 1-hour limits shared by all keys. Reading the same content again does not spend DU again, while a new request may still spend RU. Gift and top-up RU do not raise DU limits.
RESEARCH_DISCLOSURE_VELOCITY_LIMIT means the hourly DU allowance is insufficient; follow Retry-After or request less new content. RESEARCH_DISCLOSURE_QUOTA_EXHAUSTED means the rolling 31-day DU allowance is insufficient. These refusals charge no RU. Error details report required and available DU. If the request exceeds the whole window limit, waiting cannot make the same request fit; narrow its scope or explore a higher plan.
View account RU, DU and recovery windows →
View request rates, concurrency, API-key limits and per-query limits in your account and on the plans page.
Compare plans and pricing →Retrieve a research packet
POST /v1/research supports company, product, industry, compare and changes tasks, delivering structured research in JSON or Markdown.
Use the same X-API-Key and select mode and query for your task.
Work alongside the public web
SIJI provides industry structure, entity identity, relationships, commercial facts and source references. Add public-web research for recent developments and the latest original sources.