Skip to main content

Spectora API & MCP Early Access FAQs

Answers to the most common questions about Spectora's Public API and AI Connector (MCP) during early access.

Written by Shannon Lewis

🚨 Not seeing this feature? It’s on its way! Spectora's MCP is currently in early access. Learn more at Spectora Labs or join the waitlist here. 🚨

Access & Eligibility

  • Who can get access right now?

    • The Public API and AI Connector are currently in early access and available to paid Spectora customers.

    • To join the early access group, request access via the waitlist.

  • How much does the API cost during early access?

    • It's free during early access — no additional cost while we're in this phase.

    • We're still working through what pricing will look like when the feature is fully released, and we'll share those details well in advance so you have plenty of time to plan.

  • Will pricing eventually require a specific plan?

    • Pricing isn't finalized yet. We expect there to be a free tier and possibly several paid tiers when we move out of early access.

  • We run multiple Spectora companies — how does API access work?

    • You can have API access for multiple companies.

    • Each Spectora company instance has its own login, API keys, and webhook subscriptions.

    • When tiered pricing is in place, pricing may vary between companies depending on differences in plan or usage.


Getting Started

  • How do I get logged in and create my first API key?

    • We recommend creating a dedicated staff account with full permissions specifically for API use. Then:

      • Log into Spectora, then open the developer portal at developer.spectora.com in a new tab in the same browser window — the portal authenticates using your active Spectora session

      • Click Login (top right), then Authorize in the popup

      • Click your username → API KeysCreate API Key

    • From there, you can test endpoints under the API Reference tab or configure webhooks under Webhook Configuration.

  • Why do you recommend a dedicated API user account?

    • The API key inherits the permissions of the user who created it.

    • If that user is later deactivated, the key stops working.

    • A dedicated API user keeps your integrations stable and easy to manage over time.

  • Can I limit what my API key can access?

    • Not at this time, outside of the limitations imposed by the permissions of the user who created the key.

  • Are there video walkthroughs?

    • Yes! We have walkthroughs covering:

      • Getting logged into the developer portal

      • Testing an API call directly in the portal

      • Configuring and testing webhooks

      • Uploading inspection attachments via API


What the API Can Do Today

  • What endpoints are available?

Resource

What you can do

Agents & Clients

List, view, create, and update

Agent Stats

Inspection counts, first/last inspection dates, and revenue breakdowns

Inspections

View and filter inspection and scheduling data (read-only)

Inspection Attachments

List attachments and upload new ones

Webhooks

Real-time notifications for agent, client, and inspection events

  • Can I create inspections via the API?

    • No. This is a known request and is under active internal discussion.

  • Can I get report content out of the API?

    • Full report content — narratives, comments, and photos — isn't exposed via the API today.

    • You can get inspection metadata, and you can build the client portal link using the slug field included in the inspection response:

      • https://portal.spectora.com/inspection/[slug].

    • Adding the report link directly to the response is something we are working on.

  • Can I access calendar availability or book inspections via the API?

    • Not yet. Calendar availability endpoints aren't exposed today — this is one of the most requested additions and is being assessed for prioritization.

  • Can I access services and fees via the API?

    • Not yet. A services endpoint is in our planning but not yet available.

    • The current inspection response does include service and add-on names in comma-delimited format, so you can see what was on an inspection — but not the per-service prices.

  • Are agent details exposed?

    • Yes — most agent fields are available via the API, including agency name, buying and selling inspection counts, and tags.

    • To get agent details inside an inspection response, use the include parameter when calling the inspection endpoint.

  • Can I see client contact details on an inspection?

    • Yes — use the include parameter when retrieving an inspection to get the buyer's email, phone, and address. Without it, you'll only see the buyer's name.

  • Can I see inspector details on an inspection?

    • The primary inspector name and ID is available via the API.

    • A dedicated Inspectors endpoint is on our roadmap.

  • Can I see payment details?

    • Not today — the API exposes a paid boolean only.

    • Exposing granular payment data is on our list.

  • Can I see agreement or signed document data?

    • Not today.

    • We're evaluating exposing agreement PDFs, template names, and signed status by party.


Attachments

  • What can I do with the attachments endpoints?

    • Two things:

      • List attachments on an inspection — the response includes a direct file URL

      • Upload an attachment to an inspection as either an Additional Document or a Report attachment

  • What file types are supported for uploads?

    • .jpg, .jpeg, .png, .gif, .pdf, .zip, .txt, .mp3, Word, Excel, and PowerPoint files.

  • Anything special about how uploads work?

    • Yes — uploads must be sent as multipart/form-data with key/value pairs in the format data[attributes][fieldname].

    • The developer portal supports this when you switch the Body to multipart. The walkthrough video shows the full flow.

  • Who is using attachments today?

    • The primary use case is third-party vendor integrations — for example, lab partners automatically posting completed reports back into Spectora where they appear in the client portal.

    • You can also use it for your own workflows, though it's most powerful for automated flows rather than one-off uploads.


Webhooks

What events fire today?

