Developer resources

CoPlaid is designed to be called by other software rather than to be a destination. There is no front end you are obliged to adopt and no framework you have to match — the integration is a REST API over HTTPS, callable from backend services, job schedulers and business logic alike.

Getting access

API keys are provisioned by CoPlaid administrators and issued to partner accounts — there is no self-service key generation. To request access, email admin@coplaid.ai. Once you have an account, keys are managed in the partner dashboard at core.coplaid.ai under Account → API Keys, where you will also find the full interactive documentation.

Authentication

Every request carries your key in the X-API-Key header. Keys are valid for 365 days and are rate limited to 100 requests per hour per key. Never place a key in client-side code; store it in environment variables or a secrets manager.

curl -X POST https://api.coplaid.ai/partner/onboard-customer \
  -H "X-API-Key: $COPLAID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Machine-readable resources

Everything on this site is published in a form an agent or a script can consume directly, at predictable URLs.

• /openapi.json — OpenAPI 3.1 description of the public CoPlaid Messaging endpoints.
• /llms.txt — a summary of this product written for AI agents.
• /llms-full.txt — the full content of this site as Markdown.
• /AGENTS.md — how to represent this product accurately, and what not to infer.
• /index.md — the home page as Markdown. Served with Vary: Accept.
• /sitemap.xml — every page on this site.

NetSuite

If your customers run NetSuite, the console can be embedded in their instance with a SuiteScript bundle — a Suitelet that renders inside NetSuite's own UI shell, plus an optional dashboard portlet. It uses a console key scoped to one product and one access mode, with a NetSuite host allowlist controlling which pages may embed it. The bundle ships with a full install guide. Ask us for it at admin@coplaid.ai.