sensor labs

Portal API & MCP

Use the same private workspace through the portal, an API client, or an MCP assistant. All three use the same validation, permissions and revision checks.

Manage API accessOpenAPI 3.1 JSONOperation schemas

Connect an MCP client

Endpoint: https://sensorlabs.ai/api/mcp/. Clients with OAuth support discover the managed Supabase authorization server and take you to Sensor Labs to approve specific permissions. Your client handles its own return address. We do not assume the machine running your agent has a browser.

For headless servers and clients supporting custom headers, create a scoped key in API & MCP and send Authorization: Bearer YOUR_API_KEY. The server generates the key; copy it once into your secret manager. There is no local key-generation or installation script. Keys expire in 1–90 days and can be revoked immediately. Tools are filtered to the credential’s permissions on every request.

{
  "mcpServers": {
    "sensor-labs": {
      "type": "http",
      "url": "https://itervale.vercel.app/api/mcp/",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

Configuration syntax differs by MCP client. The server supports stateless Streamable HTTP through the official SDK, native inventory prompts and discoverable resources. Credential creation and application-grant changes require a first-party signed-in session and are deliberately unavailable to delegated MCP clients.

Call the HTTP API

Send JSON to POST /api/v1/operations/OPERATION_NAME/. Successful responses contain data; errors contain error.code, error.message and a request ID. All private responses use Cache-Control: no-store.

curl 'https://itervale.vercel.app/api/v1/operations/inventory_list/' \
  -H "Authorization: Bearer $SENSOR_LABS_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{"filter":"needs_count"}'

Write without losing somebody else’s edits

Read the current revision from the resource first. Every workspace metadata mutation requires that value as expectedRevision and a new UUID as operationId. Keep the operation ID and arguments if the response is lost: retry them unchanged for the original receipt. Workspace receipts are retained for 30 days; marketplace receipts are retained with transaction history. Reusing an ID with different arguments returns 409. A concurrent save returns 409 with the current revision; reread and reconcile your intended change before sending a new operation.

{
  "expectedRevision": 3,
  "operationId": "a1c54872-1167-4f7b-8b6c-f636f28e439a",
  "answers": {
    "companyName": "Example company",
    "years": "5",
    "deskWorkers": "40"
  }
}

Mutation responses return the saved revision and replayed, without unrelated workspace data. Read the resource again when you need the current contents. Clearing a workspace advances its revision and removes saved metadata; insurance files, credentials and the minimal activity log are separate.

Guided data cataloging

Customers can choose Connect Claude in Data → Export guides, guided onboarding, or API & MCP settings. The dialog links to Claude’s connector settings, provides the public MCP URL, explains OAuth approval and copies a starter task. No key is needed for this path. The Catalog my data preset reads questionnaires, tools and inventory and can edit selected tools and inventory; it does not grant questionnaire writes, deal access, private documents, credentials or checklist writes.

catalog_get returns company basics, source-review progress, the next pending source, current revision and explicit write-permission flags. It excludes unrelated questionnaire answers and deal records. Without tool, it pages the selected source summaries; with tool, it pages full inventory rows for that exact label. Use offset and limit (default 25, maximum 50), and follow page.nextOffset. The returned row’s reviewed flag is read-only; omit it when sending inventory_upsert.

catalog_task and the native MCP prompt catalog-my-company-data return the same guided task used in the portal. The task checks actual available source connections, collects aggregate figures, saves with the existing revision/idempotency rules, then rereads the saved results. Review saved counts in the portal reads the latest workspace after saving any local draft. Customer connection guide.

Export guides and dataset metadata

guides_list returns guides for saved tools; use selectedOnly: false to browse all provider guides. guides_get returns manual steps, screenshots, prerequisites and sources for one tool. guides_task returns a catalog-only or local-export Claude Code task for one tool or all selected tools. Custom tools receive a clearly labeled general workflow. These operations require tools:read.

MCP includes a native catalog-or-export-tools prompt and sensor-labs://export-guides resource. Guide screenshot paths are relative to this service. overview_get.dataset returns unit-separated counts, size and reliability, source dates, workforce figures, source contributors and overlap flags. Optional inventory fields contributors and contributorBasis record contributing accounts, separately from company employees. Decimal GB supports up to nine places. Raw exports remain in the company’s own storage.

Corpus evaluation and buyer workflows

Marketplace operations use the same registry and service as the portal. Choose market:read, market:write and, separately, samples:read as needed in API & MCP settings. Existing catalog-only OAuth grants do not gain these permissions automatically.

Use market_status to read buyer eligibility. Qualified buyers use market_catalog with query, sector, system, offset and limit (maximum 50); market_corpus_get returns approved metadata and a structured sample-access next step. Use shortlist, inquiry, deal, message and nonbinding-offer operations to continue evaluation. An agent must not treat a proposed workflow as a tested task or an indicative price as a completed sale.

Corpus drafts, buyer applications, sample manifests and deals each have their own revision. Revisioned writes require that entity’s expectedRevision. All marketplace mutations require a stable operationId; shortlist, inquiry, message and grant operations are naturally atomic and do not require a workspace revision. Identical retries return the saved receipt, while changed arguments conflict. Read the resource after an ambiguous response before making a different change.

Owner publication attestations, sample uploads and grants, commercial milestones and operator reviews require first-party sessions. Operator authority comes from a trusted server record, never a caller-supplied role. Those operations are documented in HTTP discovery but excluded from delegated MCP tools. Cleared sample previews and downloads use market_sample_open; buyer, NDA, listing, file status, hash and explicit file grant are checked for each request. Signed downloads expire in 60 seconds.

The portal records separately signed agreements and supporting receipts. It does not sign, invoice, transfer money or automatically deliver a full corpus. Open the buyer workspace.

Files

Call policies_upload_url, then PUT the file bytes directly to its returned upload URL with the returned Content-Type. The private bucket accepts PDF, DOC and DOCX up to 20 MB. The API does not proxy large file bodies or fetch arbitrary remote URLs. Confirm the upload with policies_list. Download URLs expire after 60 seconds. File permissions are separate from metadata permissions. File operations do not change the workspace revision.

Account and access management

The existing signup, sign-in, confirmation, password recovery and sign-out flows use Supabase Auth. Use your own account session for first-party API requests. Do not give agents your password or a Supabase service key.

These endpoints require a first-party account session. OIDC identity scopes are separate from the portal permissions selected during consent. One account owns one private workspace; team sharing is not implemented.

Permissions

ScopePermission
questionnaires:readRead questionnaires
questionnaires:writeChange questionnaires
tools:readRead tools
tools:writeChange tools
inventory:readRead inventory
inventory:writeChange inventory
referrals:readRead referrals
referrals:writeChange referrals
offers:readRead offers
offers:writeChange offers
access:readRead access
access:writeChange access
checklist:readRead checklist
checklist:writeChange checklist
policies:readRead and download private insurance documents
policies:writeUpload and remove private insurance documents
workspace:deleteClear all saved workspace metadata
audit:readRead API activity (operation names and timestamps)
market:readRead your corpus drafts, approved listings, buyer profile, shortlists and permitted deals
market:writeSave corpus drafts, buyer applications, shortlists, inquiries, messages and nonbinding offers
samples:readRead and download sample files explicitly cleared for this account
samples:writeUpload prepared samples for your own corpus

Operations

68 operations. Each schema below is generated from the same registry used by HTTP and MCP.

market_statusRead

Read buyer qualification, operator status and marketplace counts.

Required permissions: market:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
market_corpora_listRead

Read your own corpus drafts and publication history.

Required permissions: market:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
market_corpus_seedRead

Build an unpublished corpus draft from your included aggregate inventory. Internal notes and excluded sources are omitted.

Required permissions: inventory:read, questionnaires:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
market_corpus_saveWrite

Save your corpus draft; does not change an approved listing.

Required permissions: market:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "corpus": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "minLength": 5,
          "maxLength": 160
        },
        "sector": {
          "type": "string",
          "minLength": 2,
          "maxLength": 120
        },
        "summary": {
          "type": "string",
          "minLength": 20,
          "maxLength": 2500
        },
        "geography": {
          "type": "string",
          "maxLength": 200
        },
        "languages": {
          "type": "string",
          "maxLength": 200
        },
        "teamSize": {
          "type": "string",
          "maxLength": 80
        },
        "systems": {
          "maxItems": 60,
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          }
        },
        "sources": {
          "maxItems": 100,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "source": {
                "type": "string",
                "minLength": 1,
                "maxLength": 150
              },
              "count": {
                "type": "string",
                "pattern": "^(?:|\\d{1,12}(?:\\.\\d{1,2})?)$"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "records",
                  "messages",
                  "files",
                  "repositories",
                  "rows",
                  "hours"
                ]
              },
              "gb": {
                "type": "string",
                "pattern": "^(?:|\\d{1,12}(?:\\.\\d{1,9})?)$"
              },
              "from": {
                "type": "string",
                "maxLength": 10
              },
              "to": {
                "type": "string",
                "maxLength": 10
              },
              "basis": {
                "type": "string",
                "enum": [
                  "Measured",
                  "Partial",
                  "Estimate",
                  "Unavailable",
                  "Not checked"
                ]
              },
              "rights": {
                "default": "Not reviewed",
                "type": "string",
                "enum": [
                  "Not reviewed",
                  "Company-owned",
                  "Permission documented"
                ]
              }
            },
            "required": [
              "source",
              "count",
              "unit",
              "gb",
              "from",
              "to",
              "basis",
              "rights"
            ],
            "additionalProperties": false
          }
        },
        "workflows": {
          "maxItems": 20,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string",
                "minLength": 2,
                "maxLength": 160
              },
              "sequence": {
                "type": "string",
                "minLength": 10,
                "maxLength": 1500
              },
              "outcome": {
                "type": "string",
                "maxLength": 1000
              },
              "linkage": {
                "type": "string",
                "enum": [
                  "Not checked",
                  "Partial",
                  "Demonstrated"
                ]
              },
              "basis": {
                "type": "string",
                "enum": [
                  "Proposed use",
                  "Sample evidence",
                  "Tested task"
                ]
              }
            },
            "required": [
              "title",
              "sequence",
              "outcome",
              "linkage",
              "basis"
            ],
            "additionalProperties": false
          }
        },
        "formats": {
          "type": "string",
          "maxLength": 500
        },
        "coverageNotes": {
          "type": "string",
          "maxLength": 1500
        },
        "rightsSummary": {
          "type": "string",
          "maxLength": 1500
        },
        "exclusions": {
          "type": "string",
          "maxLength": 1500
        },
        "permittedUses": {
          "type": "string",
          "maxLength": 1000
        },
        "readiness": {
          "type": "string",
          "enum": [
            "Metadata only",
            "Preparing a sample",
            "Sample ready",
            "Delivery ready"
          ]
        },
        "indicativePrice": {
          "type": "string",
          "pattern": "^(?:|\\d{1,12}(?:\\.\\d{1,2})?)$"
        },
        "exclusivePrice": {
          "type": "string",
          "pattern": "^(?:|\\d{1,12}(?:\\.\\d{1,2})?)$"
        },
        "licenseTerm": {
          "type": "string",
          "maxLength": 200
        },
        "exclusivity": {
          "type": "string",
          "maxLength": 500
        },
        "priorLicensing": {
          "type": "string",
          "maxLength": 500
        }
      },
      "required": [
        "title",
        "sector",
        "summary",
        "geography",
        "languages",
        "teamSize",
        "systems",
        "sources",
        "workflows",
        "formats",
        "coverageNotes",
        "rightsSummary",
        "exclusions",
        "permittedUses",
        "readiness",
        "indicativePrice",
        "exclusivePrice",
        "licenseTerm",
        "exclusivity",
        "priorLicensing"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "operationId",
    "expectedRevision",
    "id",
    "corpus"
  ],
  "additionalProperties": false
}
market_corpus_submitFirst-party session

