Docs / Getting Started / Introduction

Welcome to NeuroCore™

NeuroCore™ is Mercwear's cognitive intelligence platform. This documentation will help you integrate, configure, and operate NeuroCore™ within your enterprise environment. We have tried to make this documentation as clear as possible. We acknowledge that the underlying concepts may resist clarity. We consider this a feature.

Before You Begin

Before integrating NeuroCore™, ensure your organization meets the following prerequisites:

Tip

If you are unsure whether your organization is ready for NeuroCore™, our Cognitive Readiness Assessment (available on request) will tell you that you are not fully ready, and then recommend a package to fix that.

Core Concept: What Is a Paradigm?

In NeuroCore™, a Paradigm is the fundamental unit of cognitive organization. Think of it as a container for your intelligence. Everything in NeuroCore™ belongs to a Paradigm. Your data is in a Paradigm. Your insights are in a Paradigm. Your anxieties about whether this was the right technology decision are outside the Paradigm, but we understand them.

Paradigm Schema

A Paradigm has: a name (string, required); a synergy_level (enum: 'low' | 'medium' | 'high' | 'hyperscale', default: 'hyperscale'); a cognitive_mode (enum: 'deterministic' | 'emergent' | 'intuitive', default: 'emergent'); a created_at timestamp; and a shifted boolean (becomes true after first synthesis cycle).

Quickstart

Install the Mercwear SDK for your preferred language. We offer packages for Python and Node.js. If you use a different language, please see our BYOC (Bring Your Own Cognitive) documentation, which is forthcoming.

bash 
# Install the Mercwear SDK
pip install mercwear

# Or if you prefer uncertainty
npm install @mercwear/neurocore

Once installed, initialize the client with your API key and create your first Paradigm:

python 
import mercwear

# Initialize client
client = mercwear.Client(api_key="mw_live_xxxxxxxxxxxx")

# Create your first paradigm
paradigm = client.paradigms.create(
    name="my-first-paradigm",
    synergy_level="hyperscale"
)

# Verify it exists
print(paradigm.id)      # prg_a1b2c3d4e5f6
print(paradigm.status)  # "shifting"
print(paradigm.shifted) # False (give it a moment)
Note

A newly created Paradigm will have a status of "shifting". This is normal. Do not be alarmed. Most Paradigms finish shifting within 30–90 seconds. If yours is still shifting after 10 minutes, consult the Troubleshooting Your Paradigm guide.

Authentication

All API requests require a Bearer token in the Authorization header:

Authorization: Bearer mw_live_xxxxxxxxxxxx

API keys are available in your Mercwear dashboard under Settings › Cognitive Access › API Keys › Generate New Key › Name Your Key › Download Key (it will not be shown again) › Store Securely › Rotate Quarterly › Regret Not Writing It Down.

Security Best Practice

Never expose your API key in client-side code, public repositories, or Slack messages. We have seen all three. We do not recommend any of them.

Error Codes

The NeuroCore™ API uses standard HTTP status codes to indicate the success or failure of your request. The following codes deserve particular attention:

Code Status Description
200 OK Everything is fine. Paradigm is operational.
400 Bad Request Your request was malformed. Review the paradigm schema.
401 Unauthorized Invalid API key. You are not recognized by the cognitive substrate.
403 Forbidden You know what you did.
404 Not Found The paradigm you requested does not exist. It may never have existed. Consider whether it should.
429 Too Many Requests You are synthesizing too fast. The paradigm needs a moment.
500 Internal Server Error Something is wrong on our end. Check status.mercwear.com. We are probably already aware.
503 Paradigm Unavailable The cognitive substrate is temporarily unavailable. This has never happened. If you are seeing this, something remarkable has occurred.

Rate Limits

NeuroCore™ API rate limits are as follows:

Plan Rate Limit
Curious 100 requests / minute
Disruptive 1,000 requests / minute
Transformative 10,000 requests / minute
Singularity "as many as you need, we will handle it"

If you hit a rate limit, you will receive a 429 with a Retry-After header indicating how many seconds to wait. This is also good life advice.

Was this page helpful?