FounderMCPDocs

API reference

Resolve a search

Chooses the event when a search is `requires_action`. A name is never guessed: even one candidate waits for this call, or for a new search that sends `signal.event.event_id`. The choice expires after 24 hours (`status` `expired`). The call answers **202** and the search continues.

POSThttps://foundermcp.dev/api/v1/searches/{search_id}/resolve
View Markdown

Chooses the event when a search is requires_action. A name is never guessed: even one candidate waits for this call, or for a new search that sends signal.event.event_id. The choice expires after 24 hours (status expired). The call answers 202 and the search continues.

Authentication

Send Authorization: Bearer gtk_…. Create the key under API Access → API Keys. A missing, invalid or revoked key is 401, including while this API is closed. A valid key while the API is closed for your organization answers 404, the same body as an unknown path. Every response includes FounderMCP-Api-Version and FounderMCP-Request-Id.

Path parameters

  • search_id string · required — The search that is waiting.

Headers

  • Idempotency-Key string · required — Required on this call. The same key and the same body replay the first response for 24 hours (Idempotent-Replayed: true). The same key with a different body is 409 idempotency_conflict.

Body parameters

  • event_id string · required — One event_id from required_action.candidates (evt_…).

Response

  • id string · required — Search id, srch_….
  • object string · required — Always search. One of: search.
  • status string · required — Where the search is. One of: queued, running, requires_action, succeeded, failed, cancelled, expired.
  • mode string · required — raw or screened. One of: raw, screened.
  • signal_type string · required — The signal you asked for. One of: linkedin_engagement, social_listening, funding_raised, new_in_role, events, tech_adoption.
  • progress object | null — stage and message while it runs.
  • result object | null — Set when status is succeeded. Screened: exact, just_outside, total_estimate, max_leads_applied. Raw: rows, has_more, next_cursor.
  • credits object · required — charged, reserved (worst case while open, 0 when finished) and max_credits.
  • required_action object | null — Set on requires_action: type choose_event, candidates (up to 5) and expires_at (24 hours).
  • error object | null — Set when status is failed: type, message, retryable.
  • request object · required — The body as validated, with defaults filled in.

Credits

The choice itself is free. Leads delivered after it are charged at the screened prices: 20 exact, 5 just outside. Errors and empty lookups are free. A call that spent credits puts that number in credits_used, in X-Credits-Used and in X-Credits-Charged. When the wallet can be read, the response also sends X-Credits-Remaining.

Errors

  • 400 invalid_request — The body is not valid JSON, a field is unknown or has the wrong type, or a value is not allowed.
  • 401 authentication_error — The Authorization header is missing, or the key is unknown or revoked.
  • 403 permission_error — API access is not part of your plan, or your account is suspended.
  • 404 not_found — The endpoint does not exist.
  • 429 rate_limit_error — More than 60 requests per minute, or more than 3 at the same time, on one key. Wait for the Retry-After header.
  • 429 daily_limit_reached — The request could take your organization over its daily credit limit. The limit resets at midnight (Europe/Brussels).
  • 402 insufficient_credits — The credit balance is lower than this request could cost. Nothing was charged. Add credits, or send a smaller request. The error includes code, fix and a link to the credits docs.
  • 502 upstream_error — The data source did not answer. Retry later.
  • 503 service_unavailable — The API is temporarily unavailable. Retry later.
  • 500 internal_error — Something went wrong on our side.
  • 402 max_credits_exceeded — max_credits is lower than the credits of the first row, so nothing could be returned. Nothing was charged; raise max_credits or ask for fewer rows.
  • 409 idempotency_conflict — The Idempotency-Key was already used with another request body.
  • 409 idempotency_in_progress — The first request with this Idempotency-Key is still being processed. Wait for the Retry-After header.
  • 422 unresolvable_input — A company, person or event in the request does not exist or cannot be found.

Example

cURL

curl -X POST "https://foundermcp.dev/api/v1/searches/srch_01J9Z6P8C8V0K3W6T2N8R5M1XA/resolve" \
  -H "Authorization: Bearer $FOUNDERMCP_API_KEY" \
  -H "Idempotency-Key: idem-1" \
  -H "Content-Type: application/json" \
  -d '{
    "event_id": "evt_01J9Z6P8C8V0K3W6T2N8R5M1XC"
  }'

JavaScript

const response = await fetch('https://foundermcp.dev/api/v1/searches/srch_01J9Z6P8C8V0K3W6T2N8R5M1XA/resolve', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.FOUNDERMCP_API_KEY}`,
    'Idempotency-Key': 'idem-1',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "event_id": "evt_01J9Z6P8C8V0K3W6T2N8R5M1XC"
  })
});
const body = await response.json();

Python

import json
import os
import urllib.request

payload = {
  "event_id": "evt_01J9Z6P8C8V0K3W6T2N8R5M1XC"
}

request = urllib.request.Request(
    "https://foundermcp.dev/api/v1/searches/srch_01J9Z6P8C8V0K3W6T2N8R5M1XA/resolve",
    headers={
    "Authorization": f"Bearer {os.environ['FOUNDERMCP_API_KEY']}",
    "Idempotency-Key": "idem-1",
    "Content-Type": "application/json"
    },
    data=json.dumps(payload).encode(),
    method="POST",
)
with urllib.request.urlopen(request) as response:
    body = json.load(response)

Example response

{
  "id": "srch_01J9Z6P8C8V0K3W6T2N8R5M1XA",
  "object": "search",
  "status": "running",
  "signal_type": "events",
  "required_action": null,
  "credits": {
    "charged": 0,
    "reserved": 200,
    "max_credits": null
  }
}