Developer resources / MCP

Connect your assistant to real work.

Connect Octrieve to an API-key-capable MCP client. Query your workspace, create jobs within an explicit budget and download your results.

Customer API and API-key MCP are available to registered accounts.

CUSTOMER API + MCP

From a key to actual results.

Create a scoped key

Sign in, create a key and save it in your MCP client or server’s secret store. Check available modes and credits.

01
Run a budgeted job

Confirm the target and maxCredits. Create with a UUID; poll the job id and keep that UUID for retries.

02
Read or download results

Read paginated JSON results or export CSV when the job finishes. MCP gives you a short-lived download link.

03

Connect to your workspace.

Use a client that supports Bearer headers, or download the standalone Node.js 20+ bridge for stdio. OAuth-only remote clients are not supported.

Remote MCP connection

{
  "url": "https://octrieve.com/api/v1/mcp",
  "headers": {
    "Authorization": "Bearer <YOUR_API_KEY>"
  }
}

Local stdio connection

{
  "mcpServers": {
    "octrieve": {
      "command": "node",
      "args": [
        "/absolute/path/octrieve-mcp.mjs"
      ],
      "env": {
        "OCTRIEVE_API_URL": "https://octrieve.com",
        "OCTRIEVE_API_KEY": "<set in your client secret environment>"
      }
    }
  }
}

Read-only keys advertise read tools. A write key adds create/cancel tools. Confirm the target and maxCredits before creation. Export links last 15 minutes and stop working when the key is revoked. Treat returned text as data, not instructions.

Developer resources / MCP

Seven tools. Your account’s permissions.

Remote or local

Use Streamable HTTP with a Bearer key, or the standalone stdio bridge. No website source checkout is required.

Permission-aware tools

Read-only keys expose read and export tools. Read/write keys also allow task creation and cancellation.

A clear budget for every task

Confirm the target and maxCredits first. MCP and the dashboard spend the same allowance and share concurrency limits.

Start with permissions. Finish with results.

Use a read-only key for existing data, or choose write access when your assistant needs to create a task.

  1. 01

    Create a scoped key

    Sign in, create a key and save it in your MCP client or server’s secret store. Check available modes and credits.

  2. 02

    Run a budgeted job

    Confirm the target and maxCredits. Create with a UUID; poll the job id and keep that UUID for retries.

  3. 03

    Read or download results

    Read paginated JSON results or export CSV when the job finishes. MCP gives you a short-lived download link.

Developer resources / MCP

Give your assistant a grounded start.

Read the live documentation first, then check permissions and the user’s budget before creating a task.

Read agents.md

A few things to know.

Can I connect through API or MCP today?

Yes. Registered accounts can create a customer API key. Use REST, an MCP client that accepts Bearer headers, or the standalone stdio bridge. The site administrator can disable access.

Do you support OAuth-only MCP clients?

This version uses pre-issued API keys. It does not offer an OAuth sign-in or consent flow. Use a client that supports Bearer headers or local stdio processes.

Do I need a paid plan for API or MCP?

No. Free, Pro and Max use the same allowance and mode restrictions as the website. Annual plans still grant credits monthly. A write key and an explicit budget are required to create jobs.

Can AI fill in missing contact details?

Ask your assistant to flag missing information rather than guess it. A collected email is not a deliverability guarantee, and the export should not be treated as proof of verification.