Parse Runs Migration

1
// Before (2025-04-21) - ParserRun (optional fields omitted when not applicable)
2
{
3
  "object": "parser_run",
4
  "id": "parser_run_xK9mLPqRtN3vS8wF5hB2cQ",
5
  "fileId": "file_Zk9mNP12Qw4yTv8BdR3H",
6
  "status": "PROCESSED",
7
  "chunks": [
8
    {
9
      "object": "chunk",
10
      "type": "page",
11
      "content": "# Document Title\n\nThis is the content...",
12
      "metadata": {
13
        "pageRange": { "start": 1, "end": 1 }
14
      },
15
      "blocks": [...]
16
    }
17
  ],
18
  "metrics": {
19
    "processingTimeMs": 1234,
20
    "pageCount": 5
21
  },
22
  "config": {
23
    "target": "markdown",
24
    "chunkingStrategy": { "type": "page" }
25
  },
26
  "usage": { "credits": 10 }
27
}
28
29
// After (2026-02-09) - ParseRun (all fields present, nullable fields use null)
30
{
31
  "object": "parse_run",
32
  "id": "pr_xK9mLPqRtN3vS8wF5hB2cQ",
33
  "file": {
34
    "object": "file",
35
    "id": "file_Zk9mNP12Qw4yTv8BdR3H",
36
    "name": "document.pdf",
37
    "type": "PDF",
38
    "metadata": {},
39
    "createdAt": "2025-01-01T00:00:00Z",
40
    "updatedAt": "2025-01-01T00:00:00Z"
41
  },
42
  "status": "PROCESSED",
43
  "output": {
44
    "chunks": [
45
      {
46
        "object": "chunk",
47
        "type": "page",
48
        "content": "# Document Title\n\nThis is the content...",
49
        "metadata": {
50
          "pageRange": { "start": 1, "end": 1 }
51
        },
52
        "blocks": [...]
53
      }
54
    ]
55
  },
56
  "outputUrl": null,
57
  "failureReason": null,
58
  "metrics": {
59
    "processingTimeMs": 1234,
60
    "pageCount": 5
61
  },
62
  "config": {
63
    "target": "markdown",
64
    "chunkingStrategy": { "type": "page" }
65
  },
66
  "usage": { "credits": 10 }
67
}

1
// Before (2025-04-21) - ParserRunStatus for in-progress (from GET endpoint)
2
{
3
  "success": true,
4
  "parserRun": {
5
    "object": "parser_run_status",
6
    "id": "parser_run_xK9mLPqRtN3vS8wF5hB2cQ",
7
    "status": "PROCESSING"
8
  }
9
}
10
11
// After (2026-02-09) - ParseRun with PROCESSING status (from GET endpoint)
12
// All fields are always present; nullable fields are null when not applicable
13
{
14
  "object": "parse_run",
15
  "id": "pr_xK9mLPqRtN3vS8wF5hB2cQ",
16
  "file": { ... },
17
  "status": "PROCESSING",
18
  "output": null,
19
  "outputUrl": null,
20
  "metrics": null,
21
  "usage": null,
22
  "failureReason": null,
23
  "config": { ... }
24
}

1
// Before (2025-04-21)
2
{
3
  "file": {
4
    "fileName": "document.pdf",
5
    "fileUrl": "https://example.com/document.pdf"
6
    // or
7
    "fileId": "file_abc123"
8
  },
9
  "config": {
10
    "target": "markdown",
11
    "chunkingStrategy": { "type": "page" },
12
    "blockOptions": { ... },
13
    "advancedOptions": { ... }
14
  }
15
}
16
17
// After (2026-02-09)
18
{
19
  "file": {
20
    "name": "document.pdf",
21
    "url": "https://example.com/document.pdf"
22
    // or
23
    "id": "file_abc123"
24
  },
25
  "config": {
26
    "target": "markdown",
27
    "chunkingStrategy": { "type": "page" },
28
    "blockOptions": { ... },
29
    "advancedOptions": { ... }
30
  },
31
  "metadata": {  // Optional - for tracking and identifying runs
32
    "customerId": "cust_123",
33
    "extend:usage_tags": ["production", "team-eng"]
34
  }
35
}

