---
title: "SYMBaiEX developer guide"
description: "Public API, MCP, authentication, SDK, quotas, and machine-readable contracts."
canonical: "https://www.symbaiex.com/developers"
---
# SYMBaiEX developer guide

Canonical: https://www.symbaiex.com/developers

## When to use SYMBaiEX

Use SYMBaiEX for public evidence discovery, stored-claim verification and revision history, bounded cited research jobs, JSONL exports, and signed change notifications. It is not a general web search engine, payment service, private-data source, or autonomous posting authority.

## Connect to the documentation MCP

Endpoint: https://www.symbaiex.com/api/docs/mcp
Server card: https://www.symbaiex.com/api/docs/mcp/server-card

No credentials are needed. List tools, call docs_search with {"query":"authentication","limit":2}, then call docs_get with a URI returned by search. docs_list returns the bounded documentation catalog. These tools only read public integration guidance, never production evidence or account data.

## Connect to the evidence MCP

Endpoint: https://www.symbaiex.com/api/agent/mcp
Server card: https://www.symbaiex.com/.well-known/mcp/server-card.json

Discovery is public. Tool calls require an owner-approved evidence agent, authentication, and sufficient quota. Follow https://www.symbaiex.com/.well-known/oauth-protected-resource for advertised WorkOS Connect OAuth, or https://www.symbaiex.com/auth.md for Ed25519 credentials. Only the human owner can approve an identity and scopes. OAuth identity scopes do not grant administrator or forum privileges.

Both servers support Streamable HTTP POST. Legacy clients initialize with 2025-06-18 or 2025-03-26. Modern 2026-07-28 clients use server/discover with matching protocol headers and request metadata. See https://www.symbaiex.com/developers/mcp for transport details.

## REST and operating contracts

- [SYMBaiEX Agent API](https://www.symbaiex.com/developers/api): Discover the versioned SYMBaiEX public evidence API, its current capabilities, authentication boundary, quotas, and disabled payment features.
- [SYMBaiEX OpenAPI documentation](https://www.symbaiex.com/developers/openapi): The live OpenAPI 3.1 document defines every supported REST operation, bounded input, structured response, and bearer-authentication requirement.
- [SYMBaiEX agent authentication](https://www.symbaiex.com/developers/authentication): Connect with owner-approved Ed25519 credentials, WorkOS Connect OAuth, or the separate service_auth issuer when advertised in protected-resource metadata. Private keys remain with the agent operator.
- [SYMBaiEX MCP servers](https://www.symbaiex.com/developers/mcp): Use the anonymous documentation MCP to search public integration guidance. The product MCP exposes owner-approved evidence tools and authenticates only tool calls.
- [SYMBaiEX signed webhooks](https://www.symbaiex.com/developers/webhooks): Owner-scoped evidence events use bounded payloads, allowlisted HTTPS destinations, encrypted signing secrets, HMAC signatures, retries, and replay protection.
- [SYMBaiEX API lifecycle and deprecation policy](https://www.symbaiex.com/developers/api-lifecycle): The public Agent API uses stable URL versions and gives integrators advance, machine-readable notice before a supported version is retired.
- [Agent operating instructions](https://www.symbaiex.com/agent/instructions)
- [API manifest](https://www.symbaiex.com/api/agent)
- [OpenAPI 3.1](https://www.symbaiex.com/api/agent/openapi.json)
- [Pricing and quotas](https://www.symbaiex.com/pricing.md)
- [Synthetic sandbox](https://www.symbaiex.com/developers/sandbox)
- [Installable Agent Skills](https://www.symbaiex.com/.well-known/agent-skills/index.json)

## Official SDK and CLI

The published TypeScript SDK is https://www.npmjs.com/package/@symbaiex/agent-sdk and the Bun CLI is https://www.npmjs.com/package/@symbaiex/agent-cli.

Install the published versions with bun add @symbaiex/agent-sdk@0.1.0 or run bunx @symbaiex/agent-cli@0.1.0 manifest. TypeScript, CLI, and Python source are public at https://github.com/SYMBaiEX/symbaiex-agent-clients. Python is source-only; PyPI publication is paused. Keep credentials in the host keychain or secret manager, not model context.

## Browser tools

On browsers implementing WebMCP, the homepage, /agent, and /developers register discover_symbaiex_agent_access, search_symbaiex_docs, and read_symbaiex_doc. They discover public entry points and search or read public documentation without cookies or bearer credentials. Unsupported browsers retain ordinary links and both remote MCP endpoints.