Submit the exact saved draft for review and attest authority over its proposed metadata and sample scope.

Required permissions: market:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "attestation": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "operationId",
    "expectedRevision",
    "id",
    "attestation"
  ],
  "additionalProperties": false
}
market_corpus_withdrawFirst-party session

Withdraw your listing and suspend sample access.

Required permissions: market:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "operationId",
    "expectedRevision",
    "id"
  ],
  "additionalProperties": false
}
market_catalogRead

Search approved profiles by workflow, sector, systems and content. Qualified buyers only.

Required permissions: market:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "query": {
      "default": "",
      "type": "string",
      "maxLength": 1000
    },
    "sector": {
      "default": "",
      "type": "string",
      "maxLength": 1000
    },
    "system": {
      "default": "",
      "type": "string",
      "maxLength": 1000
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "required": [
    "query",
    "sector",
    "system",
    "offset",
    "limit"
  ],
  "additionalProperties": false
}
market_corpus_getRead

Read an approved corpus or your own draft, sample manifest and current access requirements.

Required permissions: market:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}
market_buyer_saveWrite

Submit your organization and intended use for buyer review. Does not approve the account or sign an NDA.

Required permissions: market:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "profile": {
      "type": "object",
      "properties": {
        "organization": {
          "type": "string",
          "minLength": 2,
          "maxLength": 200
        },
        "website": {
          "type": "string",
          "maxLength": 1500
        },
        "purpose": {
          "type": "string",
          "minLength": 20,
          "maxLength": 2000
        },
        "capabilities": {
          "type": "string",
          "maxLength": 1500
        },
        "timeline": {
          "type": "string",
          "maxLength": 200
        },
        "budget": {
          "type": "string",
          "maxLength": 300
        },
        "jurisdiction": {
          "type": "string",
          "minLength": 2,
          "maxLength": 200
        }
      },
      "required": [
        "organization",
        "website",
        "purpose",
        "capabilities",
        "timeline",
        "budget",
        "jurisdiction"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "operationId",
    "expectedRevision",
    "profile"
  ],
  "additionalProperties": false
}
market_shortlist_setWrite

