API introduction

The Searchly API lets your application work with projects, prompts, AI visibility reports, raw answers, Content Studio, and connected providers. Use it to bring Searchly evidence into a dashboard, automate a content workflow, or manage tracking from your own tools.

Operations use the platform's existing subscription limits, job admission, revision checks, and publishing approvals. API keys belong to a workspace; each project request names its project explicitly.

1. Create a scoped key in Settings → API Keys.
2. Send it in an Authorization: Bearer header.
3. List projects and choose the project ID for your integration.
4. Use the endpoint reference to check the operation's inputs and permissions.

Follow the quickstart for your first read request, or open the complete endpoint reference.

The base URL is https://app.trysearchly.com/api/v1. Discovery is available at GET /api/v1; the OpenAPI document is at GET /api/v1/openapi.json.

The reference includes registered methods, paths, operation IDs, base input schemas, and required scopes. Additional checks, such as valid ordered dates and website eligibility, run on each request. Authenticated resource JSON responses share an envelope, while resource payloads keep their documented fields. Discovery and OpenAPI responses return bare JSON without that envelope.

Administrative controls, background worker controls, billing changes, account security, account erasure, and team authority changes are outside this API. Provider OAuth consent remains interactive. AI assistants can use the MCP server with the same workspace key and permissions. Chatbot integration, customer SDK packages, and webhooks remain separate follow-up work.