Console API Mapping
This page maps the SDK surface to the underlying Cognipeer Console client API.
Use it when you need to:
- review what an SDK method sends over HTTP,
- migrate from raw fetch calls to the SDK,
- confirm where platform docs live versus where SDK docs live.
Mapping Table
| Capability | SDK method | Console endpoint | Console docs |
|---|---|---|---|
| Chat completions | client.chat.completions.create() | POST /chat/completions | Chat Completions |
| Embeddings | client.embeddings.create() | POST /embeddings | Embeddings |
| List agents | client.agents.list() | GET /agents | Agents |
| Get agent | client.agents.get(agentKey) | GET /agents/:agentKey | Agents |
| Invoke agent | client.agents.responses.create() | POST /responses | Agents |
| List vector providers | client.vectors.providers.list() | GET /vector/providers | Vector |
| Create vector provider | client.vectors.providers.create() | POST /vector/providers | Vector |
| List indexes | client.vectors.indexes.list(providerKey) | GET /vector/providers/:providerKey/indexes | Vector |
| Create index | client.vectors.indexes.create(providerKey, data) | POST /vector/providers/:providerKey/indexes | Vector |
| Get index | client.vectors.indexes.get(providerKey, indexId) | GET /vector/providers/:providerKey/indexes/:externalId | Vector |
| Update index | client.vectors.indexes.update(providerKey, indexId, data) | PATCH /vector/providers/:providerKey/indexes/:externalId | Vector |
| Delete index | client.vectors.indexes.delete(providerKey, indexId) | DELETE /vector/providers/:providerKey/indexes/:externalId | Vector |
| Upsert vectors | client.vectors.upsert(...) or client.vectors.indexes.upsert(...) | POST /vector/providers/:providerKey/indexes/:externalId/upsert | Vector |
| Query vectors | client.vectors.query(...) or client.vectors.indexes.query(...) | POST /vector/providers/:providerKey/indexes/:externalId/query | Vector |
| Delete vectors | client.vectors.delete(...) or client.vectors.indexes.deleteVectors(...) | DELETE /vector/providers/:providerKey/indexes/:externalId/vectors | Vector |
| List buckets | client.files.buckets.list() | GET /files/buckets | Files |
| Get bucket | client.files.buckets.get(bucketKey) | GET /files/buckets/:bucketKey | Files |
| List files | client.files.list(bucketKey, query) | GET /files/buckets/:bucketKey/objects | Files |
| Upload file | client.files.upload(bucketKey, data) | POST /files/buckets/:bucketKey/objects | Files |
| Get file metadata | client.files.get(bucketKey, objectKey) | GET /files/buckets/:bucketKey/objects/:objectKey | Files |
| Delete file | client.files.delete(bucketKey, objectKey) | DELETE /files/buckets/:bucketKey/objects/:objectKey | Files |
| List prompts | client.prompts.list() | GET /prompts | Prompts |
| Get prompt | client.prompts.get(key, options) | GET /prompts/:key | Prompts |
| Render prompt | client.prompts.render(key, options) | POST /prompts/:key/render | Prompts |
| List prompt versions | client.prompts.listVersions(key) | GET /prompts/:key/versions | Prompts |
| List prompt deployments | client.prompts.getDeployments(key) | GET /prompts/:key/deployments | Prompts |
| Run prompt deployment action | client.prompts.deploy(key, options) | POST /prompts/:key/deployments | Prompts |
| Compare prompt versions | client.prompts.compare(key, fromVersionId, toVersionId) | GET /prompts/:key/compare | Prompts |
| Evaluate guardrail | client.guardrails.evaluate(data) | POST /guardrails/evaluate | Guardrails |
| Ingest tracing session | client.tracing.ingest(data) | POST /tracing/sessions | Tracing |
| List config groups | client.config.listGroups() | GET /config/groups | Config |
| Create config group | client.config.createGroup(data) | POST /config/groups | Config |
| Get config group | client.config.getGroup(groupKey) | GET /config/groups/:groupKey | Config |
| Resolve config items | client.config.resolve(data) | POST /config/resolve | Config |
| Audit config item | client.config.auditLogs(key) | GET /config/items/:key/audit | Config |
| List memory stores | client.memory.stores.list() | GET /memory/stores | Memory |
| Add memory | client.memory.add(storeKey, data) | POST /memory/stores/:storeKey/memories | Memory |
| Search memory | client.memory.search(storeKey, data) | POST /memory/stores/:storeKey/search | Memory |
| Recall memory | client.memory.recall(storeKey, data) | POST /memory/stores/:storeKey/recall | Memory |
| Ingest RAG content | client.rag.ingest(moduleKey, data) | POST /rag/modules/:moduleKey/ingest | RAG |
| Query RAG module | client.rag.query(moduleKey, data) | POST /rag/modules/:moduleKey/query | RAG |
| Delete RAG document | client.rag.deleteDocument(moduleKey, documentId) | DELETE /rag/modules/:moduleKey/documents/:documentId | RAG |
Ownership Rule
- Use the Console docs when you need platform semantics, deployment context, or raw endpoint behavior.
- Use the SDK docs when you need method signatures, request helpers, typed responses, or code examples.