Add or remove one approved corpus from your private shortlist.

Required permissions: market:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "corpusId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "saved": {
      "type": "boolean"
    }
  },
  "required": [
    "operationId",
    "corpusId",
    "saved"
  ],
  "additionalProperties": false
}
market_shortlist_listRead

Read your shortlist; withdrawn corpora are omitted.

Required permissions: market:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
market_inquireWrite

Create or reuse active inquiries for up to twenty approved corpora. No purchase commitment.

Required permissions: market:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "corpusIds": {
      "minItems": 1,
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
      }
    },
    "message": {
      "type": "string",
      "minLength": 5,
      "maxLength": 3000
    }
  },
  "required": [
    "operationId",
    "corpusIds",
    "message"
  ],
  "additionalProperties": false
}
market_deals_listRead

Read deals where you are buyer or supplier; operators can read the review queue.

Required permissions: market:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
market_deal_getRead

Read one permitted deal with messages and its audit history.

Required permissions: market:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}
market_message_sendWrite

Send a message in a deal you participate in. Visible to both parties and the team.

Required permissions: market:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "body": {
      "type": "string",
      "minLength": 1,
      "maxLength": 5000
    }
  },
  "required": [
    "operationId",
    "id",
    "body"
  ],
  "additionalProperties": false
}
market_offerWrite

