nexqdata/ docs

Errors

One error envelope, meaningful status codes, and stable error codes.

Every error returns the same envelope — a readable message for people, and a stable errorCode for your code to branch on:

404 Not Found
{
  "success": false,
  "message": "Run not found.",
  "errorCode": "RUN_NOT_FOUND"
}

Branch on errorCode (and the status), not on message — messages are written for people and can change.

Status codes

StatusWhen
400 Bad RequestThe request is invalid, or the action can't be done right now. message says why.
401 UnauthorizedThe API key is missing, malformed, or revoked.
402 Payment RequiredThe data exists, but the run's final payment hasn't settled.
403 ForbiddenThe key is valid but lacks the permission — or, for pipelines, you aren't allowed that pipeline.
404 Not FoundThe resource doesn't exist, or you don't have access to it.
410 GoneThe file existed but was removed by your retention period. Retrying won't help.
429 Too Many RequestsRate limited. Wait Retry-After seconds.
500 Internal Server ErrorSomething went wrong on our side. Retry with backoff, and include the response's correlationId if you contact us.

Error codes

CodeStatusMeaning
RUN_START_FAILED400run couldn't start the agent; message says why. start-job returns 400 with a message and no code.
INVALID_STATE400The state filter isn't all, active, succeeded, or failed.
INVALID_ATTENTION_FILTER400attention isn't tracked or ignored, or was used without state=failed.
NO_FILE_EXPORT400The run produced no file.
INVALID_ACCESS_POLICY400The dataset can't be shared that way — for example, your account has no company.
INVALID_SAVED_QUERY400The saved query is invalid; message says why.
PAYMENT_REQUIRED402The run's final payment hasn't settled.
FORBIDDEN403You aren't allowed this pipeline.
AGENT_NOT_FOUND404No such agent, or it isn't assigned to you.
RUN_NOT_FOUND404No such run, or no access to it.
JOB_NOT_FOUND404No such job, or no access to it.
GROUP_NOT_FOUND404No such group — or, for an edit, not one you can manage.
GROUP_RUN_NOT_FOUND404No such group run, or no access to it.
PIPELINE_NOT_FOUND404No such pipeline — or, for an edit, not one you can manage.
PIPELINE_RUN_NOT_FOUND404No such pipeline run, or no access to it.
NOT_FOUND404No such schedule, group member, or run to retry.
DATASET_NOT_FOUND404No such dataset, or no access to it.
DATASET_FILE_NOT_FOUND404The dataset's file isn't available.
DATASETS_NOT_FOUND404None of the datasets in a bulk export have a file available.
EXPORT_NOT_FOUND404No such stored dataset, or not one you can delete.
SAMPLE_OUTPUT_NOT_FOUND404The agent has no sample output.
API_KEY_NOT_FOUND404No such key among yours.
EXPORT_EXPIRED410Removed by retention.
BULK_EXPORT_CAPACITY_EXCEEDED429A bulk export is already running for your account or company. Retry after Retry-After.

Retrying

  • Retry 429 (after Retry-After) and 5xx (with exponential backoff).
  • Don't retry 400, 401, 403, 404, or 410 unchanged — the same request will fail the same way.

On this page