Category

Events

Inspections

inspection.created, inspection.confirmed, inspection.canceled, inspection.published, inspection.deleted

Clients

contact.created, contact.updated, contact.deleted

Agents

connection.created, connection.updated, connection.deleted

  • What's in the webhook payload?

    • Payloads are intentionally minimal — they include the event type, the object ID, and the company ID. To get full details, make a follow-up API call using the object ID. This is by design for speed and reliability.

  • Can one endpoint receive multiple event types?

    • Yes.

  • Do webhooks count against my API call quota?

    • No. Only your outbound API calls count against your quota — incoming webhook deliveries do not.


AI Connector (MCP)

  • What is the Spectora AI Connector?

    • The AI Connector uses the Model Context Protocol (MCP) — an open standard that lets AI assistants like Claude and ChatGPT connect directly to your Spectora data.

    • Instead of writing code to pull data, you connect your Spectora account to an AI assistant and ask questions in plain language. No programming required.

  • How do I set it up?

    • Generate an API key from the developer portal at developer.spectora.com, then follow the setup instructions on the MCP Server tab. Setup typically takes about 5 minutes.

    • Claude Desktop

    • ChatGPT

  • Is the AI Connector read-only?

    • Yes. Write endpoints are intentionally disabled through the AI Connector — this prevents AI tools from creating or modifying records in your Spectora account without you doing it deliberately.

  • Is the AI Connector included in early access?

    • Yes — both the Public API and the AI Connector are bundled in the current early access offering.

  • Can I connect more than one Spectora company to my AI tool?

    • Yes. Each company needs its own API key and its own entry in your AI tool's configuration. Name them clearly — for example, spectora_company1 and spectora_residential — so you can reference the right one. Here's how:

      • Log out of the developer portal, log back in under the second company's profile, and create an API key

      • Open your AI tool's config file

      • Duplicate your existing Spectora entry, rename it, and paste the new API key

      • Save, then fully close and reopen your AI tool

      • Verify both connections appear in your settings

  • What can I actually do with the AI Connector?

    • A few high-value things inspectors are using it for today:

      • Inspector scorecards — volume, add-ons, and cancellation rates by inspector

      • Agent analysis — referral counts, add-on attach rates, and dormant agent identification

      • Service mix by ZIP code — which areas drive which kinds of work

      • Daily inspector prep briefings — tomorrow's schedule with agent background and job details

      • Capacity planning — turning inspection history into a forward forecast


Rate Limits & Quotas

  • Are there rate limits?

    • Yes — there is both a per-minute rate cap and a monthly call volume quota.

  • What's the best approach for high-volume use?

    • Use delta queries — only pull what's changed since your last sync rather than pulling full history each time.

    • Combining webhook events with targeted API calls by ID is typically much more efficient than periodically listing all records.

  • What does a 429 error mean?

    • A 429 Too Many Requests response means you've hit your rate limit.

    • Build retry logic with exponential backoff into your integration — when a 429 comes back, wait a moment and try again, waiting a little longer each time.

    • If you believe your quota needs to be increased, reach out to us on the chat bubble or at support@spectora.com.


Authentication & Security

  • How do I authenticate?

    • All API requests use Bearer token authentication. Include your API key as a Bearer token in the Authorization header of every request.

  • What happens if my API key is compromised?

    • Delete the compromised key first, then generate a new one and update your integration:

      • If the key has an expiration: click the trash can icon next to the key to delete it

      • If the key was created without an expiration: click Roll Key first — this creates new keys and turns the old ones into expiring keys, then use the trash can icon to delete the compromised key

  • Is data encrypted in transit?

    • Yes — all API calls go over HTTPS.

  • Does Spectora use customer data exposed via the API to train AI models?

    • No. We do not use customer data to train any AI models.


The Developer Portal

  • Where is the developer portal?

    • developer.spectora.com

  • Can I test API calls without writing code?

    • Yes — the developer portal has an interactive playground under the API Reference tab. It uses your real Spectora data, so be thoughtful about what you test.

    • Multipart endpoints like attachment upload require switching the Body type to multipart in the playground.

  • Can I configure webhooks from the portal?

    • Yes — under Webhook Configuration. The video walkthrough shows the full flow.


Support & Feedback

  • Where do I send feedback or feature requests?

    • We love hearing from you. Reach out via the in-app support bubble or email josh@spectora.com directly.

  • What's the best way to get help when something isn't working?

    • For access or API key issues, reach out via the in-app support bubble or email support@spectora.com

    • For technical issues, include the request URL, the parameters you sent, and the response you received — but never include your API key in any support request

⚠️Our support team is happy to help with general questions about the API and MCP server. However, because setup can vary depending on your device, operating system, and AI tool, we're not always able to walk through every technical configuration step.

If you run into trouble beyond what's covered here, we'd recommend looping in an IT professional with API/MCP experience. They'll be able to get you connected much faster than we can from our end!


If you have any questions or feedback, write into our chat bubble or email support@spectora.com!

Did this answer your question?