Submit a search
Use your existing API key. SetOVERTEN_API_KEY in your environment before
running the examples. Both X-API-Key and Authorization: Bearer are supported.
The shell examples use jq to read JSON responses.
Include enough business context for the agent to work without asking questions:
what you sell, your price range, delivery or service area, and the kind of
buyer you want. You can also include competitor links or public groups to investigate.
run_example is illustrative; use the actual run_id returned by your request.
Request fields
prompt(required): business context and search instructions, up to 10,000 characters. Empty or whitespace-only prompts are rejected.idempotency_key(optional): 1–200 characters. Reusing the key within your organization returns the original run, including its original prompt. Reuse it when retrying a submission after a network error. Use a new key for a fresh search. Without a key, every POST creates a new run.wait_seconds(optional): 0–25, default 0. Waits for the background run to reach a terminal status. The response is 200 if it finishes during the wait, or 202 if it is still queued or running. The run continues after a 202 response or after your client disconnects.
Read progress and results
Use theSALES_RUN_ID set by the submission example:
status is queued or running, counting other
requests against your plan’s rate limit too. GET returns
HTTP 200 for every visible run, including a failed run: always inspect
status and stop_reason.
queued: accepted and waiting for a worker.running: the agent is investigating.completed: execution finished. Readanswerfor the findings and coverage limits, and checkstop_reasonfor an early stopping condition.paused_budget: the organization lacked API credits at admission. Top up, then submit with a new idempotency key; the old key keeps returning the paused run.failed: execution failed. Inspectstop_reason; contact support with the run ID if needed. A deliberate retry uses a new idempotency key.cancelled: execution ended without a completed result.
completed status does not guarantee any qualified buyers.
Search modes
Every run uses one of two search modes. The response reports it insearch_mode once the run has started (null while it is still queued).
economy(default): the agent searches public Facebook groups through web search and reads only the matching posts and their recent comments. It does not read whole groups. This keeps each search inexpensive, so you can run it for many products.quality: the agent can also read the newest posts of whole public Facebook groups. This can find buyers that a search misses, for example in a busy buy-and-sell group. Quality runs read more source material, so they usually use more LLM credits and take longer.
quality, contact support. A run keeps
the mode it started with. In both modes runs are charged only for their LLM
usage, and public source costs are paid by Overten.
Understand the evidence
answer contains the agent’s written assessment: potential buyers, why they
may fit, freshness, unknowns and where it looked. evidence contains the
public source material collected during the run. It may include seller
adverts, irrelevant items or requests the agent rejects. Use the answer
for qualification rather than treating every evidence item as a lead.
Each evidence item includes:
platformandkind: where it came from and whether it is a post, comment, reply or another supported source type.text: the collected source text.urlandparent_url: the source link and containing conversation, when available. Either can be null.authorandpublished_at: the author and publication time, when supplied by the source. Either can be null.seen_before: whether an earlier sales run for your organization collected the same source item with the same text.
Complete Python example
Installrequests with python3 -m pip install requests, then run this with
OVERTEN_API_KEY set. Save the generated idempotency key with your application
job so retries can reuse it.
Authentication, credits and limits
The API key’s organization owns the run and pays for its LLM usage. Workspace keys need permission to create content. Reading another organization’s run returns 404. Submission requires at least 6 API credits. This is an admission floor, not a fixed run price or a maximum charge. Completed runs are charged from their recorded LLM usage; failed and cancelled runs are not charged. Public source-provider costs are paid by Overten, with operational spending limits. Polling and resubmitting the same idempotency key do not start another paid run. The sales response currently has nocredits_used field. Agent-turn,
tool-call, LLM-credit and source-provider limits can bound the investigation;
review answer and stop_reason for incomplete coverage.
Sales runs use the two endpoints on this page. They return an answer and
evidence directly, and support polling rather than document-task webhooks,
download links or resumable document editing. For a daily briefing, schedule
submissions in your own application, give each fresh search a new key, and
poll its sales run ID.
Errors
- 401: missing, invalid or revoked API key.
- 402: insufficient organization API credits. The error includes the
paused
run_idunderdetail. - 403: suspended organization or insufficient permissions.
- 404 on GET: unknown run or a run outside your organization.
- 422: invalid prompt, unsupported fields or out-of-range request values.
- 429: API rate limit exceeded; honor the
Retry-Afterresponse header before retrying. Reuse the submission’s idempotency key if the POST needs a retry.
detail list. Authentication errors
can have a different envelope depending on which layer rejects the request.