SpyderBot Documentation
API Credentials
This page answers when API credentials are available and how to handle them safely.
API access is included in the Business plan ($500/month). See Pricing. Credentials provide programmatic access to the resource families available under that plan.
This page does not publish a public endpoint catalog, private schemas, or credential values. The authenticated API reference remains the source of truth for base URL, version, scopes, schemas, pagination, rate limits, errors, and deprecation notices.
Credential safety
- Create credentials only when the integration requires them.
- Store credentials in a secure server-side secret store.
- Never embed credentials in browser code, public repositories, screenshots, support messages, or shared reports.
- Use separate credentials for separate approved environments when supported.
- Rotate or revoke a credential when exposure is suspected, responsibility changes, or access is no longer needed.
- Review the authenticated API documentation for current scopes and limitations.
Do not attempt to use internal product browser requests as a public API. Only documented API endpoints are supported.
How credentials relate to product evidence
API access does not change the meaning of a metric. When you pull results into another system, preserve:
- source product;
- scope (prompts, systems, market, language, competitors, period);
- data state labels such as observed, calculated, estimated, unavailable, or insufficient;
- method or taxonomy version when shown;
- evidence identifiers needed for later audit.
Estimated and observed data must remain distinguishable. A citation is not a referral. A bot request is not a citation. A referral session is not attributable to a prompt without direct deterministic evidence.
Operational checklist
- Confirm the workspace is on the Business plan on Pricing / Billing.
- Open the credential controls available in Administration.
- Create a credential only for the integration that needs it.
- Store the secret server-side and restrict who can read it.
- Validate a successful authenticated call using the authenticated reference.
- Rotate or revoke credentials when people or systems change.
For Business-plan questions or authenticated reference routing, use Contact Sales.