1
// Before - URL
2
{ "file": { "fileUrl": "https://...", "fileName": "doc.pdf" } }
3
4
// After - URL
5
{ "file": { "url": "https://...", "name": "doc.pdf" } }
6
7
// Before - File ID
8
{ "file": { "fileId": "file_abc123" } }
9
10
// After - File ID
11
{ "file": { "id": "file_abc123" } }

1
// Before (2025-04-21) - synchronous with old schema
2
const run = await client.parse({
3
  file: { fileUrl: "https://..." }  // Old: fileUrl
4
});
5
console.log(run.chunks); // Old: chunks at root level
6
7
// After (2026-02-09) - sync endpoint with NEW schema (for testing only)
8
const run = await client.parse({
9
  file: { url: "https://..." }  // New: url (not fileUrl)
10
});
11
console.log(run.output.chunks);  // New: chunks in output
12
13
// After (2026-02-09) - RECOMMENDED: use createAndPoll for production
14
const result = await client.parseRuns.createAndPoll({
15
  file: { url: "https://..." }
16
});
17
console.log(result.output.chunks);

1
// Before (2025-04-21) - POST /parse returned ParserRun directly (not wrapped)
2
{
3
  "object": "parser_run",
4
  "id": "parser_run_abc123",
5
  "fileId": "file_xyz789",
6
  "status": "PROCESSED",
7
  "chunks": [...],
8
  "metrics": { ... },
9
  "config": { ... },
10
  "usage": { "credits": 10 }
11
}
12
13
// Before (2025-04-21) - POST /parse/async returned ParserRunStatus directly
14
{
15
  "object": "parser_run_status",
16
  "id": "parser_run_abc123",
17
  "status": "PROCESSING"
18
}
19
20
// After (2026-02-09) - POST /parse_runs returns ParseRun directly
21
{
22
  "object": "parse_run",
23
  "id": "pr_abc123",
24
  "file": {
25
    "object": "file",
26
    "id": "file_xyz789",
27
    "name": "document.pdf",
28
    "type": "PDF",
29
    "metadata": {},
30
    "createdAt": "2025-01-01T00:00:00Z",
31
    "updatedAt": "2025-01-01T00:00:00Z"
32
  },
33
  "status": "PROCESSED",
34
  "output": {
35
    "chunks": [...]
36
  },
37
  "outputUrl": null,
38
  "metrics": { ... },
39
  "config": { ... },
40
  "usage": { "credits": 10 }
41
}

1
// Before (2025-04-21)
2
{
3
  "success": true,
4
  "parserRun": {
5
    "object": "parser_run",
6
    "id": "parser_run_abc123",
7
    "fileId": "file_xyz789",
8
    "status": "PROCESSED",
9
    "chunks": [...],
10
    "metrics": { ... },
11
    "config": { ... },
12
    "usage": { "credits": 10 }
13
  }
14
}
15
16
// After (2026-02-09)
17
{
18
  "object": "parse_run",
19
  "id": "pr_abc123",
20
  "file": {
21
    "object": "file",
22
    "id": "file_xyz789",
23
    "name": "document.pdf",
24
    "type": "PDF",
25
    "metadata": {},
26
    "createdAt": "2025-01-01T00:00:00Z",
27
    "updatedAt": "2025-01-01T00:00:00Z"
28
  },
29
  "status": "PROCESSED",
30
  "output": {
31
    "chunks": [...]
32
  },
33
  "outputUrl": null,
34
  "metrics": { ... },
35
  "config": { ... },
36
  "usage": { "credits": 10 }
37
}

1
// Before (2025-04-21)
2
{
3
  "success": true,
4
  "parserRunId": "parser_run_abc123",
5
  "message": "Parser run data has been successfully deleted."
6
}
7
8
// After (2026-02-09)
9
{
10
  "id": "pr_abc123"
11
}