Record a nonbinding buyer offer or supplier quote with history. Does not accept terms.

Required permissions: market:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "amount": {
      "type": "string",
      "pattern": "^\\d{1,12}(?:\\.\\d{1,2})?$"
    },
    "note": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "operationId",
    "expectedRevision",
    "id",
    "amount",
    "note"
  ],
  "additionalProperties": false
}
market_deal_updateFirst-party session

Record commercial terms, ownership and next action. Delivery, acceptance and payment require the corresponding party and evidence.

Required permissions: market:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "stage": {
      "type": "string",
      "enum": [
        "inquiry",
        "sample",
        "negotiation",
        "agreement",
        "preparing",
        "delivered",
        "accepted",
        "paid",
        "declined",
        "withdrawn"
      ]
    },
    "terms": {
      "type": "object",
      "properties": {
        "buyerPrice": {
          "type": "string",
          "pattern": "^(?:|\\d{1,12}(?:\\.\\d{1,2})?)$"
        },
        "brokerFee": {
          "type": "string",
          "pattern": "^(?:|\\d{1,12}(?:\\.\\d{1,2})?)$"
        },
        "otherDeductions": {
          "type": "string",
          "pattern": "^(?:|\\d{1,12}(?:\\.\\d{1,2})?)$"
        },
        "paymentStructure": {
          "type": "string",
          "enum": [
            "Not agreed",
            "Fixed",
            "Milestones",
            "Contingent on resale",
            "Revenue share"
          ]
        },
        "scope": {
          "type": "string",
          "maxLength": 2000
        },
        "uses": {
          "type": "string",
          "maxLength": 1500
        },
        "exclusivity": {
          "type": "string",
          "maxLength": 1000
        },
        "term": {
          "type": "string",
          "maxLength": 300
        },
        "acceptance": {
          "type": "string",
          "maxLength": 1500
        },
        "paymentTrigger": {
          "type": "string",
          "maxLength": 1000
        },
        "preparation": {
          "type": "string",
          "maxLength": 1000
        },
        "agreementReference": {
          "type": "string",
          "maxLength": 1500
        },
        "deliveryReference": {
          "type": "string",
          "maxLength": 1500
        },
        "acceptanceReference": {
          "type": "string",
          "maxLength": 1500
        },
        "paymentReference": {
          "type": "string",
          "maxLength": 1500
        }
      },
      "required": [
        "buyerPrice",
        "brokerFee",
        "otherDeductions",
        "paymentStructure",
        "scope",
        "uses",
        "exclusivity",
        "term",
        "acceptance",
        "paymentTrigger",
        "preparation",
        "agreementReference",
        "deliveryReference",
        "acceptanceReference",
        "paymentReference"
      ],
      "additionalProperties": false
    },
    "nextAction": {
      "type": "string",
      "maxLength": 1000
    },
    "actionOwner": {
      "type": "string",
      "enum": [
        "buyer",
        "seller",
        "team"
      ]
    },
    "dueAt": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "operationId",
    "expectedRevision",
    "id",
    "stage",
    "terms",
    "nextAction",
    "actionOwner",
    "dueAt"
  ],
  "additionalProperties": false
}
market_sample_uploadFirst-party session

Reserve a private prepared-sample upload, up to 5 MB. Returns a signed upload destination; never accepts full raw archives.

Required permissions: samples:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 150,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9._ -]*$"
    },
    "contentType": {
      "type": "string",
      "enum": [
        "text/plain",
        "text/csv",
        "application/json",
        "application/pdf",
        "audio/mpeg",
        "audio/wav"
      ]
    },
    "bytes": {
      "type": "integer",
      "minimum": 1,
      "maximum": 5242880
    }
  },
  "required": [
    "operationId",
    "id",
    "filename",
    "contentType",
    "bytes"
  ],
  "additionalProperties": false
}
market_sample_submitFirst-party session

Verify the stored object and submit it for sample review. It remains unavailable to buyers until cleared.

Required permissions: samples:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "attestation": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "operationId",
    "expectedRevision",
    "id",
    "attestation"
  ],
  "additionalProperties": false
}
market_sample_withdrawFirst-party session

Withdraw a sample immediately; future downloads and previews are denied.

Required permissions: samples:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "operationId",
    "expectedRevision",
    "id"
  ],
  "additionalProperties": false
}
market_sample_openRead

Open an explicitly cleared sample. Every access checks current buyer, NDA, corpus, sample and file grant; access is logged.

Required permissions: samples:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "download": {
      "default": false,
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "download"
  ],
  "additionalProperties": false
}
market_review_queueRead

Read buyer, publication, sample and access queues. Requires a trusted operator record.

Required permissions: market:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
market_review_buyerFirst-party session

Record buyer clearance and independently signed NDA evidence. Trusted operator only; never signs an agreement.

