styleAgentTerminology

Import an Acrolinx terminology XML database dump. Maximum file size: 100MB.

This replaces all existing terminology in the organization. Every term, category, and custom field is removed and rebuilt from the file.

Returns immediately with a job to poll via GET /jobs/{job_id} or GET /jobs/current; the import continues in the background and can take several minutes for a large dump. A file that fails validation is reported on the job as a failure, not on this response.

Returns 413 if the file exceeds the size limit, and 409 if a publish or import is already in progress — only one runs per organization at a time.

post/style-agent/terminology/import/xml-dump

Request

  • Base URL
    https://api.markup.ai
  • URL
    https://api.markup.ai/style-agent/terminology/import/xml-dump
  • Auth
    HTTP bearer

Request body multipart/form-data

filestring binary required

Response

Successful Response

idstring uuid required
job_typestring required

Either publish or import.

statusstring required

One of queued, running, succeeded, failed, or canceled. The first two mean the job is still holding the lock.

stagestring nullable

Coarse progress label while running; null once finished.

started_bystring nullable

Who started the job, for display.

started_atstring date-time required
finished_atstring date-time nullable
errorstring nullable

Why the job failed; null unless status is failed.

term_countinteger nullable

Terms published, for a successful publish.

statsobject nullable

Per-record-type counts, for a successful import.

Changes