Prospect API

Bearer credentials, created on the API credentials page in the app. The secret is shown once.

curl -s -H 'Authorization: Bearer pxk_xxxxxxxx_…' \
  'https://prospex.ch/api/v1/prospect/projects'

Every response carries request_id in the body and in X-Request-Id, plus X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Every call is recorded in your project's audit history with the credential name and that request id.

Scopes

Approving is a scope of its own because it releases customer-facing copy into downstream work: a read or run credential cannot approve a bundle. prospect:stages permits reading, claiming and completing configured external stage jobs.

Routes

Project creation and offering editing stay in the browser.

.../research requests research using the project's configured executor. External output enters only through a named stage job's /results, which binds it to the right input snapshot and upstream revisions.

Mutations

• Every mutation needs an Idempotency-Key header.
• The same key with the same request returns the original response byte for byte, with Idempotency-Replayed: true, and spends no second research unit.
• The same key with a different request answers 422 idempotency_conflict.
• Work that runs in the background answers 202 with the cycle.
• Starting a cycle when one is already queued or running answers 200 with that cycle when your request names no new prospects. Naming new prospects answers 409 with the blocking cycle attached.
• Adding companies resolves identity and consumes no research unit. At most 100 per request.
• An ambiguous identity comes back as a structured resolution with the candidates.
• Approving names both the outreach revision and the content fingerprint you reviewed. A fingerprint that belongs to a different revision is refused.

10,000 requests per account per day.

Errors

{
  "error": {
    "code": "validation_failed",
    "message": "…",
    "errors": [{"code": "evidence_reference_missing", "field": "claims[1].evidence_ids", "detail": "…"}]
  },
  "request_id": "req_…"
}