Credentials identify the account whose accessible research and submission permissions an integration uses. Keep account credentials separate from scientific data and shared code.
Generate a REST API key
Sign in, open Workspace → API Key, and use the key controls shown for your account. Store the resulting key in a secret manager or a local environment variable rather than in a notebook cell committed to source control.
REST requests use this header:
X-API-KEY: <your-account-api-key>
The following example reads the key from your environment and lists your jobs. It does not submit a calculation.
import os
import requests
response = requests.get(
"https://neurosnap.ai/api/jobs",
headers={"X-API-KEY": os.environ["NEUROSNAP_API_KEY"]},
params={"exclude_subdata": ""},
timeout=30,
)
response.raise_for_status()
jobs = response.json()
Understand REST access
The catalog is publicly discoverable, while account history and submissions require authentication. Status and file routes also enforce job access even though an appropriately shared job can be opened without an account credential.
A job ID alone is not an access credential. A complete share link includes a separate token; treat it as sensitive. Do not distribute an account API key to share one result.
Authenticate an MCP client
The endpoint is https://neurosnap.ai/mcp, using Streamable HTTP. For clients supporting the server’s OAuth flow, connect the URL and complete authorization in the browser. For clients supporting custom headers, configure an API key using X-API-KEY.
The MCP transport also accepts a Bearer API-key credential. Supply one authentication credential per request; sending both Authorization and X-API-KEY is rejected. An MCP OAuth token is for MCP access and should not be assumed to authenticate REST endpoints.
Client configuration syntax varies. Use the client’s supported remote-MCP setup, not a configuration format copied from an unrelated application. See MCP server for a first connection check.
Handle authentication problems
Check the endpoint, account, credential type, and current access to the requested job or team. Authentication can fail because a credential is invalid, the account is restricted, or a server-side lookup fails; do not treat every error as permission to create another job.
Never put a key in a URL, screenshot, exported pipeline template, or support message. If exposed, replace it using the account controls and update the affected clients.