Refine an AI Finder preview

curl --request POST \
  --url https://openapi.enginy.ai/v1/ai-finder/previews/{previewId}/iterate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "feedback": "Focus on US companies only, exclude agencies"
}
'

{
  "message": "<string>",
  "data": {
    "previewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "userInput": "<string>",
    "result": {},
    "droppedFilters": [
      "<string>"
    ],
    "previousPreviewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

AI Finder

Refine an AI Finder preview

What it does. Takes an existing previewId plus a natural-language feedback string (e.g. “exclude agencies”, “only US companies”, “narrow to 50–500 employees”) and runs a NEW AI search that combines the original query with your refinement. Returns a brand-new previewId; the original preview is untouched and still valid.

When to use. Call this after you’ve reviewed the result of a preview and want to tighten the filters before importing. You can chain iterations — each iterate call returns a new previewId you can iterate on again.

Provider. The new preview uses the SAME provider as the one being refined — you don’t re-pick the provider. If the original preview used AUTO, the refined one also uses AUTO (the AI may still route to the same or a different provider, based on the combined query).

What you get back. Same shape as POST /v1/ai-finder/previews, plus a previousPreviewId field pointing at the preview you refined. Use this new previewId with the iterate or import endpoint.

Required scope: ACTIONS_WRITE

Rate limit: 10 requests per minute

POST

ai-finder

previews

{previewId}

iterate

Refine an AI Finder preview

curl --request POST \
  --url https://openapi.enginy.ai/v1/ai-finder/previews/{previewId}/iterate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "feedback": "Focus on US companies only, exclude agencies"
}
'

{
  "message": "<string>",
  "data": {
    "previewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "userInput": "<string>",
    "result": {},
    "droppedFilters": [
      "<string>"
    ],
    "previousPreviewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

x-api-key

string

header

required

Path Parameters

previewId

string

required

The previewId returned by a prior preview or iterate call.

Body

application/json

feedback

string

required

Refinement instruction. Appended to the original query and re-run through AI Finder. Examples: "focus on US only", "exclude agencies", "narrow to 50-500 employees", "include VP and SVP titles only". Returns a NEW previewId; the prior preview stays cached and is still valid. 1–2000 characters.

Required string length: 1 - 2000

Response

Refined preview generated

status

enum<string>

required

Available options:

success

message

string

required

data

object

required

Show child attributes

Preview an AI Finder search Import an AI Finder preview

Documentation Index

Authorizations

Path Parameters

Body

Response