Required permissions: market:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "userId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "status": {
      "type": "string",
      "enum": [
        "approved",
        "rejected"
      ]
    },
    "note": {
      "type": "string",
      "maxLength": 1000
    },
    "ndaReference": {
      "type": "string",
      "maxLength": 1500
    },
    "ndaSignedAt": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        {
          "type": "null"
        }
      ]
    },
    "ndaExpiresAt": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "operationId",
    "expectedRevision",
    "userId",
    "status",
    "note",
    "ndaReference",
    "ndaSignedAt",
    "ndaExpiresAt"
  ],
  "additionalProperties": false
}
market_review_corpusFirst-party session

Publish the exact owner-submitted draft or return it for changes. Trusted operator only.

Required permissions: market:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "approved": {
      "type": "boolean"
    },
    "note": {
      "type": "string",
      "maxLength": 1000
    }
  },
  "required": [
    "operationId",
    "expectedRevision",
    "id",
    "approved",
    "note"
  ],
  "additionalProperties": false
}
market_review_sampleFirst-party session

Clear a submitted prepared sample or return it for changes. Trusted operator only.

Required permissions: market:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "approved": {
      "type": "boolean"
    },
    "note": {
      "type": "string",
      "maxLength": 1000
    }
  },
  "required": [
    "operationId",
    "expectedRevision",
    "id",
    "approved",
    "note"
  ],
  "additionalProperties": false
}
market_sample_grantFirst-party session

Grant or revoke access to an explicit set of cleared sample files. Corpus owner or trusted operator only.

Required permissions: market:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "corpusId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "buyerId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "sampleIds": {
      "maxItems": 25,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
      }
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    },
    "revoked": {
      "type": "boolean"
    },
    "reason": {
      "type": "string",
      "minLength": 5,
      "maxLength": 1000
    }
  },
  "required": [
    "operationId",
    "corpusId",
    "buyerId",
    "sampleIds",
    "expiresAt",
    "revoked",
    "reason"
  ],
  "additionalProperties": false
}
account_getRead

Return the authenticated account and current credential permissions.

Required permissions: Authenticated account.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
overview_getRead

Read saved totals, readiness gaps, progress and the next incomplete step.

Required permissions: questionnaires:read, tools:read, inventory:read, referrals:read, offers:read, access:read, checklist:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
workspace_getRead

Read the entire saved workspace. Insurance files are separate.

Required permissions: questionnaires:read, tools:read, inventory:read, referrals:read, offers:read, access:read, checklist:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
workspace_replaceFirst-party session

Save a complete workspace from the first-party portal.

Required permissions: Authenticated account.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "snapshot": {
      "type": "object",
      "properties": {
        "answers": {
          "default": {},
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "string",
            "maxLength": 5000
          }
        },
        "tools": {
          "default": [],
          "maxItems": 500,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 500
          }
        },
        "completed": {
          "default": [],
          "maxItems": 30,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 500
          }
        },
        "inventory": {
          "default": [],
          "maxItems": 500,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "maxLength": 500
              },
              "tool": {
                "type": "string",
                "minLength": 1,
                "maxLength": 500
              },
              "count": {
                "type": "string",
                "maxLength": 30
              },
              "unit": {
                "type": "string",
                "enum": [
                  "records",
                  "messages",
                  "files",
                  "repositories",
                  "rows",
                  "hours"
                ]
              },
              "gb": {
                "type": "string",
                "maxLength": 30
              },
              "contributors": {
                "type": "string",
                "maxLength": 30
              },
              "contributorBasis": {
                "type": "string",
                "enum": [
                  "Not checked",
                  "Measured",
                  "Partial",
                  "Estimate",
                  "Unavailable"
                ]
              },
              "from": {
                "type": "string",
                "maxLength": 500
              },
              "to": {
                "type": "string",
                "maxLength": 500
              },
              "basis": {
                "type": "string",
                "enum": [
                  "Not checked",
                  "Measured",
                  "Partial",
                  "Estimate",
                  "Unavailable"
                ]
              },
              "owner": {
                "type": "string",
                "enum": [
                  "Unknown",
                  "Company-owned",
                  "Mixed / review",
                  "Excluded"
                ]
              },
              "notes": {
                "type": "string",
                "maxLength": 2500
              }
            },
            "required": [
              "id",
              "tool",
              "count",
              "unit",
              "gb",
              "from",
              "to",
              "basis",
              "owner",
              "notes"
            ],
            "additionalProperties": false
          }
        },
        "referrals": {
          "default": [],
          "maxItems": 100,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "maxLength": 500
              },
              "buyer": {
                "type": "string",
                "maxLength": 500
              },
              "code": {
                "type": "string",
                "maxLength": 500
              },
              "link": {
                "type": "string",
                "maxLength": 1500
              },
              "payee": {
                "type": "string",
                "maxLength": 500
              },
              "attribution": {
                "type": "string",
                "enum": [
                  "Not confirmed",
                  "Confirmed in writing",
                  "Registered",
                  "Not applicable"
                ]
              },
              "notes": {
                "type": "string",
                "maxLength": 2500
              }
            },
            "required": [
              "id",
              "buyer",
              "code",
              "link",
              "payee",
              "attribution",
              "notes"
            ],
            "additionalProperties": false
          }
        },
        "offers": {
          "default": [],
          "maxItems": 100,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "maxLength": 500
              },
              "buyer": {
                "type": "string",
                "maxLength": 500
              },
              "amount": {
                "type": "string",
                "maxLength": 30
              },
              "status": {
                "type": "string",
                "enum": [
                  "Indicative",
                  "Written offer",
                  "Signed",
                  "Scheduled",
                  "Paid",
                  "Declined"
                ]
              },
              "scope": {
                "type": "string",
                "maxLength": 2500
              },
              "fee": {
                "type": "string",
                "maxLength": 30
              },
              "exclusivity": {
                "type": "string",
                "maxLength": 500
              },
              "trigger": {
                "type": "string",
                "maxLength": 500
              },
              "due": {
                "type": "string",
                "maxLength": 500
              },
              "notes": {
                "type": "string",
                "maxLength": 2500
              }
            },
            "required": [
              "id",
              "buyer",
              "amount",
              "status",
              "scope",
              "fee",
              "exclusivity",
              "trigger",
              "due",
              "notes"
            ],
            "additionalProperties": false
          }
        },
        "access": {
          "default": [],
          "maxItems": 100,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "maxLength": 500
              },
              "tool": {
                "type": "string",
                "maxLength": 500
              },
              "recipient": {
                "type": "string",
                "maxLength": 500
              },
              "scope": {
                "type": "string",
                "maxLength": 1500
              },
              "owner": {
                "type": "string",
                "maxLength": 500
              },
              "expiry": {
                "type": "string",
                "maxLength": 500
              },
              "status": {
                "type": "string",
                "enum": [
                  "Not requested",
                  "Scope agreed",
                  "Access requested",
                  "Read-only verified",
                  "Revoked"
                ]
              },
              "evidence": {
                "type": "string",
                "maxLength": 1500
              }
            },
            "required": [
              "id",
              "tool",
              "recipient",
              "scope",
              "owner",
              "expiry",
              "status",
              "evidence"
            ],
            "additionalProperties": false
          }
        },
        "updatedAt": {
          "default": "",
          "type": "string"
        }
      },
      "required": [
        "answers",
        "tools",
        "completed",
        "inventory",
        "referrals",
        "offers",
        "access",
        "updatedAt"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "expectedRevision",
    "operationId",
    "snapshot"
  ],
  "additionalProperties": false
}
workspace_resetWrite

