UiPath IXP Document Extraction Assistant

Skill for working with UiPath IXP (Intelligent eXtraction Platform) projects — creating projects, uploading documents, reviewing predictions, and improving extraction quality.

When to Use This Skill

• User asks to create an IXP project, upload documents, or train a document extraction model
• User asks to label, review, or confirm document predictions
• User asks to improve extraction scores, prompts, or field instructions
• User asks to publish or manage IXP model versions
• User provides a taxonomy file to import into a project
• User asks for the schema of a deployed (runtime) IXP model (use deployments get-taxonomy)

Critical Rules

1. ONLY use uip ixp CLI commands as documented in this skill — do NOT use curl, do NOT call REST APIs directly, do NOT grep/read source code, do NOT explore the codebase.
2. Run workflows end-to-end automatically — do NOT ask the user to do individual steps.
3. Always use --output json when parsing CLI output programmatically.
4. Use /tmp/ixp/<project-name>/ as the working directory with this structure:

   /tmp/ixp/<project-name>/
   ├── docs/         # Document files (<document-id>.pdf, .png, …) — downloaded once, reused across sessions
   ├── taxonomies/   # Taxonomy snapshots (v1.json, v2.json, …) — new version after each update-prompts
   └── prompts/      # Instruction update payloads (field_updates.json, group_updates.json, …)
   

   At the start of any workflow: mkdir -p /tmp/ixp/<project-name>/{docs,taxonomies,prompts}. If the directory already exists from a previous session, reuse existing files — do not re-download documents that are already present. Do NOT use the Write tool for /tmp/ixp/ paths — on Windows it resolves to a different location than bash.

5. Use heredocs for --fields/--groups — for update-prompts --fields and --groups, use heredocs (cat > /tmp/ixp/<project-name>/prompts/field_updates.json << 'EOF' ... EOF) then "$(cat /tmp/ixp/<project-name>/prompts/field_updates.json)".
6. Never use UID as a variable name — it is a readonly shell variable. Use DOC_ID, DOCUMENT_ID, etc.
7. Always use the project Name, never the Title — the project list output has both Name (e.g., my_invoices-f1afa9ef-ixp) and Title (e.g., My_Invoices). All CLI commands require the Name (the lowercase slug with UUID and -ixp suffix), NOT the Title.
8. Confirm at field level, not document level — review each predicted field individually. Confirm only the fields that are correct using labelling confirm --fields. Fields with wrong predictions are left unannotated. Fields with OCR-mangled values can be corrected using --corrections (keeps the prediction’s document reference but fixes the text).
9. Do NOT manually extract values — all labelling goes through labelling confirm with predictions from IXP.
10. Max 8 documents for taxonomy suggestion — the suggest-taxonomy endpoint accepts at most 8 attachment references.
11. Claude is the reviewer, not the extractor — IXP generates predictions, Claude validates them. For each document, review predicted field values against the document file (Read tool handles PDF, PNG, JPG, etc.). Confirm correct fields (labelling confirm --fields), correct OCR-mangled values (--corrections), and skip wrong fields. Do NOT manually extract values. If a field’s F1 is low, improve the prompt so IXP predicts better values.

Quick Start

1. Run uip ixp projects list --output json to see existing projects
2. To create a new project: follow Project Setup Guide
3. To improve an existing project: follow Improve Prompts Guide
4. To label documents on an existing project: follow Label Documents Guide

If the user provides a taxonomy file, use --skip-taxonomy and import-taxonomy (Option B in the Project Setup guide).

Task Navigation

User request	Action
“Create an IXP project” / “Upload documents to a new project”	Project Setup Guide — new projects only (uploads + taxonomy in one call). For existing projects, see the “Upload a document” row below.
“Import this taxonomy” / provides a taxonomy file	Project Setup Guide — Option B (--skip-taxonomy + import-taxonomy)
“Label documents” / “Review predictions”	Label Documents Guide
“Improve scores” / “Fix prompts” / “Improve F1”	Improve Prompts Guide
“Publish the model” / “Tag as live”	uip ixp projects publish <project-name> --output json
“Show metrics” / “What are the scores?”	uip ixp projects get-metrics <project-name> --output json
“List projects”	uip ixp projects list --output json
“Configure the model” / “Change preprocessing”	uip ixp projects configure-model <project-name> [options] --output json
“Upload a document” / “Add documents to an existing project”	uip ixp documents upload <project-name> <file> --output json — see CLI Reference § Uploading documents. One file per call; loop for multiple. For brand-new projects use projects create instead.

Common Pitfalls

Symptom	Cause	Fix
Metrics don’t change after update-prompts	Re-evaluation hasn’t completed	Wait ~2 minutes for retrain.
ModelVersion doesn’t advance	Retrain still in progress	Any change to model inputs (labellings OR instructions) triggers a full retrain. Wait ~2 min then retry.
Field instructions conflict with label_def instructions	update-prompts --fields only edits per-field instructions, NOT the parent label_def instructions	Before iterating, read the label_def instructions and ensure they don’t contradict your per-field instructions.

Reference Navigation

• CLI Commands Reference — all uip ixp commands with options and output formats
• Project Setup Guide — create a new project, review and label documents
• Improve Prompts Guide — iterative optimization loop with regression detection
• Label Documents Guide — reusable workflow for reviewing and confirming predictions

curl "https://apis.io/api/v1/skills/uipath-ixp"

curl "https://apis.io/api/v1/skills?limit=25"