Skip to content
Vendorica Developer Docs

Match a portal-page snippet to the best (question, draft) pair in the active import

POST
/iq-extension/match
curl --request POST \
  --url https://api.vendorica.com/v1/iq-extension/match \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "activeImportId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "contextText": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

Active import id + portal-page text snippet

Media typeapplication/json
object
activeImportId
required
string format: uuid
contextText
required
string
>= 1 characters <= 4000 characters
Examplegenerated
{
  "activeImportId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "contextText": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
success
required
boolean
data
required
object
question
required
object
id
required
string format: uuid
importId
required
string format: uuid
ordinal
required
integer
questionText
required
string
sourceSection
required
string | null
key
additional properties
draft
required
object
id
required
string format: uuid
questionId
required
string format: uuid
status
required
string
draftAnswer
required
string | null
editedAnswer
required
string | null
key
additional properties
score
required
number
<= 1
timestamp
required
string format: date-time
requestId
string
message
string
Example
{
  "success": true,
  "data": {
    "question": {
      "id": "9309eac7-3d9c-441f-897d-281430061130",
      "importId": "91d91934-cec2-4002-8d7b-11931fbcb0b5",
      "ordinal": 1,
      "questionText": "string",
      "sourceSection": "string"
    },
    "draft": {
      "id": "88e69f36-b70c-4edc-87de-190d6ba1692b",
      "questionId": "feed2416-634f-4b7c-859d-58ed2fb2f6cb",
      "status": "string",
      "draftAnswer": "string",
      "editedAnswer": "string"
    },
    "score": 0
  },
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H",
  "message": "string"
}

400

Section titled “400”

Validation error

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Bad request",
  "code": "BAD_REQUEST",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Unauthorized",
  "code": "UNAUTHORIZED",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}

403

Section titled “403”

Forbidden — missing scope

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Forbidden",
  "code": "FORBIDDEN",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Resource not found",
  "code": "NOT_FOUND",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Too many requests",
  "code": "TOO_MANY_REQUESTS",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}