Clear all workspace metadata; keep policy files and API credentials.

Required permissions: questionnaires:write, tools:write, inventory:write, referrals:write, offers:write, access:write, checklist:write, workspace:delete.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "expectedRevision",
    "operationId"
  ],
  "additionalProperties": false
}
questionnaires_listRead

List all questionnaire definitions, field types, options and conditional visibility.

Required permissions: Authenticated account.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
questionnaires_getRead

Read answers for one questionnaire or all questionnaires. Includes hidden answers.

Required permissions: questionnaires:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "section": {
      "type": "string",
      "maxLength": 100
    }
  },
  "additionalProperties": false
}
questionnaires_patchWrite

Patch known questionnaire fields. Use null to clear an answer. Dates, numbers and choices are validated.

Required permissions: questionnaires:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "answers": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "type": "null"
          }
        ]
      }
    }
  },
  "required": [
    "expectedRevision",
    "operationId",
    "answers"
  ],
  "additionalProperties": false
}
tools_catalogRead

Search the complete tool catalog by tool or category name.

Required permissions: Authenticated account.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "query": {
      "default": "",
      "type": "string",
      "maxLength": 200
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}
tools_getRead

Read the selected current and historical tools.

Required permissions: tools:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
tools_setWrite

Replace selected tools, including custom names. Preserve inventory for deselected tools; add blank rows for new tools.

Required permissions: tools:write, inventory:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "tools": {
      "maxItems": 500,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      }
    }
  },
  "required": [
    "expectedRevision",
    "operationId",
    "tools"
  ],
  "additionalProperties": false
}
inventory_listRead

List inventory, optionally filtered to sources needing counts, rights review or excluded sources.

Required permissions: inventory:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "filter": {
      "default": "all",
      "type": "string",
      "enum": [
        "all",
        "needs_count",
        "rights_review",
        "excluded"
      ]
    }
  },
  "required": [
    "filter"
  ],
  "additionalProperties": false
}
inventory_importWrite

Import 1–100 aggregate inventory rows additively. Populated rows are never silently replaced.

Required permissions: inventory:write, tools:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "json": {
      "type": "string",
      "maxLength": 250000
    }
  },
  "required": [
    "expectedRevision",
    "operationId",
    "json"
  ],
  "additionalProperties": false
}
checklist_getRead

Read all milestones, computed completion and prerequisite availability.

Required permissions: checklist:read, questionnaires:read, tools:read, inventory:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
checklist_setWrite

Set one manual milestone. Clearing prerequisites clears dependent completions. This does not sign, deliver or pay anything.

