canonical: https://jentic.com/apis/coldstate.ai/coldstate # ColdState API The ColdState API retrieves knowledge deterministically from a global knowledge base of 48 million entries across 35 domains, with fetch, cite, and verify primitives so an answer can be traced to a stable entry id and checked against a snapshot. The same query against the same snapshot returns identical results, and a verify call confirms a cited fact has not changed. Beyond the global base, it builds and searches custom indexes over your own documents and links entries through a concept-cluster graph and cross-domain structural analogs. ## For AI agents Search a 48-million-entry global knowledge base deterministically, fetch entries by stable id, get citations, and verify a cited fact is unchanged against a snapshot. Also builds and searches custom indexes over your own documents. ## Scope Does not generate text, host language models, or crawl the live web. Use for deterministic knowledge retrieval, citation, and custom index search only. ## Capabilities - Search a 48-million-entry global knowledge base across 35 domains - Fetch a knowledge entry verbatim by its stable id - Get a canonical citation for an entry - Verify that a cited fact is unchanged against a snapshot - Build and search custom indexes over your own documents - Find related entries through the concept-cluster graph - Resolve a name or alias to a canonical entry ## Use cases ### Grounded Answers with Verifiable Citations An AI agent connected to the ColdState API can answer from a knowledge base and show its work. It searches the global base, fetches the matching entry verbatim by stable id, and gets a canonical citation to attach to the answer, so a reader can trace each claim to a source. Because the same query against the same snapshot returns identical results, the agent's answer is reproducible rather than best-effort. Example prompt: Search the global knowledge base for a topic, fetch the top entry by its stable id, and return the fact with its canonical citation ### Fact Verification Against a Snapshot Facts drift, and an agent that cited one yesterday needs to know if it still holds. The ColdState API's verify primitive checks a cited fact against the current knowledge-base snapshot and reports whether it is unchanged. An agent reviewing older content can re-verify every citation and flag any that no longer match, using the snapshot id to pin exactly which version it checked against. Example prompt: Verify a previously cited entry against the current snapshot and report whether the fact is unchanged ### Custom Index Over Your Own Documents Teams need retrieval over private content, not just the global base. The ColdState API creates a custom index as an async build, searches it by index id or collection name, and explains why a document ranked for a query. An agent can build an index over a document set and then run grounded searches against it, keeping private documents separate from the global knowledge base. Example prompt: Create an index from a set of documents, then search it for a query and explain why the top document ranked ### Related and Cross-Domain Discovery The ColdState API links entries through a concept-cluster graph and surfaces cross-domain structural analogs through its isomorph endpoint, so an agent can move from one entry to related ones or to a structural parallel in another domain. This supports research tasks where the next useful fact is adjacent to the current one rather than a direct keyword match. Example prompt: Fetch the related entries for a given entry id and return the three most relevant, with any cross-domain analog ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/v1/search/global` | Search the global knowledge base | | GET | `/v1/knowledge/fetch` | Fetch an entry verbatim by stable id | | GET | `/v1/knowledge/cite` | Canonical citation for an entry | | POST | `/v1/knowledge/verify` | Verify a cited fact is unchanged | | GET | `/v1/knowledge/related` | Related entries via the concept-cluster graph | | POST | `/v1/indexes` | Create a custom index (async build) | | POST | `/v1/indexes/{index_id}/search` | Search a custom index | | GET | `/v1/knowledge/snapshot` | Current knowledge-base snapshot | ## Key resources - **Knowledge** — Search the global base, fetch, cite, verify, resolve, and find related or cross-domain analog entries - **Indexes** — Create, list, inspect, and delete custom indexes, browse their documents, and download an index file - **Search** — Search a custom index by id or collection name and explain why a document ranked for a query - **Auth, Usage and Billing** — Manage API keys and sessions, read usage against plan limits, and manage the subscription ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 45 / 100 - **Maturity:** Foundational - **Dimensions:** - Foundational Compliance: 83 / 100 - Developer Experience & Jentic Compatibility: 62 / 100 - AI-Readiness & Agent Experience: 21 / 100 - Agent Usability: 94 / 100 - Security: 60 / 100 - AI Discoverability: 58 / 100 - **View full report:** https://jentic.com/apis/coldstate.ai/coldstate/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring the ColdState API by hand means handling its cs_live_ API key or cs_sess_ session token, pinning the kb_snapshot so results stay reproducible, and threading stable entry ids through fetch, cite, and verify. Through Jentic you install once, import ColdState from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** ColdState puts the index id in the URL path (`/v1/indexes/{index_id}`), so a rule can pin your agent to one index and the read and search operations you pick: it can search and explain results for that index without the delete-index, key-rotation, or billing operations. You choose the operations it may call, so DELETE `/v1/indexes/{index_id}` is not included unless you add it. - **Credential handling:** Your ColdState key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'search a verifiable knowledge base' or 'verify a cited fact', and Jentic returns the matching ColdState operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Exa** — Neural search over the live web rather than a deterministic, snapshot-pinned knowledge base. - **Pinecone** — Vector database you manage yourself, versus ColdState's hosted knowledge base and custom indexes. - **Cohere** — Embeddings and rerank models that can prepare or re-order the documents a ColdState index holds. - **Tavily** — Live web search for agents, used alongside ColdState when a query needs current web results too. ## FAQ ### What authentication does the ColdState API use? The ColdState API authenticates with a bearer token per its OpenAPI spec: an API key prefixed cs_live_ or a dashboard session token prefixed cs_sess_, sent as an Authorization: Bearer header. The health, readiness, and auth register and login endpoints are open. Through Jentic the key is stored once by your own self-hosted instance and injected at call time, so it never sits in your agent's prompt or logs. ### Is there a ColdState MCP server? Yes - ColdState is also exposed as an MCP server at its /mcp endpoint. You can also connect ColdState directly through Jentic: your agent gets the full 44-endpoint surface, including the fetch, cite, and verify primitives, without loading another server's tool definitions into its context, your API key is injected at call time by your self-hosted instance, and your rules decide which operations the agent may call. ### Can I limit what my agent is allowed to do with the ColdState API? Yes. Write a rule that allows only the global search, fetch, cite, and verify operations, so the agent can retrieve and verify facts but cannot create or delete indexes, rotate API keys, or change billing. The calls it makes are logged, so you can audit exactly what the agent touched. ### Can I verify a cited fact with the ColdState API? Yes. Call POST `/v1/knowledge/verify` with a cited entry and it reports whether the fact is unchanged against the current snapshot, which you can read from GET `/v1/knowledge/snapshot.` Because an identical query and snapshot return identical results, an agent can re-check old citations and flag any that have drifted. ### What are the rate limits for the ColdState API? The OpenAPI spec does not state a fixed per-second rate limit. GET `/v1/usage` returns your current and all-time usage against your plan limits, so an agent can read those and pace its calls. Check the documentation at https://coldstate.ai for current plan allowances. ### How do I search the knowledge base with the ColdState API through Jentic? Search Jentic for 'search a verifiable knowledge base' and it returns the POST `/v1/search/global` operation with its input schema. Pass your query and the agent gets back entries it can then fetch and cite. To run it on your own infrastructure, install Jentic One from its GitHub repo.