@arbidocs/client 0.4.74 → 0.4.76

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.cts +1512 -50
  2. package/dist/index.d.ts +1512 -50
  3. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -14,7 +14,7 @@ interface paths {
14
14
  };
15
15
  /**
16
16
  * List Projects
17
- * @description List all projects visible to the caller.
17
+ * @description List all projects visible to the caller, optionally only those at ``stage`` and/or led by ``lead_user``.
18
18
  *
19
19
  * Agents are allowed (read-only): ``projects_select_policy`` grants owner-group
20
20
  * visibility, so an agent sees its parent's projects and uses one as its own —
@@ -63,11 +63,34 @@ interface paths {
63
63
  head?: never;
64
64
  /**
65
65
  * Update Project
66
- * @description Update project name.
66
+ * @description Update a project (owner only): name, daily cap and host-defined fields, with PATCH semantics.
67
+ *
68
+ * A field left out is unchanged and an explicit null clears it; ``fields`` merges key by key (null removes a
69
+ * key). Stage and budget changes are recorded as project events.
67
70
  */
68
71
  patch: operations['update_project'];
69
72
  trace?: never;
70
73
  };
74
+ '/v1/user/projects/{project_ext_id}/events': {
75
+ parameters: {
76
+ query?: never;
77
+ header?: never;
78
+ path?: never;
79
+ cookie?: never;
80
+ };
81
+ /**
82
+ * Get Project Events
83
+ * @description A project's stage and budget changes, newest first (anyone who can see the project).
84
+ */
85
+ get: operations['list_project_events'];
86
+ put?: never;
87
+ post?: never;
88
+ delete?: never;
89
+ options?: never;
90
+ head?: never;
91
+ patch?: never;
92
+ trace?: never;
93
+ };
71
94
  '/v1/user/projects/quote': {
72
95
  parameters: {
73
96
  query?: never;
@@ -201,6 +224,29 @@ interface paths {
201
224
  patch?: never;
202
225
  trace?: never;
203
226
  };
227
+ '/v1/user/projects/{project_ext_id}/usage/conversations': {
228
+ parameters: {
229
+ query?: never;
230
+ header?: never;
231
+ path?: never;
232
+ cookie?: never;
233
+ };
234
+ /**
235
+ * Get Project Conversation Usage Endpoint
236
+ * @description AI usage of a project's billing period by conversation (thread / work item), in credits.
237
+ *
238
+ * Each model call is tagged with the conversation it serves; spend that served none is ``unattributed``.
239
+ * Per-step detail of one conversation: ``GET /v1/conversation/{conversation_ext_id}/usage``.
240
+ */
241
+ get: operations['get_project_conversation_usage'];
242
+ put?: never;
243
+ post?: never;
244
+ delete?: never;
245
+ options?: never;
246
+ head?: never;
247
+ patch?: never;
248
+ trace?: never;
249
+ };
204
250
  '/v1/user/projects/{project_ext_id}/invoices': {
205
251
  parameters: {
206
252
  query?: never;
@@ -2377,6 +2423,30 @@ interface paths {
2377
2423
  patch?: never;
2378
2424
  trace?: never;
2379
2425
  };
2426
+ '/v1/conversation/{conversation_ext_id}/usage': {
2427
+ parameters: {
2428
+ query?: never;
2429
+ header?: never;
2430
+ path?: never;
2431
+ cookie?: never;
2432
+ };
2433
+ /**
2434
+ * Get Conversation Usage Endpoint
2435
+ * @description AI usage of a conversation since it was created: total, by workflow step, run, model and agent.
2436
+ *
2437
+ * In credits, like project usage. Every model call is tagged with the conversation it serves and, for a
2438
+ * work run, the run and workflow step (a stage is a set of steps: sum ``by_step``). Read from the spend
2439
+ * logs of the project the conversation's workspace bills to; anyone who can read the conversation may.
2440
+ */
2441
+ get: operations['get_conversation_usage'];
2442
+ put?: never;
2443
+ post?: never;
2444
+ delete?: never;
2445
+ options?: never;
2446
+ head?: never;
2447
+ patch?: never;
2448
+ trace?: never;
2449
+ };
2380
2450
  '/v1/conversation/search': {
2381
2451
  parameters: {
2382
2452
  query?: never;
@@ -2578,11 +2648,20 @@ interface paths {
2578
2648
  /**
2579
2649
  * Act On Step
2580
2650
  * @description A person finishes a step of a workflow run: fills in a form (its ``inputs`` join the run's inputs), adds
2581
- * the files, approves a review, or skips a step. The run then goes on to its next agent step, under the
2582
- * caller's session (they are present: no access question).
2651
+ * the files, approves a review, skips a step, or sends the work back to an earlier step. The run then goes on to
2652
+ * its next agent step, under the caller's session (they are present: no access question), and the person steps
2653
+ * that are now ready tell their assignees.
2654
+ *
2655
+ * Any unfinished step can be skipped at any time (ahead of the plan too), by any editor: the plan guides the
2656
+ * thread, it does not hold it. Completing needs the step to be ready; a step that declares ``fields`` checks its
2657
+ * ``inputs`` against them (422 with ``{field: problem}``); a review records what it approved (the answers and
2658
+ * document versions of the steps it waits for). ``send_back`` reopens ``to`` (default: the step this one waits
2659
+ * for) and every step after it; an agent step runs again with the ``note``. A step assigned to a user is
2660
+ * completed or sent back only by them, the run's owner or a workspace owner (403).
2583
2661
  *
2584
- * 400 when the step is not this run's, or not ready (what it waits for has not finished); 409 while a turn is
2585
- * running for a step a person does (an agent step can only be skipped once it has failed or not started).
2662
+ * 400 when the step is not this run's, a step completed out of order, an agent step completed by hand, or a
2663
+ * send-back to a step this one does not wait for; 409 while the step's own turn (or, for a send-back, any turn)
2664
+ * is running (a step whose run died is failed first, so it can be skipped or retried).
2586
2665
  */
2587
2666
  post: operations['act_on_step'];
2588
2667
  delete?: never;
@@ -3042,6 +3121,30 @@ interface paths {
3042
3121
  patch?: never;
3043
3122
  trace?: never;
3044
3123
  };
3124
+ '/v1/tag/matrix': {
3125
+ parameters: {
3126
+ query?: never;
3127
+ header?: never;
3128
+ path?: never;
3129
+ cookie?: never;
3130
+ };
3131
+ /**
3132
+ * Get Tag Matrix
3133
+ * @description A set of tags with their fields and values, plus the documents and facts linked to each.
3134
+ *
3135
+ * Select the rows with ``parent_ext_id`` (its children; the parent comes back too, its fields being the
3136
+ * shared columns) or with ``tag_ext_id``. Each row lists up to ``links_limit`` documents (with the doctag's
3137
+ * note and how many passages it cites) and facts, newest first; ``doc_count``/``fact_count`` are the totals.
3138
+ */
3139
+ get: operations['get_tag_matrix'];
3140
+ put?: never;
3141
+ post?: never;
3142
+ delete?: never;
3143
+ options?: never;
3144
+ head?: never;
3145
+ patch?: never;
3146
+ trace?: never;
3147
+ };
3045
3148
  '/v1/tag/': {
3046
3149
  parameters: {
3047
3150
  query?: never;
@@ -3235,6 +3338,168 @@ interface paths {
3235
3338
  patch?: never;
3236
3339
  trace?: never;
3237
3340
  };
3341
+ '/v1/databases': {
3342
+ parameters: {
3343
+ query?: never;
3344
+ header?: never;
3345
+ path?: never;
3346
+ cookie?: never;
3347
+ };
3348
+ /**
3349
+ * List Databases
3350
+ * @description The databases of the active workspace, then (read-only here) those of public workspaces.
3351
+ */
3352
+ get: operations['list_databases'];
3353
+ put?: never;
3354
+ /** Create Database */
3355
+ post: operations['create_database'];
3356
+ delete?: never;
3357
+ options?: never;
3358
+ head?: never;
3359
+ patch?: never;
3360
+ trace?: never;
3361
+ };
3362
+ '/v1/databases/import': {
3363
+ parameters: {
3364
+ query?: never;
3365
+ header?: never;
3366
+ path?: never;
3367
+ cookie?: never;
3368
+ };
3369
+ get?: never;
3370
+ put?: never;
3371
+ /**
3372
+ * Import Database
3373
+ * @description Create a database from a spreadsheet. Column types (number, date, checkbox, text) are inferred.
3374
+ */
3375
+ post: operations['import_database'];
3376
+ delete?: never;
3377
+ options?: never;
3378
+ head?: never;
3379
+ patch?: never;
3380
+ trace?: never;
3381
+ };
3382
+ '/v1/databases/{database_id}': {
3383
+ parameters: {
3384
+ query?: never;
3385
+ header?: never;
3386
+ path?: never;
3387
+ cookie?: never;
3388
+ };
3389
+ /** Get Database */
3390
+ get: operations['get_database'];
3391
+ put?: never;
3392
+ post?: never;
3393
+ /** Delete Database */
3394
+ delete: operations['delete_database'];
3395
+ options?: never;
3396
+ head?: never;
3397
+ /**
3398
+ * Update Database
3399
+ * @description Rename, describe, or change columns (``columns`` is the full new list: keep by id, add without, drop by
3400
+ * leaving out). A dropped column's values are no longer returned.
3401
+ */
3402
+ patch: operations['update_database'];
3403
+ trace?: never;
3404
+ };
3405
+ '/v1/databases/{database_id}/rows': {
3406
+ parameters: {
3407
+ query?: never;
3408
+ header?: never;
3409
+ path?: never;
3410
+ cookie?: never;
3411
+ };
3412
+ /**
3413
+ * List Rows
3414
+ * @description Rows keyed by column id.
3415
+ */
3416
+ get: operations['list_database_rows'];
3417
+ put?: never;
3418
+ /**
3419
+ * Add Rows
3420
+ * @description Add rows; cell values are keyed by column id or name and checked against the column's type.
3421
+ */
3422
+ post: operations['add_database_rows'];
3423
+ delete?: never;
3424
+ options?: never;
3425
+ head?: never;
3426
+ patch?: never;
3427
+ trace?: never;
3428
+ };
3429
+ '/v1/databases/{database_id}/rows/{row_id}': {
3430
+ parameters: {
3431
+ query?: never;
3432
+ header?: never;
3433
+ path?: never;
3434
+ cookie?: never;
3435
+ };
3436
+ get?: never;
3437
+ put?: never;
3438
+ post?: never;
3439
+ delete?: never;
3440
+ options?: never;
3441
+ head?: never;
3442
+ /**
3443
+ * Update Row
3444
+ * @description Change the given cells (``null`` empties a cell); other cells are kept.
3445
+ */
3446
+ patch: operations['update_database_row'];
3447
+ trace?: never;
3448
+ };
3449
+ '/v1/databases/{database_id}/rows/delete': {
3450
+ parameters: {
3451
+ query?: never;
3452
+ header?: never;
3453
+ path?: never;
3454
+ cookie?: never;
3455
+ };
3456
+ get?: never;
3457
+ put?: never;
3458
+ /** Delete Rows */
3459
+ post: operations['delete_database_rows'];
3460
+ delete?: never;
3461
+ options?: never;
3462
+ head?: never;
3463
+ patch?: never;
3464
+ trace?: never;
3465
+ };
3466
+ '/v1/databases/{database_id}/import': {
3467
+ parameters: {
3468
+ query?: never;
3469
+ header?: never;
3470
+ path?: never;
3471
+ cookie?: never;
3472
+ };
3473
+ get?: never;
3474
+ put?: never;
3475
+ /**
3476
+ * Import Rows
3477
+ * @description Append a spreadsheet's rows; headers are matched to column names. All rows or none.
3478
+ */
3479
+ post: operations['import_database_rows'];
3480
+ delete?: never;
3481
+ options?: never;
3482
+ head?: never;
3483
+ patch?: never;
3484
+ trace?: never;
3485
+ };
3486
+ '/v1/databases/{database_id}/export': {
3487
+ parameters: {
3488
+ query?: never;
3489
+ header?: never;
3490
+ path?: never;
3491
+ cookie?: never;
3492
+ };
3493
+ /** Export Database */
3494
+ get: operations['export_database'];
3495
+ put?: never;
3496
+ post?: never;
3497
+ delete?: never;
3498
+ options?: never;
3499
+ head?: never;
3500
+ patch?: never;
3501
+ trace?: never;
3502
+ };
3238
3503
  '/v1/workflow': {
3239
3504
  parameters: {
3240
3505
  query?: never;
@@ -6071,7 +6336,7 @@ interface components {
6071
6336
  * @description What happened to a task, in the order a person reads its history.
6072
6337
  * @enum {string}
6073
6338
  */
6074
- ActivityKind: 'created' | 'run_started' | 'awaiting_access' | 'access_granted' | 'done' | 'reopened' | 'failed' | 'participant_joined' | 'assistant_responded' | 'assistant_stopped' | 'artifact_created' | 'artifact_edited' | 'document_added' | 'document_removed' | 'notified' | 'step_started' | 'step_done' | 'step_skipped' | 'step_failed';
6339
+ ActivityKind: 'created' | 'run_started' | 'awaiting_access' | 'access_granted' | 'done' | 'reopened' | 'failed' | 'participant_joined' | 'assistant_responded' | 'assistant_stopped' | 'artifact_created' | 'artifact_edited' | 'document_added' | 'document_removed' | 'notified' | 'step_started' | 'step_done' | 'step_skipped' | 'step_failed' | 'step_signal' | 'step_ready' | 'step_reminded' | 'step_sent_back' | 'linked_run';
6075
6340
  /**
6076
6341
  * ActivityResponse
6077
6342
  * @description One entry of ``GET /v1/conversation/{id}/activity``.
@@ -9833,6 +10098,74 @@ interface components {
9833
10098
  /** Parent Ext Id */
9834
10099
  parent_ext_id?: string | null;
9835
10100
  };
10101
+ /**
10102
+ * ConversationUsageResponse
10103
+ * @description AI usage of one conversation (a thread, or a work item / matter), in credits like project usage.
10104
+ *
10105
+ * Read from the project's LiteLLM spend logs: every model call is tagged with the conversation it
10106
+ * serves and, for a work run, the run and the workflow step. A breakdown holds only the calls that
10107
+ * carry its key (a chat turn has no step), so each one sums to at most the total.
10108
+ */
10109
+ ConversationUsageResponse: {
10110
+ /** Conversation Ext Id */
10111
+ conversation_ext_id: string;
10112
+ /** Project Ext Id */
10113
+ project_ext_id: string;
10114
+ /** Period Start */
10115
+ period_start: string;
10116
+ /** Period End */
10117
+ period_end: string;
10118
+ /**
10119
+ * Total Spend
10120
+ * @default 0
10121
+ */
10122
+ total_spend: number;
10123
+ /**
10124
+ * Total Tokens
10125
+ * @default 0
10126
+ */
10127
+ total_tokens: number;
10128
+ /**
10129
+ * Total Requests
10130
+ * @default 0
10131
+ */
10132
+ total_requests: number;
10133
+ /**
10134
+ * By Step
10135
+ * @default {}
10136
+ */
10137
+ by_step: {
10138
+ [key: string]: components['schemas']['TagBreakdown'];
10139
+ };
10140
+ /**
10141
+ * By Run
10142
+ * @default {}
10143
+ */
10144
+ by_run: {
10145
+ [key: string]: components['schemas']['TagBreakdown'];
10146
+ };
10147
+ /**
10148
+ * By Model
10149
+ * @default {}
10150
+ */
10151
+ by_model: {
10152
+ [key: string]: components['schemas']['TagBreakdown'];
10153
+ };
10154
+ /**
10155
+ * By Agent
10156
+ * @default {}
10157
+ */
10158
+ by_agent: {
10159
+ [key: string]: components['schemas']['TagBreakdown'];
10160
+ };
10161
+ /**
10162
+ * By Feature
10163
+ * @default {}
10164
+ */
10165
+ by_feature: {
10166
+ [key: string]: components['schemas']['TagBreakdown'];
10167
+ };
10168
+ };
9836
10169
  /**
9837
10170
  * CopyDocumentResult
9838
10171
  * @description Outcome of copying ONE selected item.
@@ -10105,6 +10438,12 @@ interface components {
10105
10438
  shared?: boolean | null;
10106
10439
  /** Parent Ext Id */
10107
10440
  parent_ext_id?: string | null;
10441
+ /** Fields */
10442
+ fields?: components['schemas']['FieldDefinitionWrite'][] | null;
10443
+ /** Field Values */
10444
+ field_values?: {
10445
+ [key: string]: unknown;
10446
+ } | null;
10108
10447
  };
10109
10448
  /**
10110
10449
  * CreateWorkRequest
@@ -10230,6 +10569,148 @@ interface components {
10230
10569
  [key: string]: components['schemas']['ModelGroupUsage'];
10231
10570
  };
10232
10571
  };
10572
+ /** DatabaseColumn */
10573
+ DatabaseColumn: {
10574
+ /** Id */
10575
+ id: string;
10576
+ /** Name */
10577
+ name: string;
10578
+ /**
10579
+ * Type
10580
+ * @enum {string}
10581
+ */
10582
+ type: 'text' | 'number' | 'date' | 'checkbox' | 'select';
10583
+ /** Options */
10584
+ options?: string[] | null;
10585
+ };
10586
+ /**
10587
+ * DatabaseColumnWrite
10588
+ * @description A column. Give ``id`` to keep an existing column (its type cannot change); omit it to add one.
10589
+ */
10590
+ DatabaseColumnWrite: {
10591
+ /** Id */
10592
+ id?: string | null;
10593
+ /** Name */
10594
+ name: string;
10595
+ /**
10596
+ * Type
10597
+ * @default text
10598
+ * @enum {string}
10599
+ */
10600
+ type: 'text' | 'number' | 'date' | 'checkbox' | 'select';
10601
+ /** Options */
10602
+ options?: string[] | null;
10603
+ };
10604
+ /** DatabaseCreate */
10605
+ DatabaseCreate: {
10606
+ /** Name */
10607
+ name: string;
10608
+ /** Description */
10609
+ description?: string | null;
10610
+ /** Columns */
10611
+ columns?: components['schemas']['DatabaseColumnWrite'][];
10612
+ };
10613
+ /** DatabaseImportResult */
10614
+ DatabaseImportResult: {
10615
+ database: components['schemas']['DatabaseRead'];
10616
+ /** Imported */
10617
+ imported: number;
10618
+ /** Added Columns */
10619
+ added_columns?: string[];
10620
+ };
10621
+ /** DatabaseRead */
10622
+ DatabaseRead: {
10623
+ /** Id */
10624
+ id: string;
10625
+ /** Name */
10626
+ name: string;
10627
+ /** Description */
10628
+ description?: string | null;
10629
+ /** Columns */
10630
+ columns?: components['schemas']['DatabaseColumn'][];
10631
+ /**
10632
+ * Row Count
10633
+ * @default 0
10634
+ */
10635
+ row_count: number;
10636
+ /** Workspace Id */
10637
+ workspace_id: string;
10638
+ /**
10639
+ * Editable
10640
+ * @default true
10641
+ */
10642
+ editable: boolean;
10643
+ /** Created By */
10644
+ created_by?: string | null;
10645
+ /**
10646
+ * Created At
10647
+ * Format: date-time
10648
+ */
10649
+ created_at: string;
10650
+ /**
10651
+ * Updated At
10652
+ * Format: date-time
10653
+ */
10654
+ updated_at: string;
10655
+ };
10656
+ /** DatabaseRowPage */
10657
+ DatabaseRowPage: {
10658
+ /** Rows */
10659
+ rows: components['schemas']['DatabaseRowRead'][];
10660
+ /** Total */
10661
+ total: number;
10662
+ };
10663
+ /** DatabaseRowRead */
10664
+ DatabaseRowRead: {
10665
+ /** Id */
10666
+ id: string;
10667
+ /** Values */
10668
+ values: {
10669
+ [key: string]: unknown;
10670
+ };
10671
+ /**
10672
+ * Created At
10673
+ * Format: date-time
10674
+ */
10675
+ created_at: string;
10676
+ /**
10677
+ * Updated At
10678
+ * Format: date-time
10679
+ */
10680
+ updated_at: string;
10681
+ };
10682
+ /**
10683
+ * DatabaseRowWrite
10684
+ * @description Cell values keyed by column id (``col-…``) or column name.
10685
+ */
10686
+ DatabaseRowWrite: {
10687
+ /** Values */
10688
+ values?: {
10689
+ [key: string]: unknown;
10690
+ };
10691
+ };
10692
+ /** DatabaseRowsCreate */
10693
+ DatabaseRowsCreate: {
10694
+ /** Rows */
10695
+ rows: components['schemas']['DatabaseRowWrite'][];
10696
+ };
10697
+ /** DatabaseRowsDelete */
10698
+ DatabaseRowsDelete: {
10699
+ /** Ids */
10700
+ ids: string[];
10701
+ };
10702
+ /** DatabaseUpdate */
10703
+ DatabaseUpdate: {
10704
+ /** Name */
10705
+ name?: string | null;
10706
+ /** Description */
10707
+ description?: string | null;
10708
+ /**
10709
+ * Columns
10710
+ * @description The full new column list; columns left out are dropped
10711
+ */
10712
+ columns?: components['schemas']['DatabaseColumnWrite'][] | null;
10713
+ };
10233
10714
  /**
10234
10715
  * DateTimeSpec
10235
10716
  * @description A point in time as the user wrote it.
@@ -11435,6 +11916,42 @@ interface components {
11435
11916
  */
11436
11917
  label: string;
11437
11918
  };
11919
+ /**
11920
+ * FieldDefinitionWrite
11921
+ * @description A field in a write. Give ``id`` to keep an existing field (its type cannot change); omit it to add one.
11922
+ */
11923
+ FieldDefinitionWrite: {
11924
+ /** Id */
11925
+ id?: string | null;
11926
+ /** Name */
11927
+ name: string;
11928
+ /**
11929
+ * Type
11930
+ * @default text
11931
+ * @enum {string}
11932
+ */
11933
+ type: 'text' | 'number' | 'date' | 'checkbox' | 'select' | 'person';
11934
+ /** Options */
11935
+ options?: string[] | null;
11936
+ };
11937
+ /**
11938
+ * FieldSchemaEntry
11939
+ * @description One field of a host-defined schema (a project's ``field_schema``), keyed by a host-chosen ``key``.
11940
+ */
11941
+ FieldSchemaEntry: {
11942
+ /** Key */
11943
+ key: string;
11944
+ /** Label */
11945
+ label?: string | null;
11946
+ /**
11947
+ * Type
11948
+ * @default text
11949
+ * @enum {string}
11950
+ */
11951
+ type: 'text' | 'number' | 'date' | 'checkbox' | 'select' | 'person';
11952
+ /** Options */
11953
+ options?: string[] | null;
11954
+ };
11438
11955
  /**
11439
11956
  * FileDeleteResponse
11440
11957
  * @description OpenAI-compatible file deletion response.
@@ -12797,7 +13314,7 @@ interface components {
12797
13314
  input: string;
12798
13315
  /** Tools */
12799
13316
  tools?: {
12800
- [key: string]: components['schemas']['ModelCitationTool'] | components['schemas']['RetrievalChunkTool'] | components['schemas']['RetrievalFullContextTool'] | components['schemas']['RetrievalTOCTool'] | components['schemas']['TraceTool'] | components['schemas']['CompactionTool'] | components['schemas']['PersonalAgentTool'] | components['schemas']['StreamEventsTool'] | components['schemas']['MemoryTool'] | components['schemas']['GoalTool'] | components['schemas']['FactsContextTool'] | components['schemas']['ImageGenerationTool'] | components['schemas']['SubagentTool'];
13317
+ [key: string]: components['schemas']['ModelCitationTool'] | components['schemas']['RetrievalChunkTool'] | components['schemas']['RetrievalFullContextTool'] | components['schemas']['RetrievalTOCTool'] | components['schemas']['TraceTool'] | components['schemas']['CompactionTool'] | components['schemas']['PersonalAgentTool'] | components['schemas']['StreamEventsTool'] | components['schemas']['MemoryTool'] | components['schemas']['GoalTool'] | components['schemas']['FactsContextTool'] | components['schemas']['ImageGenerationTool'] | components['schemas']['SubagentTool'] | components['schemas']['WorkflowStepTool'];
12801
13318
  };
12802
13319
  /**
12803
13320
  * Workspace Ext Id
@@ -12886,7 +13403,7 @@ interface components {
12886
13403
  content: string;
12887
13404
  /** Tools */
12888
13405
  tools?: {
12889
- [key: string]: components['schemas']['ModelCitationTool'] | components['schemas']['RetrievalChunkTool'] | components['schemas']['RetrievalFullContextTool'] | components['schemas']['RetrievalTOCTool'] | components['schemas']['TraceTool'] | components['schemas']['CompactionTool'] | components['schemas']['PersonalAgentTool'] | components['schemas']['StreamEventsTool'] | components['schemas']['MemoryTool'] | components['schemas']['GoalTool'] | components['schemas']['FactsContextTool'] | components['schemas']['ImageGenerationTool'] | components['schemas']['SubagentTool'];
13406
+ [key: string]: components['schemas']['ModelCitationTool'] | components['schemas']['RetrievalChunkTool'] | components['schemas']['RetrievalFullContextTool'] | components['schemas']['RetrievalTOCTool'] | components['schemas']['TraceTool'] | components['schemas']['CompactionTool'] | components['schemas']['PersonalAgentTool'] | components['schemas']['StreamEventsTool'] | components['schemas']['MemoryTool'] | components['schemas']['GoalTool'] | components['schemas']['FactsContextTool'] | components['schemas']['ImageGenerationTool'] | components['schemas']['SubagentTool'] | components['schemas']['WorkflowStepTool'];
12890
13407
  };
12891
13408
  /** Config Ext Id */
12892
13409
  config_ext_id?: string | null;
@@ -12996,7 +13513,7 @@ interface components {
12996
13513
  content: string;
12997
13514
  /** Tools */
12998
13515
  tools?: {
12999
- [key: string]: components['schemas']['ModelCitationTool'] | components['schemas']['RetrievalChunkTool'] | components['schemas']['RetrievalFullContextTool'] | components['schemas']['RetrievalTOCTool'] | components['schemas']['TraceTool'] | components['schemas']['CompactionTool'] | components['schemas']['PersonalAgentTool'] | components['schemas']['StreamEventsTool'] | components['schemas']['MemoryTool'] | components['schemas']['GoalTool'] | components['schemas']['FactsContextTool'] | components['schemas']['ImageGenerationTool'] | components['schemas']['SubagentTool'];
13516
+ [key: string]: components['schemas']['ModelCitationTool'] | components['schemas']['RetrievalChunkTool'] | components['schemas']['RetrievalFullContextTool'] | components['schemas']['RetrievalTOCTool'] | components['schemas']['TraceTool'] | components['schemas']['CompactionTool'] | components['schemas']['PersonalAgentTool'] | components['schemas']['StreamEventsTool'] | components['schemas']['MemoryTool'] | components['schemas']['GoalTool'] | components['schemas']['FactsContextTool'] | components['schemas']['ImageGenerationTool'] | components['schemas']['SubagentTool'] | components['schemas']['WorkflowStepTool'];
13000
13517
  };
13001
13518
  /** Config Ext Id */
13002
13519
  config_ext_id?: string | null;
@@ -13316,7 +13833,7 @@ interface components {
13316
13833
  * Type is self-descriptive, no need to parse content field.
13317
13834
  * @enum {string}
13318
13835
  */
13319
- NotificationType: 'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'signup_reward' | 'referral_reward' | 'native_mail_received' | 'mail_draft_ready' | 'email_reply' | 'quota_threshold_50' | 'quota_threshold_90' | 'quota_threshold_100' | 'doc_shared' | 'docx_mention' | 'workspace_access_request' | 'conversation_ready' | 'conversation_done' | 'conversation_notified' | 'workflow_failed' | 'agent_input_requested' | 'workflow_completed' | 'task_started' | 'task_completed' | 'mailbox_sync_complete' | 'drive_sync_complete' | 'activity' | 'mention' | 'call_missed' | 'calendar_invite' | 'calendar_update' | 'calendar_cancel' | 'calendar_reply' | 'calendar_counter' | 'calendar_reminder' | 'calendar_share';
13836
+ NotificationType: 'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'signup_reward' | 'referral_reward' | 'native_mail_received' | 'mail_draft_ready' | 'email_reply' | 'quota_threshold_50' | 'quota_threshold_90' | 'quota_threshold_100' | 'doc_shared' | 'docx_mention' | 'workspace_access_request' | 'conversation_ready' | 'conversation_done' | 'conversation_notified' | 'workflow_failed' | 'agent_input_requested' | 'workflow_completed' | 'workflow_signal' | 'step_ready' | 'task_started' | 'task_completed' | 'mailbox_sync_complete' | 'drive_sync_complete' | 'activity' | 'mention' | 'call_missed' | 'calendar_invite' | 'calendar_update' | 'calendar_cancel' | 'calendar_reply' | 'calendar_counter' | 'calendar_reminder' | 'calendar_share';
13320
13837
  /**
13321
13838
  * NotificationUpdate
13322
13839
  * @description Single notification update for bulk PATCH.
@@ -14182,6 +14699,19 @@ interface components {
14182
14699
  upsell?: components['schemas']['ProPlusUpsell'] | null;
14183
14700
  payment?: components['schemas']['AddonPaymentState'] | null;
14184
14701
  };
14702
+ /**
14703
+ * ProjectBudget
14704
+ * @description An amount in minor units (pence, cents) of an ISO 4217 currency.
14705
+ */
14706
+ ProjectBudget: {
14707
+ /** Amount */
14708
+ amount: number;
14709
+ /**
14710
+ * Currency
14711
+ * @description ISO 4217 code, e.g. GBP
14712
+ */
14713
+ currency: string;
14714
+ };
14185
14715
  /**
14186
14716
  * ProjectCheckoutRequest
14187
14717
  * @description Create a Stripe checkout session for this project's Pro plan (Pro = 1 pack, Pro Plus = 10).
@@ -14218,11 +14748,68 @@ interface components {
14218
14748
  /** Client Secret */
14219
14749
  client_secret: string;
14220
14750
  };
14751
+ /**
14752
+ * ProjectConversationUsageResponse
14753
+ * @description A project's AI usage by conversation for a billing period, in credits like project usage.
14754
+ */
14755
+ ProjectConversationUsageResponse: {
14756
+ /** Project Ext Id */
14757
+ project_ext_id: string;
14758
+ /** Period Start */
14759
+ period_start: string;
14760
+ /** Period End */
14761
+ period_end: string;
14762
+ /**
14763
+ * Total Spend
14764
+ * @default 0
14765
+ */
14766
+ total_spend: number;
14767
+ /**
14768
+ * Total Tokens
14769
+ * @default 0
14770
+ */
14771
+ total_tokens: number;
14772
+ /**
14773
+ * Total Requests
14774
+ * @default 0
14775
+ */
14776
+ total_requests: number;
14777
+ /**
14778
+ * By Conversation
14779
+ * @default {}
14780
+ */
14781
+ by_conversation: {
14782
+ [key: string]: components['schemas']['TagBreakdown'];
14783
+ };
14784
+ /**
14785
+ * @default {
14786
+ * "spend": 0,
14787
+ * "total_tokens": 0,
14788
+ * "requests": 0
14789
+ * }
14790
+ */
14791
+ unattributed: components['schemas']['TagBreakdown'];
14792
+ };
14221
14793
  /**
14222
14794
  * ProjectCreateRequest
14223
- * @description Create a new project.
14795
+ * @description Create a new project, optionally with its host-defined fields.
14224
14796
  */
14225
14797
  ProjectCreateRequest: {
14798
+ budget?: components['schemas']['ProjectBudget'] | null;
14799
+ /** Client */
14800
+ client?: string | null;
14801
+ /** Client Ref */
14802
+ client_ref?: string | null;
14803
+ /** Stage */
14804
+ stage?: string | null;
14805
+ /** Lead User */
14806
+ lead_user?: string | null;
14807
+ /** Fields */
14808
+ fields?: {
14809
+ [key: string]: unknown;
14810
+ } | null;
14811
+ /** Field Schema */
14812
+ field_schema?: components['schemas']['FieldSchemaEntry'][] | null;
14226
14813
  /** Name */
14227
14814
  name: string;
14228
14815
  /**
@@ -14234,6 +14821,30 @@ interface components {
14234
14821
  /** Daily Cap Per User */
14235
14822
  daily_cap_per_user?: number | null;
14236
14823
  };
14824
+ /**
14825
+ * ProjectEventResponse
14826
+ * @description One entry of ``GET /v1/project/{id}/events``: ``detail`` is ``{"from": …, "to": …}`` (null = unset).
14827
+ */
14828
+ ProjectEventResponse: {
14829
+ /** External Id */
14830
+ external_id: string;
14831
+ /**
14832
+ * Kind
14833
+ * @enum {string}
14834
+ */
14835
+ kind: 'stage_changed' | 'budget_changed';
14836
+ /** Actor */
14837
+ actor?: string | null;
14838
+ /** Detail */
14839
+ detail: {
14840
+ [key: string]: unknown;
14841
+ };
14842
+ /**
14843
+ * Created At
14844
+ * Format: date-time
14845
+ */
14846
+ created_at: string;
14847
+ };
14237
14848
  /**
14238
14849
  * ProjectInvoice
14239
14850
  * @description Single Stripe invoice/receipt for a project: the plan, prorations and add-on charges.
@@ -14362,9 +14973,10 @@ interface components {
14362
14973
  * Listed for both project owners and workspace members of the project. For
14363
14974
  * non-owner viewers, ``subscription``, ``plan_interval``, ``addons``, ``quotas`` and the
14364
14975
  * Stripe billing fields are blanked out (zeros / "none" / null) — only
14365
- * ``name``, ``external_id``, ``created_by``, and ``daily_cap_per_user`` are
14366
- * meaningful. Frontend distinguishes the two modes by comparing
14367
- * ``created_by`` against the current user's external_id.
14976
+ * ``name``, ``external_id``, ``created_by``, ``daily_cap_per_user`` and the
14977
+ * host-defined fields (``budget`` … ``field_schema``) are meaningful. Frontend
14978
+ * distinguishes the two modes by comparing ``created_by`` against the current
14979
+ * user's external_id.
14368
14980
  */
14369
14981
  ProjectResponse: {
14370
14982
  /** External Id */
@@ -14383,6 +14995,23 @@ interface components {
14383
14995
  quotas: components['schemas']['ProjectQuotas'];
14384
14996
  /** Daily Cap Per User */
14385
14997
  daily_cap_per_user?: number | null;
14998
+ budget?: components['schemas']['ProjectBudget'] | null;
14999
+ /** Client */
15000
+ client?: string | null;
15001
+ /** Client Ref */
15002
+ client_ref?: string | null;
15003
+ /** Stage */
15004
+ stage?: string | null;
15005
+ /** Stage Changed At */
15006
+ stage_changed_at?: string | null;
15007
+ /** Lead User */
15008
+ lead_user?: string | null;
15009
+ /** Fields */
15010
+ fields?: {
15011
+ [key: string]: unknown;
15012
+ };
15013
+ /** Field Schema */
15014
+ field_schema?: components['schemas']['FieldSchemaEntry'][] | null;
14386
15015
  /** Plan Interval */
14387
15016
  plan_interval?: ('month' | 'year') | null;
14388
15017
  /**
@@ -14411,9 +15040,24 @@ interface components {
14411
15040
  };
14412
15041
  /**
14413
15042
  * ProjectUpdateRequest
14414
- * @description Update project name and/or daily per-user cap.
15043
+ * @description Update a project (PATCH): omitted fields are unchanged, null clears; ``fields`` merges key by key.
14415
15044
  */
14416
15045
  ProjectUpdateRequest: {
15046
+ budget?: components['schemas']['ProjectBudget'] | null;
15047
+ /** Client */
15048
+ client?: string | null;
15049
+ /** Client Ref */
15050
+ client_ref?: string | null;
15051
+ /** Stage */
15052
+ stage?: string | null;
15053
+ /** Lead User */
15054
+ lead_user?: string | null;
15055
+ /** Fields */
15056
+ fields?: {
15057
+ [key: string]: unknown;
15058
+ } | null;
15059
+ /** Field Schema */
15060
+ field_schema?: components['schemas']['FieldSchemaEntry'][] | null;
14417
15061
  /** Name */
14418
15062
  name?: string | null;
14419
15063
  /** Daily Cap Per User */
@@ -16618,7 +17262,10 @@ interface components {
16618
17262
  * @description A person finishes a step of a workflow run (``POST /v1/conversation/{id}/step``).
16619
17263
  *
16620
17264
  * ``complete`` finishes a form (``inputs`` merge into the run's inputs), an upload, or a review (the
16621
- * approval: whoever completes it is recorded). ``skip`` passes over a step so what waits for it can go on.
17265
+ * approval: whoever completes it is recorded, with what it approved). A step that declares ``fields`` checks
17266
+ * ``inputs`` against them. ``skip`` passes over a step so what waits for it can go on. ``send_back`` returns the
17267
+ * work to an earlier step (``to``, default the one this step waits for) with an optional ``note``: that step
17268
+ * and everything after it are open again, and an agent step runs again with the note.
16622
17269
  */
16623
17270
  StepActionRequest: {
16624
17271
  /** Step */
@@ -16627,11 +17274,118 @@ interface components {
16627
17274
  * Action
16628
17275
  * @enum {string}
16629
17276
  */
16630
- action: 'complete' | 'skip';
17277
+ action: 'complete' | 'skip' | 'send_back';
16631
17278
  /** Inputs */
16632
17279
  inputs?: {
16633
17280
  [key: string]: unknown;
16634
17281
  } | null;
17282
+ /** To */
17283
+ to?: string | null;
17284
+ /** Note */
17285
+ note?: string | null;
17286
+ };
17287
+ /**
17288
+ * StepAssignee
17289
+ * @description Who a step is for: told when it is ready (and when it is sent back), and the only person besides the run's
17290
+ * owner and a workspace owner who may complete it or send it back. Exactly one shape is set:
17291
+ *
17292
+ * - ``user``: a person (``usr-``) or an agent (``agt-``), by external id;
17293
+ * - ``run_owner``: the run's owner (the conversation's creator);
17294
+ * - ``input``: the person named by one of the run's inputs (a form's person field), read when the step is ready;
17295
+ * - ``project_lead``: the lead (``lead_user``) of the project the run's workspace belongs to, read when the step
17296
+ * is ready. A project without a lead names no one.
17297
+ *
17298
+ * No assignee means the run's owner hears of it, and any editor may act on it (as before).
17299
+ */
17300
+ StepAssignee: {
17301
+ /** User */
17302
+ user?: string | null;
17303
+ /** Run Owner */
17304
+ run_owner?: true | null;
17305
+ /** Input */
17306
+ input?: string | null;
17307
+ /** Project Lead */
17308
+ project_lead?: true | null;
17309
+ };
17310
+ /**
17311
+ * StepField
17312
+ * @description One field a step asks for (the shape of a form step's fields): what ``complete`` checks its ``inputs``
17313
+ * against. Keys a client only shows (``description``, ``placeholder``, ``trueText``, ...) pass through.
17314
+ * A ``person`` field holds a person's external id (``usr-``/``agt-``), which an ``{input: name}`` assignee reads.
17315
+ */
17316
+ StepField: {
17317
+ /** Name */
17318
+ name: string;
17319
+ /**
17320
+ * Type
17321
+ * @default text
17322
+ * @enum {string}
17323
+ */
17324
+ type: 'text' | 'longtext' | 'boolean' | 'select' | 'number' | 'date' | 'scope' | 'documents' | 'person';
17325
+ /** Label */
17326
+ label?: string | null;
17327
+ /**
17328
+ * Required
17329
+ * @default false
17330
+ */
17331
+ required: boolean;
17332
+ /** Options */
17333
+ options?: components['schemas']['StepFieldOption'][] | null;
17334
+ /** Min */
17335
+ min?: number | null;
17336
+ /** Max */
17337
+ max?: number | null;
17338
+ } & {
17339
+ [key: string]: unknown;
17340
+ };
17341
+ /**
17342
+ * StepFieldOption
17343
+ * @description One choice of a ``select`` field. Other keys a client shows (``description``, ``icon``, ...) pass through.
17344
+ */
17345
+ StepFieldOption: {
17346
+ /** Value */
17347
+ value: string;
17348
+ /** Label */
17349
+ label?: string | null;
17350
+ } & {
17351
+ [key: string]: unknown;
17352
+ };
17353
+ /**
17354
+ * StepSignal
17355
+ * @description A named signal a step raises when it is done and its condition holds (``src/core/workflow_signals.py``).
17356
+ *
17357
+ * Raising it records a ``step_signal`` event on the thread and sends the run's owner a ``workflow_signal``
17358
+ * notification, which an event workflow (``event_kind="workflow_signal"``, ``event_filter={"signal": name}``)
17359
+ * starts on: the "then" of an if/then lives in that link, not in the workflow.
17360
+ */
17361
+ StepSignal: {
17362
+ /** Name */
17363
+ name: string;
17364
+ when?: components['schemas']['StepSignalWhen'] | null;
17365
+ };
17366
+ /**
17367
+ * StepSignalWhen
17368
+ * @description The condition a step's outcome must meet for its signal to be raised. Exactly one shape is set:
17369
+ *
17370
+ * - a **form** (or upload) step: ``field`` equals ``equals`` (case-insensitive text; a list field
17371
+ * contains it);
17372
+ * - an **agent** step: its answer ``contains`` a phrase (case-insensitive), or ``matches`` a regex;
17373
+ * - a **review** step: ``approved`` (completed, not skipped).
17374
+ *
17375
+ * No condition at all (``when`` omitted) raises the signal whenever the step is done. This is plaintext
17376
+ * configuration like the step's ``prompt``; the answer it is tested against is never stored.
17377
+ */
17378
+ StepSignalWhen: {
17379
+ /** Field */
17380
+ field?: string | null;
17381
+ /** Equals */
17382
+ equals?: string | number | boolean | null;
17383
+ /** Contains */
17384
+ contains?: string | null;
17385
+ /** Matches */
17386
+ matches?: string | null;
17387
+ /** Approved */
17388
+ approved?: boolean | null;
16635
17389
  };
16636
17390
  /**
16637
17391
  * StepUsage
@@ -16896,6 +17650,25 @@ interface components {
16896
17650
  */
16897
17651
  requests: number;
16898
17652
  };
17653
+ /**
17654
+ * TagField
17655
+ * @description A field a tag has — its own, or inherited from an ancestor (``tag_ext_id`` says which tag defines it).
17656
+ */
17657
+ TagField: {
17658
+ /** Id */
17659
+ id: string;
17660
+ /** Name */
17661
+ name: string;
17662
+ /**
17663
+ * Type
17664
+ * @enum {string}
17665
+ */
17666
+ type: 'text' | 'number' | 'date' | 'checkbox' | 'select' | 'person';
17667
+ /** Options */
17668
+ options?: string[] | null;
17669
+ /** Tag Ext Id */
17670
+ tag_ext_id: string;
17671
+ };
16899
17672
  /**
16900
17673
  * TagFormat
16901
17674
  * @description Tag format configuration stored as JSONB.
@@ -16918,37 +17691,22 @@ interface components {
16918
17691
  */
16919
17692
  options: string[];
16920
17693
  };
16921
- /** TagResponse */
16922
- TagResponse: {
16923
- /** External Id */
16924
- external_id: string;
16925
- /** Workspace Ext Id */
16926
- workspace_ext_id: string;
16927
- /** Name */
16928
- name: string;
16929
- /** Instruction */
16930
- instruction?: string | null;
16931
- tag_type: components['schemas']['TagFormat'];
16932
- /** Shared */
16933
- shared: boolean;
16934
- /** Parent Ext Id */
16935
- parent_ext_id?: string | null;
16936
- /** Doctag Count */
16937
- doctag_count: number;
17694
+ /**
17695
+ * TagMatrixDocLink
17696
+ * @description A document a matrix tag is applied to: the doctag's note is the link's value.
17697
+ */
17698
+ TagMatrixDocLink: {
17699
+ /** Doc Ext Id */
17700
+ doc_ext_id: string;
17701
+ /** File Name */
17702
+ file_name: string;
17703
+ /** Note */
17704
+ note?: string | null;
16938
17705
  /**
16939
- * Facttag Count
17706
+ * Citations Count
16940
17707
  * @default 0
16941
17708
  */
16942
- facttag_count: number;
16943
- /** Created By Ext Id */
16944
- created_by_ext_id: string;
16945
- /** Updated By Ext Id */
16946
- updated_by_ext_id?: string | null;
16947
- /**
16948
- * Created At
16949
- * Format: date-time
16950
- */
16951
- created_at: string;
17709
+ citations_count: number;
16952
17710
  /**
16953
17711
  * Updated At
16954
17712
  * Format: date-time
@@ -16956,8 +17714,97 @@ interface components {
16956
17714
  updated_at: string;
16957
17715
  };
16958
17716
  /**
16959
- * TagTemplate
16960
- * @description Base template for tag configuration - used for seeding default tags.
17717
+ * TagMatrixFactLink
17718
+ * @description A fact carrying a matrix tag. A plain link: the fact is relevant to the tag's category.
17719
+ */
17720
+ TagMatrixFactLink: {
17721
+ /** Fact Ext Id */
17722
+ fact_ext_id: string;
17723
+ /** Text */
17724
+ text: string;
17725
+ /** Confirmed */
17726
+ confirmed: boolean;
17727
+ /**
17728
+ * Updated At
17729
+ * Format: date-time
17730
+ */
17731
+ updated_at: string;
17732
+ };
17733
+ /** TagMatrixResponse */
17734
+ TagMatrixResponse: {
17735
+ /** Rows */
17736
+ rows?: components['schemas']['TagMatrixRow'][];
17737
+ parent?: components['schemas']['TagResponse'] | null;
17738
+ /** Links Limit */
17739
+ links_limit: number;
17740
+ };
17741
+ /**
17742
+ * TagMatrixRow
17743
+ * @description One tag of the matrix with its evidence. ``docs``/``facts`` are capped; the counts are the totals.
17744
+ */
17745
+ TagMatrixRow: {
17746
+ tag: components['schemas']['TagResponse'];
17747
+ /** Docs */
17748
+ docs?: components['schemas']['TagMatrixDocLink'][];
17749
+ /** Facts */
17750
+ facts?: components['schemas']['TagMatrixFactLink'][];
17751
+ /**
17752
+ * Doc Count
17753
+ * @default 0
17754
+ */
17755
+ doc_count: number;
17756
+ /**
17757
+ * Fact Count
17758
+ * @default 0
17759
+ */
17760
+ fact_count: number;
17761
+ };
17762
+ /** TagResponse */
17763
+ TagResponse: {
17764
+ /** External Id */
17765
+ external_id: string;
17766
+ /** Workspace Ext Id */
17767
+ workspace_ext_id: string;
17768
+ /** Name */
17769
+ name: string;
17770
+ /** Instruction */
17771
+ instruction?: string | null;
17772
+ tag_type: components['schemas']['TagFormat'];
17773
+ /** Shared */
17774
+ shared: boolean;
17775
+ /** Parent Ext Id */
17776
+ parent_ext_id?: string | null;
17777
+ /** Doctag Count */
17778
+ doctag_count: number;
17779
+ /**
17780
+ * Facttag Count
17781
+ * @default 0
17782
+ */
17783
+ facttag_count: number;
17784
+ /** Fields */
17785
+ fields?: components['schemas']['TagField'][];
17786
+ /** Field Values */
17787
+ field_values?: {
17788
+ [key: string]: unknown;
17789
+ };
17790
+ /** Created By Ext Id */
17791
+ created_by_ext_id: string;
17792
+ /** Updated By Ext Id */
17793
+ updated_by_ext_id?: string | null;
17794
+ /**
17795
+ * Created At
17796
+ * Format: date-time
17797
+ */
17798
+ created_at: string;
17799
+ /**
17800
+ * Updated At
17801
+ * Format: date-time
17802
+ */
17803
+ updated_at: string;
17804
+ };
17805
+ /**
17806
+ * TagTemplate
17807
+ * @description Base template for tag configuration - used for seeding default tags.
16961
17808
  */
16962
17809
  TagTemplate: {
16963
17810
  /** Name */
@@ -17083,6 +17930,13 @@ interface components {
17083
17930
  ui?: {
17084
17931
  [key: string]: unknown;
17085
17932
  } | null;
17933
+ /** Signals */
17934
+ signals?: components['schemas']['StepSignal'][];
17935
+ assignee?: components['schemas']['StepAssignee'] | null;
17936
+ /** Remind After Hours */
17937
+ remind_after_hours?: number | null;
17938
+ /** Fields */
17939
+ fields?: components['schemas']['StepField'][] | null;
17086
17940
  };
17087
17941
  /**
17088
17942
  * TaskUpdateMessage
@@ -17727,6 +18581,18 @@ interface components {
17727
18581
  * @description Parent tag external ID. Send null to un-nest the tag; omit to leave the parent unchanged.
17728
18582
  */
17729
18583
  parent_ext_id?: string | null;
18584
+ /**
18585
+ * Fields
18586
+ * @description The tag's own fields, in full: give a field's id to keep it (its type cannot change), omit the id to add one; fields left out are dropped. Inherited fields are changed on the tag that defines them.
18587
+ */
18588
+ fields?: components['schemas']['FieldDefinitionWrite'][] | null;
18589
+ /**
18590
+ * Field Values
18591
+ * @description Merged into the current values, keyed by field id or name; null clears a field.
18592
+ */
18593
+ field_values?: {
18594
+ [key: string]: unknown;
18595
+ } | null;
17730
18596
  };
17731
18597
  /**
17732
18598
  * UpdateWorkflowRequest
@@ -18008,7 +18874,7 @@ interface components {
18008
18874
  content: string;
18009
18875
  /** Tools */
18010
18876
  tools?: {
18011
- [key: string]: components['schemas']['ModelCitationTool'] | components['schemas']['RetrievalChunkTool'] | components['schemas']['RetrievalFullContextTool'] | components['schemas']['RetrievalTOCTool'] | components['schemas']['TraceTool'] | components['schemas']['CompactionTool'] | components['schemas']['PersonalAgentTool'] | components['schemas']['StreamEventsTool'] | components['schemas']['MemoryTool'] | components['schemas']['GoalTool'] | components['schemas']['FactsContextTool'] | components['schemas']['ImageGenerationTool'] | components['schemas']['SubagentTool'];
18877
+ [key: string]: components['schemas']['ModelCitationTool'] | components['schemas']['RetrievalChunkTool'] | components['schemas']['RetrievalFullContextTool'] | components['schemas']['RetrievalTOCTool'] | components['schemas']['TraceTool'] | components['schemas']['CompactionTool'] | components['schemas']['PersonalAgentTool'] | components['schemas']['StreamEventsTool'] | components['schemas']['MemoryTool'] | components['schemas']['GoalTool'] | components['schemas']['FactsContextTool'] | components['schemas']['ImageGenerationTool'] | components['schemas']['SubagentTool'] | components['schemas']['WorkflowStepTool'];
18012
18878
  };
18013
18879
  /** Config Ext Id */
18014
18880
  config_ext_id?: string | null;
@@ -18674,6 +19540,26 @@ interface components {
18674
19540
  /** Error */
18675
19541
  error?: string | null;
18676
19542
  };
19543
+ /**
19544
+ * WorkflowStepTool
19545
+ * @description Marks the user message the server sends to start a workflow's agent step (its wake instruction) with the
19546
+ * step it belongs to, so a client can show it as that step rather than as the raw instruction. Plaintext: the step
19547
+ * id only (the step's title stays encrypted in the conversation's plan).
19548
+ */
19549
+ WorkflowStepTool: {
19550
+ /**
19551
+ * @description discriminator enum property added by openapi-typescript
19552
+ * @enum {string}
19553
+ */
19554
+ name: 'workflow_step';
19555
+ /**
19556
+ * Description
19557
+ * @default workflow step
19558
+ */
19559
+ description: string;
19560
+ /** Workflow Step */
19561
+ workflow_step: string;
19562
+ };
18677
19563
  /**
18678
19564
  * WorkingHours
18679
19565
  * @description Working hours for one weekday (0 = Monday). Times are local ``HH:MM`` in the settings time zone.
@@ -18976,7 +19862,12 @@ type $defs = Record<string, never>;
18976
19862
  interface operations {
18977
19863
  list_projects: {
18978
19864
  parameters: {
18979
- query?: never;
19865
+ query?: {
19866
+ /** @description Only projects at this stage */
19867
+ stage?: string | null;
19868
+ /** @description Only projects led by this member */
19869
+ lead_user?: string | null;
19870
+ };
18980
19871
  header?: never;
18981
19872
  path?: never;
18982
19873
  cookie?: never;
@@ -18992,6 +19883,15 @@ interface operations {
18992
19883
  'application/json': components['schemas']['ProjectResponse'][];
18993
19884
  };
18994
19885
  };
19886
+ /** @description Validation Error */
19887
+ 422: {
19888
+ headers: {
19889
+ [name: string]: unknown;
19890
+ };
19891
+ content: {
19892
+ 'application/json': components['schemas']['HTTPValidationError'];
19893
+ };
19894
+ };
18995
19895
  };
18996
19896
  };
18997
19897
  create_project: {
@@ -19122,6 +20022,40 @@ interface operations {
19122
20022
  };
19123
20023
  };
19124
20024
  };
20025
+ list_project_events: {
20026
+ parameters: {
20027
+ query?: {
20028
+ kind?: ('stage_changed' | 'budget_changed') | null;
20029
+ limit?: number;
20030
+ };
20031
+ header?: never;
20032
+ path: {
20033
+ project_ext_id: string;
20034
+ };
20035
+ cookie?: never;
20036
+ };
20037
+ requestBody?: never;
20038
+ responses: {
20039
+ /** @description Successful Response */
20040
+ 200: {
20041
+ headers: {
20042
+ [name: string]: unknown;
20043
+ };
20044
+ content: {
20045
+ 'application/json': components['schemas']['ProjectEventResponse'][];
20046
+ };
20047
+ };
20048
+ /** @description Validation Error */
20049
+ 422: {
20050
+ headers: {
20051
+ [name: string]: unknown;
20052
+ };
20053
+ content: {
20054
+ 'application/json': components['schemas']['HTTPValidationError'];
20055
+ };
20056
+ };
20057
+ };
20058
+ };
19125
20059
  quote_project_plan: {
19126
20060
  parameters: {
19127
20061
  query?: never;
@@ -19329,6 +20263,40 @@ interface operations {
19329
20263
  };
19330
20264
  };
19331
20265
  };
20266
+ get_project_conversation_usage: {
20267
+ parameters: {
20268
+ query?: {
20269
+ /** @description 0 = current billing period, 1 = previous month, etc. */
20270
+ months_back?: number;
20271
+ };
20272
+ header?: never;
20273
+ path: {
20274
+ project_ext_id: string;
20275
+ };
20276
+ cookie?: never;
20277
+ };
20278
+ requestBody?: never;
20279
+ responses: {
20280
+ /** @description Successful Response */
20281
+ 200: {
20282
+ headers: {
20283
+ [name: string]: unknown;
20284
+ };
20285
+ content: {
20286
+ 'application/json': components['schemas']['ProjectConversationUsageResponse'];
20287
+ };
20288
+ };
20289
+ /** @description Validation Error */
20290
+ 422: {
20291
+ headers: {
20292
+ [name: string]: unknown;
20293
+ };
20294
+ content: {
20295
+ 'application/json': components['schemas']['HTTPValidationError'];
20296
+ };
20297
+ };
20298
+ };
20299
+ };
19332
20300
  get_project_invoices: {
19333
20301
  parameters: {
19334
20302
  query?: never;
@@ -22566,6 +23534,37 @@ interface operations {
22566
23534
  };
22567
23535
  };
22568
23536
  };
23537
+ get_conversation_usage: {
23538
+ parameters: {
23539
+ query?: never;
23540
+ header?: never;
23541
+ path: {
23542
+ conversation_ext_id: string;
23543
+ };
23544
+ cookie?: never;
23545
+ };
23546
+ requestBody?: never;
23547
+ responses: {
23548
+ /** @description Successful Response */
23549
+ 200: {
23550
+ headers: {
23551
+ [name: string]: unknown;
23552
+ };
23553
+ content: {
23554
+ 'application/json': components['schemas']['ConversationUsageResponse'];
23555
+ };
23556
+ };
23557
+ /** @description Validation Error */
23558
+ 422: {
23559
+ headers: {
23560
+ [name: string]: unknown;
23561
+ };
23562
+ content: {
23563
+ 'application/json': components['schemas']['HTTPValidationError'];
23564
+ };
23565
+ };
23566
+ };
23567
+ };
22569
23568
  search_conversations: {
22570
23569
  parameters: {
22571
23570
  query?: never;
@@ -23372,6 +24371,42 @@ interface operations {
23372
24371
  };
23373
24372
  };
23374
24373
  };
24374
+ get_tag_matrix: {
24375
+ parameters: {
24376
+ query?: {
24377
+ /** @description Rows are this tag's children, oldest first */
24378
+ parent_ext_id?: string | null;
24379
+ /** @description Rows are these tags, in this order (repeatable) */
24380
+ tag_ext_id?: string[] | null;
24381
+ /** @description Most documents and facts per row */
24382
+ links_limit?: number;
24383
+ };
24384
+ header?: never;
24385
+ path?: never;
24386
+ cookie?: never;
24387
+ };
24388
+ requestBody?: never;
24389
+ responses: {
24390
+ /** @description Successful Response */
24391
+ 200: {
24392
+ headers: {
24393
+ [name: string]: unknown;
24394
+ };
24395
+ content: {
24396
+ 'application/json': components['schemas']['TagMatrixResponse'];
24397
+ };
24398
+ };
24399
+ /** @description Validation Error */
24400
+ 422: {
24401
+ headers: {
24402
+ [name: string]: unknown;
24403
+ };
24404
+ content: {
24405
+ 'application/json': components['schemas']['HTTPValidationError'];
24406
+ };
24407
+ };
24408
+ };
24409
+ };
23375
24410
  create_tag: {
23376
24411
  parameters: {
23377
24412
  query?: never;
@@ -23715,6 +24750,433 @@ interface operations {
23715
24750
  };
23716
24751
  };
23717
24752
  };
24753
+ list_databases: {
24754
+ parameters: {
24755
+ query?: {
24756
+ /** @description Also list the databases of public workspaces */
24757
+ include_public?: boolean;
24758
+ };
24759
+ header?: never;
24760
+ path?: never;
24761
+ cookie?: never;
24762
+ };
24763
+ requestBody?: never;
24764
+ responses: {
24765
+ /** @description Successful Response */
24766
+ 200: {
24767
+ headers: {
24768
+ [name: string]: unknown;
24769
+ };
24770
+ content: {
24771
+ 'application/json': components['schemas']['DatabaseRead'][];
24772
+ };
24773
+ };
24774
+ /** @description Validation Error */
24775
+ 422: {
24776
+ headers: {
24777
+ [name: string]: unknown;
24778
+ };
24779
+ content: {
24780
+ 'application/json': components['schemas']['HTTPValidationError'];
24781
+ };
24782
+ };
24783
+ };
24784
+ };
24785
+ create_database: {
24786
+ parameters: {
24787
+ query?: never;
24788
+ header?: never;
24789
+ path?: never;
24790
+ cookie?: never;
24791
+ };
24792
+ requestBody: {
24793
+ content: {
24794
+ 'application/json': components['schemas']['DatabaseCreate'];
24795
+ };
24796
+ };
24797
+ responses: {
24798
+ /** @description Successful Response */
24799
+ 200: {
24800
+ headers: {
24801
+ [name: string]: unknown;
24802
+ };
24803
+ content: {
24804
+ 'application/json': components['schemas']['DatabaseRead'];
24805
+ };
24806
+ };
24807
+ /** @description Validation Error */
24808
+ 422: {
24809
+ headers: {
24810
+ [name: string]: unknown;
24811
+ };
24812
+ content: {
24813
+ 'application/json': components['schemas']['HTTPValidationError'];
24814
+ };
24815
+ };
24816
+ };
24817
+ };
24818
+ import_database: {
24819
+ parameters: {
24820
+ query?: {
24821
+ /** @description Defaults to the file name */
24822
+ name?: string | null;
24823
+ /** @description XLSX sheet to read (default: the first) */
24824
+ sheet?: string | null;
24825
+ };
24826
+ header?: never;
24827
+ path?: never;
24828
+ cookie?: never;
24829
+ };
24830
+ requestBody: {
24831
+ content: {
24832
+ 'multipart/form-data': {
24833
+ /**
24834
+ * Format: binary
24835
+ * @description .csv or .xlsx; the first row is the header
24836
+ */
24837
+ file: string;
24838
+ };
24839
+ };
24840
+ };
24841
+ responses: {
24842
+ /** @description Successful Response */
24843
+ 200: {
24844
+ headers: {
24845
+ [name: string]: unknown;
24846
+ };
24847
+ content: {
24848
+ 'application/json': components['schemas']['DatabaseImportResult'];
24849
+ };
24850
+ };
24851
+ /** @description Validation Error */
24852
+ 422: {
24853
+ headers: {
24854
+ [name: string]: unknown;
24855
+ };
24856
+ content: {
24857
+ 'application/json': components['schemas']['HTTPValidationError'];
24858
+ };
24859
+ };
24860
+ };
24861
+ };
24862
+ get_database: {
24863
+ parameters: {
24864
+ query?: never;
24865
+ header?: never;
24866
+ path: {
24867
+ database_id: string;
24868
+ };
24869
+ cookie?: never;
24870
+ };
24871
+ requestBody?: never;
24872
+ responses: {
24873
+ /** @description Successful Response */
24874
+ 200: {
24875
+ headers: {
24876
+ [name: string]: unknown;
24877
+ };
24878
+ content: {
24879
+ 'application/json': components['schemas']['DatabaseRead'];
24880
+ };
24881
+ };
24882
+ /** @description Validation Error */
24883
+ 422: {
24884
+ headers: {
24885
+ [name: string]: unknown;
24886
+ };
24887
+ content: {
24888
+ 'application/json': components['schemas']['HTTPValidationError'];
24889
+ };
24890
+ };
24891
+ };
24892
+ };
24893
+ delete_database: {
24894
+ parameters: {
24895
+ query?: never;
24896
+ header?: never;
24897
+ path: {
24898
+ database_id: string;
24899
+ };
24900
+ cookie?: never;
24901
+ };
24902
+ requestBody?: never;
24903
+ responses: {
24904
+ /** @description Successful Response */
24905
+ 204: {
24906
+ headers: {
24907
+ [name: string]: unknown;
24908
+ };
24909
+ content?: never;
24910
+ };
24911
+ /** @description Validation Error */
24912
+ 422: {
24913
+ headers: {
24914
+ [name: string]: unknown;
24915
+ };
24916
+ content: {
24917
+ 'application/json': components['schemas']['HTTPValidationError'];
24918
+ };
24919
+ };
24920
+ };
24921
+ };
24922
+ update_database: {
24923
+ parameters: {
24924
+ query?: never;
24925
+ header?: never;
24926
+ path: {
24927
+ database_id: string;
24928
+ };
24929
+ cookie?: never;
24930
+ };
24931
+ requestBody: {
24932
+ content: {
24933
+ 'application/json': components['schemas']['DatabaseUpdate'];
24934
+ };
24935
+ };
24936
+ responses: {
24937
+ /** @description Successful Response */
24938
+ 200: {
24939
+ headers: {
24940
+ [name: string]: unknown;
24941
+ };
24942
+ content: {
24943
+ 'application/json': components['schemas']['DatabaseRead'];
24944
+ };
24945
+ };
24946
+ /** @description Validation Error */
24947
+ 422: {
24948
+ headers: {
24949
+ [name: string]: unknown;
24950
+ };
24951
+ content: {
24952
+ 'application/json': components['schemas']['HTTPValidationError'];
24953
+ };
24954
+ };
24955
+ };
24956
+ };
24957
+ list_database_rows: {
24958
+ parameters: {
24959
+ query?: {
24960
+ /** @description Case-insensitive text in any cell */
24961
+ q?: string | null;
24962
+ /** @description Column id or name to sort by */
24963
+ sort?: string | null;
24964
+ descending?: boolean;
24965
+ offset?: number;
24966
+ limit?: number;
24967
+ };
24968
+ header?: never;
24969
+ path: {
24970
+ database_id: string;
24971
+ };
24972
+ cookie?: never;
24973
+ };
24974
+ requestBody?: never;
24975
+ responses: {
24976
+ /** @description Successful Response */
24977
+ 200: {
24978
+ headers: {
24979
+ [name: string]: unknown;
24980
+ };
24981
+ content: {
24982
+ 'application/json': components['schemas']['DatabaseRowPage'];
24983
+ };
24984
+ };
24985
+ /** @description Validation Error */
24986
+ 422: {
24987
+ headers: {
24988
+ [name: string]: unknown;
24989
+ };
24990
+ content: {
24991
+ 'application/json': components['schemas']['HTTPValidationError'];
24992
+ };
24993
+ };
24994
+ };
24995
+ };
24996
+ add_database_rows: {
24997
+ parameters: {
24998
+ query?: never;
24999
+ header?: never;
25000
+ path: {
25001
+ database_id: string;
25002
+ };
25003
+ cookie?: never;
25004
+ };
25005
+ requestBody: {
25006
+ content: {
25007
+ 'application/json': components['schemas']['DatabaseRowsCreate'];
25008
+ };
25009
+ };
25010
+ responses: {
25011
+ /** @description Successful Response */
25012
+ 200: {
25013
+ headers: {
25014
+ [name: string]: unknown;
25015
+ };
25016
+ content: {
25017
+ 'application/json': components['schemas']['DatabaseRowRead'][];
25018
+ };
25019
+ };
25020
+ /** @description Validation Error */
25021
+ 422: {
25022
+ headers: {
25023
+ [name: string]: unknown;
25024
+ };
25025
+ content: {
25026
+ 'application/json': components['schemas']['HTTPValidationError'];
25027
+ };
25028
+ };
25029
+ };
25030
+ };
25031
+ update_database_row: {
25032
+ parameters: {
25033
+ query?: never;
25034
+ header?: never;
25035
+ path: {
25036
+ database_id: string;
25037
+ row_id: string;
25038
+ };
25039
+ cookie?: never;
25040
+ };
25041
+ requestBody: {
25042
+ content: {
25043
+ 'application/json': components['schemas']['DatabaseRowWrite'];
25044
+ };
25045
+ };
25046
+ responses: {
25047
+ /** @description Successful Response */
25048
+ 200: {
25049
+ headers: {
25050
+ [name: string]: unknown;
25051
+ };
25052
+ content: {
25053
+ 'application/json': components['schemas']['DatabaseRowRead'];
25054
+ };
25055
+ };
25056
+ /** @description Validation Error */
25057
+ 422: {
25058
+ headers: {
25059
+ [name: string]: unknown;
25060
+ };
25061
+ content: {
25062
+ 'application/json': components['schemas']['HTTPValidationError'];
25063
+ };
25064
+ };
25065
+ };
25066
+ };
25067
+ delete_database_rows: {
25068
+ parameters: {
25069
+ query?: never;
25070
+ header?: never;
25071
+ path: {
25072
+ database_id: string;
25073
+ };
25074
+ cookie?: never;
25075
+ };
25076
+ requestBody: {
25077
+ content: {
25078
+ 'application/json': components['schemas']['DatabaseRowsDelete'];
25079
+ };
25080
+ };
25081
+ responses: {
25082
+ /** @description Successful Response */
25083
+ 204: {
25084
+ headers: {
25085
+ [name: string]: unknown;
25086
+ };
25087
+ content?: never;
25088
+ };
25089
+ /** @description Validation Error */
25090
+ 422: {
25091
+ headers: {
25092
+ [name: string]: unknown;
25093
+ };
25094
+ content: {
25095
+ 'application/json': components['schemas']['HTTPValidationError'];
25096
+ };
25097
+ };
25098
+ };
25099
+ };
25100
+ import_database_rows: {
25101
+ parameters: {
25102
+ query?: {
25103
+ /** @description XLSX sheet to read (default: the first) */
25104
+ sheet?: string | null;
25105
+ /** @description Add a column for each header that matches none */
25106
+ add_columns?: boolean;
25107
+ };
25108
+ header?: never;
25109
+ path: {
25110
+ database_id: string;
25111
+ };
25112
+ cookie?: never;
25113
+ };
25114
+ requestBody: {
25115
+ content: {
25116
+ 'multipart/form-data': {
25117
+ /**
25118
+ * Format: binary
25119
+ * @description .csv or .xlsx; the first row is the header
25120
+ */
25121
+ file: string;
25122
+ };
25123
+ };
25124
+ };
25125
+ responses: {
25126
+ /** @description Successful Response */
25127
+ 200: {
25128
+ headers: {
25129
+ [name: string]: unknown;
25130
+ };
25131
+ content: {
25132
+ 'application/json': components['schemas']['DatabaseImportResult'];
25133
+ };
25134
+ };
25135
+ /** @description Validation Error */
25136
+ 422: {
25137
+ headers: {
25138
+ [name: string]: unknown;
25139
+ };
25140
+ content: {
25141
+ 'application/json': components['schemas']['HTTPValidationError'];
25142
+ };
25143
+ };
25144
+ };
25145
+ };
25146
+ export_database: {
25147
+ parameters: {
25148
+ query?: {
25149
+ format?: 'csv' | 'xlsx';
25150
+ };
25151
+ header?: never;
25152
+ path: {
25153
+ database_id: string;
25154
+ };
25155
+ cookie?: never;
25156
+ };
25157
+ requestBody?: never;
25158
+ responses: {
25159
+ /** @description Successful Response */
25160
+ 200: {
25161
+ headers: {
25162
+ [name: string]: unknown;
25163
+ };
25164
+ content: {
25165
+ 'text/csv': unknown;
25166
+ 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet': unknown;
25167
+ };
25168
+ };
25169
+ /** @description Validation Error */
25170
+ 422: {
25171
+ headers: {
25172
+ [name: string]: unknown;
25173
+ };
25174
+ content: {
25175
+ 'application/json': components['schemas']['HTTPValidationError'];
25176
+ };
25177
+ };
25178
+ };
25179
+ };
23718
25180
  list_workflows: {
23719
25181
  parameters: {
23720
25182
  query?: never;