Required permissions: checklist:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "step": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "completed": {
      "type": "boolean"
    }
  },
  "required": [
    "expectedRevision",
    "operationId",
    "step",
    "completed"
  ],
  "additionalProperties": false
}
prompts_listRead

List inventory prompts and their complete instructions. Copying does not connect or run a tool.

Required permissions: Authenticated account.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
prompts_getRead

Read one inventory prompt.

Required permissions: Authenticated account.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}
catalog_getRead

Start or resume company data cataloging: read company basics, source progress, paginated source rows and the current revision. Excludes deals and insurance answers.

Required permissions: questionnaires:read, tools:read, inventory:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "tool": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "required": [
    "offset",
    "limit"
  ],
  "additionalProperties": false
}
catalog_taskRead

Return the guided cataloging task used by the portal. Reads and saves aggregate counts through permitted MCP tools; never claims source-system access.

Required permissions: Authenticated account.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
guides_listRead

List export guides for selected tools, or browse all verified provider guides.

Required permissions: tools:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "selectedOnly": {
      "default": true,
      "type": "boolean"
    }
  },
  "required": [
    "selectedOnly"
  ],
  "additionalProperties": false
}
guides_getRead

Read manual export steps, screenshots, coverage limits and official sources for a tool. Unlisted tools get a labeled general guide.

Required permissions: tools:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "tool": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "tool"
  ],
  "additionalProperties": false
}
guides_taskRead

Build a Claude Code catalog or local-export task for one tool, or all selected tools. No keys or raw company records are included.

Required permissions: tools:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "tool": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "mode": {
      "default": "catalog",
      "type": "string",
      "enum": [
        "catalog",
        "export"
      ]
    }
  },
  "required": [
    "mode"
  ],
  "additionalProperties": false
}
help_listRead

Search public portal help articles and the onboarding walkthrough.

Required permissions: Authenticated account.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "query": {
      "default": "",
      "type": "string",
      "maxLength": 200
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}
help_getRead

Read a complete portal help article, including screenshots and links. No company data is included.

Required permissions: Authenticated account.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "slug"
  ],
  "additionalProperties": false
}
resources_listRead

List original research and buyer-discovery links.

Required permissions: Authenticated account.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
exports_getRead

Generate a private JSON workspace, inventory CSV or buyer brief. Returns content, filename and MIME type.

Required permissions: questionnaires:read, tools:read, inventory:read, referrals:read, offers:read, access:read, checklist:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "format": {
      "type": "string",
      "enum": [
        "workspace_json",
        "inventory_csv",
        "buyer_brief"
      ]
    }
  },
  "required": [
    "format"
  ],
  "additionalProperties": false
}
policies_listRead

List this account’s private insurance documents. No file contents are returned.

Required permissions: policies:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
policies_upload_urlWrite

Create an upload URL for a PDF/DOC/DOCX insurance document up to 20 MB. PUT the file directly to the returned URL.

Required permissions: policies:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 150
    },
    "contentType": {
      "type": "string",
      "enum": [
        "application/pdf",
        "application/msword",
        "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
      ]
    }
  },
  "required": [
    "filename",
    "contentType"
  ],
  "additionalProperties": false
}
policies_download_urlRead

Create a private download URL for one file, valid for 60 seconds.

Required permissions: policies:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}
policies_deleteWrite

Remove one of your insurance documents. Name comes from policies_list.

Required permissions: policies:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}
audit_listRead

Read the last 50 activity entries; contents and secret values are never logged.

Required permissions: audit:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
inventory_upsertWrite

Add or replace one inventory record with a stable ID. Access status is a manual record, not a live connection.

Required permissions: inventory:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "record": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 500
        },
        "tool": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        },
        "count": {
          "type": "string",
          "maxLength": 30
        },
        "unit": {
          "type": "string",
          "enum": [
            "records",
            "messages",
            "files",
            "repositories",
            "rows",
            "hours"
          ]
        },
        "gb": {
          "type": "string",
          "maxLength": 30
        },
        "contributors": {
          "type": "string",
          "maxLength": 30
        },
        "contributorBasis": {
          "type": "string",
          "enum": [
            "Not checked",
            "Measured",
            "Partial",
            "Estimate",
            "Unavailable"
          ]
        },
        "from": {
          "type": "string",
          "maxLength": 500
        },
        "to": {
          "type": "string",
          "maxLength": 500
        },
        "basis": {
          "type": "string",
          "enum": [
            "Not checked",
            "Measured",
            "Partial",
            "Estimate",
            "Unavailable"
          ]
        },
        "owner": {
          "type": "string",
          "enum": [
            "Unknown",
            "Company-owned",
            "Mixed / review",
            "Excluded"
          ]
        },
        "notes": {
          "type": "string",
          "maxLength": 2500
        }
      },
      "required": [
        "id",
        "tool",
        "count",
        "unit",
        "gb",
        "from",
        "to",
        "basis",
        "owner",
        "notes"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "expectedRevision",
    "operationId",
    "record"
  ],
  "additionalProperties": false
}
inventory_deleteWrite

