Preview. Part of the Migration API — in active design and not yet generally
available. Endpoints and payloads may change. See the
overview.
blocked instead of guessing. The
poll response then carries plain-language
questions for you to render in your own product, and this endpoint is how
you send the answer back.
Nothing is changed while a run waits here. The agent is suspended; your answer
(or free-form correction) is what resumes it.
Authentication
Requires anx-api-key header. See Authentication.
What you get to render
Ablocked poll response looks like this:
Stable identifier you echo back in your answer.
The question, in plain language. Show it as the field label.
Suggested answers, each
{ id, label }. Render them as choices (radio buttons,
a select, buttons). May be empty for an open-ended question.When
true, let the customer type a free-text answer instead of picking an
option.Answering
Send one entry per question inanswers, each with the question’s id and a
value. The value is either an option’s label (the choice the customer
picked) or free text (when allowCustom is true).
One
{ id, value } per question you’re answering. id matches the question;
value is the chosen option’s label or a free-text answer.completed; if another mapping is still ambiguous, it blocks again with a fresh
question — keep polling and answering until it’s
terminal.
Free-form corrections
You don’t have to wait for a question. At any point you can send a plain instruction to steer or correct the run — for example to override a mapping the agent chose — and it will incorporate it:Response
200 OK
poll_url until the run reaches a
terminal status.
Errors
| Status | Meaning |
|---|---|
400 | Malformed body, or an answer references an unknown question id. |
401 | API key missing or invalid. |
404 | No such run, or the company isn’t in your account. |
409 | The run isn’t blocked (already resumed, or never paused) — except a free-form correction, which a running run accepts. |
429 | Rate limit hit — back off and retry. |
500 | Server error. |
Example
Next
- Poll an import — track the resumed run.
- Export CSV — get the validated rows out.