Remove one saved inventory record by ID. Underlying company systems are unchanged.

Required permissions: inventory:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "expectedRevision",
    "operationId",
    "id"
  ],
  "additionalProperties": false
}
referrals_listRead

Read your saved referrals.

Required permissions: referrals:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
referrals_upsertWrite

Add or replace one referrals record with a stable ID. Access status is a manual record, not a live connection.

Required permissions: referrals:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "record": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 500
        },
        "buyer": {
          "type": "string",
          "maxLength": 500
        },
        "code": {
          "type": "string",
          "maxLength": 500
        },
        "link": {
          "type": "string",
          "maxLength": 1500
        },
        "payee": {
          "type": "string",
          "maxLength": 500
        },
        "attribution": {
          "type": "string",
          "enum": [
            "Not confirmed",
            "Confirmed in writing",
            "Registered",
            "Not applicable"
          ]
        },
        "notes": {
          "type": "string",
          "maxLength": 2500
        }
      },
      "required": [
        "id",
        "buyer",
        "code",
        "link",
        "payee",
        "attribution",
        "notes"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "expectedRevision",
    "operationId",
    "record"
  ],
  "additionalProperties": false
}
referrals_deleteWrite

Remove one saved referrals record by ID. Underlying company systems are unchanged.

Required permissions: referrals:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "expectedRevision",
    "operationId",
    "id"
  ],
  "additionalProperties": false
}
offers_listRead

Read your saved offers.

Required permissions: offers:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
offers_upsertWrite

Add or replace one offers record with a stable ID. Access status is a manual record, not a live connection.

Required permissions: offers:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "record": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 500
        },
        "buyer": {
          "type": "string",
          "maxLength": 500
        },
        "amount": {
          "type": "string",
          "maxLength": 30
        },
        "status": {
          "type": "string",
          "enum": [
            "Indicative",
            "Written offer",
            "Signed",
            "Scheduled",
            "Paid",
            "Declined"
          ]
        },
        "scope": {
          "type": "string",
          "maxLength": 2500
        },
        "fee": {
          "type": "string",
          "maxLength": 30
        },
        "exclusivity": {
          "type": "string",
          "maxLength": 500
        },
        "trigger": {
          "type": "string",
          "maxLength": 500
        },
        "due": {
          "type": "string",
          "maxLength": 500
        },
        "notes": {
          "type": "string",
          "maxLength": 2500
        }
      },
      "required": [
        "id",
        "buyer",
        "amount",
        "status",
        "scope",
        "fee",
        "exclusivity",
        "trigger",
        "due",
        "notes"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "expectedRevision",
    "operationId",
    "record"
  ],
  "additionalProperties": false
}
offers_deleteWrite

Remove one saved offers record by ID. Underlying company systems are unchanged.

Required permissions: offers:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "expectedRevision",
    "operationId",
    "id"
  ],
  "additionalProperties": false
}
access_listRead

Read your saved access.

Required permissions: access:read.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
access_upsertWrite

Add or replace one access record with a stable ID. Access status is a manual record, not a live connection.

Required permissions: access:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "record": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 500
        },
        "tool": {
          "type": "string",
          "maxLength": 500
        },
        "recipient": {
          "type": "string",
          "maxLength": 500
        },
        "scope": {
          "type": "string",
          "maxLength": 1500
        },
        "owner": {
          "type": "string",
          "maxLength": 500
        },
        "expiry": {
          "type": "string",
          "maxLength": 500
        },
        "status": {
          "type": "string",
          "enum": [
            "Not requested",
            "Scope agreed",
            "Access requested",
            "Read-only verified",
            "Revoked"
          ]
        },
        "evidence": {
          "type": "string",
          "maxLength": 1500
        }
      },
      "required": [
        "id",
        "tool",
        "recipient",
        "scope",
        "owner",
        "expiry",
        "status",
        "evidence"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "expectedRevision",
    "operationId",
    "record"
  ],
  "additionalProperties": false
}
access_deleteWrite

Remove one saved access record by ID. Underlying company systems are unchanged.

Required permissions: access:write.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "expectedRevision",
    "operationId",
    "id"
  ],
  "additionalProperties": false
}

Errors and limits

401: authenticate again or replace an expired/revoked key. 403: insufficient permission. 409: revision or idempotency conflict. 413: request too large (1 MB maximum JSON). 415: send application/json. 422: invalid fields or workflow prerequisites. 429: 120 requests per minute per account, including MCP discovery and calls; wait for Retry-After. 503: temporary service failure; retry an uncertain write with its original operation ID.

Inventory imports accept at most 100 aggregate rows at a time; workspaces allow 500 inventory rows and 100 each of referrals, offers and access plans. The existing collection schemas enforce their field and size limits. Private documents are limited to 100 per account. Activity stores operation names, timestamps, credential IDs and revisions for up to 90 days, never payloads or file contents. Marketplace events separately retain relevant transaction details and sample-access evidence, with no file bodies or credentials.

Recorded payments, checklist completion and access status describe your records. They do not execute a payment, sign a licence, register you with a buyer or grant access to company systems.

Back to API & MCP