@celigo/api-specs 0.2.215 → 0.2.217
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.
- package/dist/ai-agent.yml +132 -37
- package/dist/export.yml +68 -40
- package/dist/guardrail.yml +55 -17
- package/dist/import.yml +163 -39
- package/dist/tool.yml +231 -79
- package/package.json +1 -1
- package/schemas.json +9 -2
package/dist/tool.yml
CHANGED
|
@@ -21592,8 +21592,10 @@ components:
|
|
|
21592
21592
|
- **openai**: OpenAI models (GPT-4.1, GPT-5, etc.). Configure via the `openai` object.
|
|
21593
21593
|
- **gemini**: Google Gemini models via the LiteLLM proxy. Configure via `litellm` with overrides in `litellm._overrides.gemini`.
|
|
21594
21594
|
- **anthropic**: Anthropic Claude models via the LiteLLM proxy. Configure via `litellm` with overrides in `litellm._overrides.anthropic`.
|
|
21595
|
-
- **Catalog providers** —
|
|
21596
|
-
|
|
21595
|
+
- **Catalog providers** — every other value of `provider` (Mistral, xAI, Hugging Face,
|
|
21596
|
+
DeepSeek, Cohere, Groq, Together AI, Azure OpenAI, Fireworks AI, AWS Bedrock, NVIDIA NIM,
|
|
21597
|
+
Ollama Cloud and Google Vertex AI today; the catalog grows without a platform release).
|
|
21598
|
+
Added as catalog data rather than platform code, they share one generic flat format:
|
|
21597
21599
|
`model`, `modelOptions`, `instructions`, `output`, and the `tools` / `prompts` /
|
|
21598
21600
|
`resources` arrays directly on this object.
|
|
21599
21601
|
|
|
@@ -21639,26 +21641,45 @@ components:
|
|
|
21639
21641
|
- deepseek
|
|
21640
21642
|
- cohere
|
|
21641
21643
|
- groq
|
|
21644
|
+
- together_ai
|
|
21645
|
+
- azure_ai
|
|
21646
|
+
- fireworks_ai
|
|
21647
|
+
- bedrock
|
|
21648
|
+
- nvidia_nim
|
|
21649
|
+
- ollama_chat
|
|
21650
|
+
- vertex_ai
|
|
21642
21651
|
x-enumDescriptions:
|
|
21643
|
-
openai: Use OpenAI models via the OpenAI Responses API (built-in; `openai` block)
|
|
21644
|
-
gemini: Use Google Gemini models via the LiteLLM proxy (built-in; `litellm` block)
|
|
21645
|
-
anthropic: Use Anthropic Claude models via the LiteLLM proxy (built-in; `litellm` block)
|
|
21646
|
-
mistral: Use Mistral models (catalog provider; generic flat format, BYOK)
|
|
21647
|
-
xai: Use xAI Grok models (catalog provider; generic flat format, BYOK)
|
|
21648
|
-
huggingface: Use Hugging Face inference endpoint models (catalog provider; generic flat format, BYOK)
|
|
21649
|
-
deepseek: Use DeepSeek models (catalog provider; generic flat format, BYOK)
|
|
21650
|
-
cohere: Use Cohere models (catalog provider; generic flat format, BYOK)
|
|
21651
|
-
groq: Use Groq-hosted models (catalog provider; generic flat format, BYOK)
|
|
21652
|
-
|
|
21652
|
+
openai: Use OpenAI models via the OpenAI Responses API (built-in; `openai` block; Celigo AI or BYOK)
|
|
21653
|
+
gemini: Use Google Gemini models via the LiteLLM proxy (built-in; `litellm` block; Celigo AI or BYOK)
|
|
21654
|
+
anthropic: Use Anthropic Claude models via the LiteLLM proxy (built-in; `litellm` block; Celigo AI or BYOK)
|
|
21655
|
+
mistral: Use Mistral models (catalog provider; generic flat format, BYOK)
|
|
21656
|
+
xai: Use xAI Grok models (catalog provider; generic flat format, BYOK)
|
|
21657
|
+
huggingface: Use Hugging Face inference endpoint models (catalog provider; generic flat format, BYOK)
|
|
21658
|
+
deepseek: Use DeepSeek models (catalog provider; generic flat format, BYOK)
|
|
21659
|
+
cohere: Use Cohere models (catalog provider; generic flat format, BYOK)
|
|
21660
|
+
groq: Use Groq-hosted models (catalog provider; generic flat format, BYOK)
|
|
21661
|
+
together_ai: Use models served by Together AI (catalog provider; generic flat format, BYOK)
|
|
21662
|
+
azure_ai: Use deployments on an Azure AI Foundry / Azure OpenAI resource — `model` is the deployment name (catalog provider; generic flat format, BYOK)
|
|
21663
|
+
fireworks_ai: Use models served by Fireworks AI (catalog provider; generic flat format, BYOK)
|
|
21664
|
+
bedrock: Use AWS Bedrock models through cross-region inference profile ids such as `global.anthropic.claude-sonnet-4-6` (catalog provider; generic flat format, BYOK)
|
|
21665
|
+
nvidia_nim: Use models served by NVIDIA NIM (catalog provider; generic flat format, BYOK)
|
|
21666
|
+
ollama_chat: Use models served by Ollama Cloud (catalog provider; generic flat format, BYOK)
|
|
21667
|
+
vertex_ai: Use Gemini models on Google Vertex AI with the customer's own GCP project (catalog provider; generic flat format, BYOK)
|
|
21668
|
+
description: |-
|
|
21669
|
+
AI provider to use. Built-in providers run on Celigo AI credentials or on a
|
|
21670
|
+
BYOK connection; every other provider is a catalog row that runs only on a BYOK
|
|
21671
|
+
connection. The catalog is data — a provider can be added without a platform
|
|
21672
|
+
release, and `GET /api/aiproviders` lists the rows currently offered.
|
|
21653
21673
|
x-celigo-ai-guidance:
|
|
21654
21674
|
- |-
|
|
21655
21675
|
The provider decides the configuration format, and the server rejects a
|
|
21656
21676
|
mismatch with 422 `invalid_provider_config_format`: `openai` needs the
|
|
21657
21677
|
`openai` block, `gemini` and `anthropic` need the `litellm` block (Gemini- or
|
|
21658
|
-
Claude-specific settings under `litellm._overrides`), and
|
|
21659
|
-
|
|
21660
|
-
|
|
21661
|
-
|
|
21678
|
+
Claude-specific settings under `litellm._overrides`), and every other
|
|
21679
|
+
provider (the catalog providers) needs the generic flat format — `model` and
|
|
21680
|
+
`modelOptions` directly on this object, never an `openai` or `litellm` block.
|
|
21681
|
+
Switching across that boundary replaces the whole configuration in the target
|
|
21682
|
+
format; nothing is translated field by field.
|
|
21662
21683
|
- |-
|
|
21663
21684
|
Catalog providers are BYOK-only, and the save enforces it through the model
|
|
21664
21685
|
catalog: without a `_connectionId` the agent fails to save with 422
|
|
@@ -21667,6 +21688,18 @@ components:
|
|
|
21667
21688
|
configuration.") — the model is a catalog row that is not offered on
|
|
21668
21689
|
platform-managed credentials. Attach an HTTP connection to the vendor's API
|
|
21669
21690
|
(token auth) before saving a catalog-provider agent.
|
|
21691
|
+
- |-
|
|
21692
|
+
Without a connection, a provider the catalog does not list is refused at the
|
|
21693
|
+
model check — 422 `ai_model_not_in_catalog` on `aiAgent.model` — so the
|
|
21694
|
+
message names the model, not the provider. Check the provider against the
|
|
21695
|
+
catalog before blaming the model.
|
|
21696
|
+
- |-
|
|
21697
|
+
For `azure_ai` and `bedrock` the vendor-specific settings ride the BYOK
|
|
21698
|
+
connection, not this object: an optional connection `baseURI` (the vendor
|
|
21699
|
+
endpoint the connector asks for), and connection settings forwarded to the
|
|
21700
|
+
vendor — Azure's `apiVersion`, Bedrock's `awsRegionName`. `bedrock`
|
|
21701
|
+
authenticates with a Bedrock API key (no IAM role); for `azure_ai`, `model` is
|
|
21702
|
+
the deployment name.
|
|
21670
21703
|
model:
|
|
21671
21704
|
type: string
|
|
21672
21705
|
description: |-
|
|
@@ -22139,13 +22172,27 @@ components:
|
|
|
22139
22172
|
web_search: Search the web for real-time information.
|
|
22140
22173
|
mcp: Connect to an MCP server for additional external tools.
|
|
22141
22174
|
image_generation: Generate images using an AI image model.
|
|
22142
|
-
code_execution: '
|
|
22175
|
+
code_execution: 'Let the model write and run code in OpenAI''s sandbox on a BYOK agent; carries no configuration block, send `{type: code_execution}` only'
|
|
22143
22176
|
tool: Reference a reusable Celigo Tool resource.
|
|
22144
22177
|
description: |-
|
|
22145
22178
|
Type of tool. Every type except `code_execution` is configured through the
|
|
22146
22179
|
sibling object of the same name; OpenAI spells this one `code_execution`, while
|
|
22147
22180
|
the Gemini and Anthropic overrides spell theirs `codeExecution` — the other spelling
|
|
22148
|
-
fails with 422 `enum`.
|
|
22181
|
+
fails with 422 `enum`. Code execution runs only on a BYOK agent and only on
|
|
22182
|
+
models that support it: the code runs in OpenAI's sandbox with no outbound
|
|
22183
|
+
network access, the session lasts one hour, and each execution is billed as an
|
|
22184
|
+
AI Action to the connection's OpenAI account rather than as Celigo AI credits.
|
|
22185
|
+
x-celigo-ai-guidance:
|
|
22186
|
+
- |-
|
|
22187
|
+
Add `code_execution` only when the agent has a `_connectionId`. The save does
|
|
22188
|
+
not check the credential type, but every run and preview of an agent on
|
|
22189
|
+
Celigo-managed credentials is refused with `Code Execution requires a BYOK
|
|
22190
|
+
connection.` — switch the agent to a BYOK connection or leave the tool out.
|
|
22191
|
+
- |-
|
|
22192
|
+
Send the tool as `{type: code_execution}` with no other key — a sandbox or
|
|
22193
|
+
options object on it is rejected. Check that the chosen model supports code
|
|
22194
|
+
execution before adding it; the platform does not verify that at save and
|
|
22195
|
+
the UI hides the tool for models that lack it.
|
|
22149
22196
|
webSearch:
|
|
22150
22197
|
type: object
|
|
22151
22198
|
description: Web search configuration (empty object to enable)
|
|
@@ -22499,12 +22546,28 @@ components:
|
|
|
22499
22546
|
googleSearch: Use Google Search for real-time information grounding.
|
|
22500
22547
|
urlContext: Retrieve and use content from specified URLs.
|
|
22501
22548
|
fileSearch: Search through previously uploaded files.
|
|
22502
|
-
codeExecution: '
|
|
22549
|
+
codeExecution: 'Let the model write and run code in Gemini''s sandbox on a BYOK agent; carries no configuration block, send `{type: codeExecution}` only'
|
|
22503
22550
|
mcp: Connect to an MCP server for additional external tools.
|
|
22504
22551
|
tool: Reference a reusable Celigo Tool resource.
|
|
22505
22552
|
description: |-
|
|
22506
22553
|
Type of Gemini tool. `codeExecution` is the Gemini spelling — `code_execution`
|
|
22507
|
-
fails with 422 `enum`.
|
|
22554
|
+
fails with 422 `enum`. Code execution runs only on a BYOK agent and only on
|
|
22555
|
+
models that support it (not on `gemini-2.5-flash-image`): the code runs in
|
|
22556
|
+
Gemini's sandbox with no outbound network access for up to 30 seconds per
|
|
22557
|
+
execution and at most 5 executions per API call (the limit resets each turn),
|
|
22558
|
+
and each execution is billed as an AI Action to the connection's Google
|
|
22559
|
+
account rather than as Celigo AI credits.
|
|
22560
|
+
x-celigo-ai-guidance:
|
|
22561
|
+
- |-
|
|
22562
|
+
Add `codeExecution` only when the agent has a `_connectionId`. The save does
|
|
22563
|
+
not check the credential type, but every run and preview of an agent on
|
|
22564
|
+
Celigo-managed credentials is refused with `Code Execution requires a BYOK
|
|
22565
|
+
connection.` — switch the agent to a BYOK connection or leave the tool out.
|
|
22566
|
+
- |-
|
|
22567
|
+
Send the tool as `{type: codeExecution}` with no other key — any other key on
|
|
22568
|
+
it is rejected. Check that the chosen model supports code execution before
|
|
22569
|
+
adding it; the platform does not verify that at save and the UI hides the
|
|
22570
|
+
tool for models that lack it.
|
|
22508
22571
|
googleSearch:
|
|
22509
22572
|
type: object
|
|
22510
22573
|
description: Google Search configuration (empty object to enable)
|
|
@@ -22836,10 +22899,26 @@ components:
|
|
|
22836
22899
|
tool: Reference a reusable Celigo Tool resource.
|
|
22837
22900
|
mcp: Connect to an MCP server for additional external tools.
|
|
22838
22901
|
webSearch: Search the web for real-time information.
|
|
22839
|
-
codeExecution: '
|
|
22902
|
+
codeExecution: 'Let the model write and run code in Anthropic''s sandbox on a BYOK agent (beta); carries no configuration block, send `{type: codeExecution}` only'
|
|
22840
22903
|
description: |-
|
|
22841
22904
|
Type of Claude tool. `codeExecution` is the Anthropic spelling — `code_execution`
|
|
22842
|
-
fails with 422 `enum`.
|
|
22905
|
+
fails with 422 `enum`. Code execution (beta on Anthropic) runs only on a BYOK
|
|
22906
|
+
agent and only on models that support it: the code runs per API call in
|
|
22907
|
+
Anthropic's sandbox (Python 3.11 with pandas, numpy and matplotlib) with no
|
|
22908
|
+
outbound network access and no state kept between turns, and each execution is
|
|
22909
|
+
billed as an AI Action to the connection's Anthropic account rather than as
|
|
22910
|
+
Celigo AI credits.
|
|
22911
|
+
x-celigo-ai-guidance:
|
|
22912
|
+
- |-
|
|
22913
|
+
Add `codeExecution` only when the agent has a `_connectionId`. The save does
|
|
22914
|
+
not check the credential type, but every run and preview of an agent on
|
|
22915
|
+
Celigo-managed credentials is refused with `Code Execution requires a BYOK
|
|
22916
|
+
connection.` — switch the agent to a BYOK connection or leave the tool out.
|
|
22917
|
+
- |-
|
|
22918
|
+
Send the tool as `{type: codeExecution}` with no other key — any other key on
|
|
22919
|
+
it is rejected. Check that the chosen model supports code execution before
|
|
22920
|
+
adding it; the platform does not verify that at save and the UI hides the
|
|
22921
|
+
tool for models that lack it.
|
|
22843
22922
|
tool:
|
|
22844
22923
|
type: object
|
|
22845
22924
|
description: Reference to a Celigo Tool resource, used when type is "tool".
|
|
@@ -23056,6 +23135,13 @@ components:
|
|
|
23056
23135
|
- deepseek
|
|
23057
23136
|
- cohere
|
|
23058
23137
|
- groq
|
|
23138
|
+
- together_ai
|
|
23139
|
+
- azure_ai
|
|
23140
|
+
- fireworks_ai
|
|
23141
|
+
- bedrock
|
|
23142
|
+
- nvidia_nim
|
|
23143
|
+
- ollama_chat
|
|
23144
|
+
- vertex_ai
|
|
23059
23145
|
required:
|
|
23060
23146
|
- provider
|
|
23061
23147
|
then:
|
|
@@ -23075,8 +23161,10 @@ components:
|
|
|
23075
23161
|
- **openai**: OpenAI models (GPT-4.1, GPT-5, etc.). Configure via the `openai` object.
|
|
23076
23162
|
- **gemini**: Google Gemini models via the LiteLLM proxy. Configure via `litellm` with overrides in `litellm._overrides.gemini`.
|
|
23077
23163
|
- **anthropic**: Anthropic Claude models via the LiteLLM proxy. Configure via `litellm` with overrides in `litellm._overrides.anthropic`.
|
|
23078
|
-
- **Catalog providers** —
|
|
23079
|
-
|
|
23164
|
+
- **Catalog providers** — every other value of `provider` (Mistral, xAI, Hugging Face,
|
|
23165
|
+
DeepSeek, Cohere, Groq, Together AI, Azure OpenAI, Fireworks AI, AWS Bedrock, NVIDIA NIM,
|
|
23166
|
+
Ollama Cloud and Google Vertex AI today; the catalog grows without a platform release).
|
|
23167
|
+
Added as catalog data rather than platform code, they share one generic flat format:
|
|
23080
23168
|
`model`, `modelOptions`, `instructions`, `output`, and the `prompts` / `resources`
|
|
23081
23169
|
arrays directly on this object.
|
|
23082
23170
|
|
|
@@ -23128,26 +23216,43 @@ components:
|
|
|
23128
23216
|
- deepseek
|
|
23129
23217
|
- cohere
|
|
23130
23218
|
- groq
|
|
23219
|
+
- together_ai
|
|
23220
|
+
- azure_ai
|
|
23221
|
+
- fireworks_ai
|
|
23222
|
+
- bedrock
|
|
23223
|
+
- nvidia_nim
|
|
23224
|
+
- ollama_chat
|
|
23225
|
+
- vertex_ai
|
|
23131
23226
|
x-enumDescriptions:
|
|
23132
|
-
openai: Use OpenAI models via the OpenAI Responses API (built-in; `openai` block)
|
|
23133
|
-
gemini: Use Google Gemini models via the LiteLLM proxy (built-in; `litellm` block)
|
|
23134
|
-
anthropic: Use Anthropic Claude models via the LiteLLM proxy (built-in; `litellm` block)
|
|
23135
|
-
mistral: Use Mistral models (catalog provider; generic flat format, BYOK)
|
|
23136
|
-
xai: Use xAI Grok models (catalog provider; generic flat format, BYOK)
|
|
23137
|
-
huggingface: Use Hugging Face inference endpoint models (catalog provider; generic flat format, BYOK)
|
|
23138
|
-
deepseek: Use DeepSeek models (catalog provider; generic flat format, BYOK)
|
|
23139
|
-
cohere: Use Cohere models (catalog provider; generic flat format, BYOK)
|
|
23140
|
-
groq: Use Groq-hosted models (catalog provider; generic flat format, BYOK)
|
|
23141
|
-
|
|
23227
|
+
openai: Use OpenAI models via the OpenAI Responses API (built-in; `openai` block; Celigo AI or BYOK)
|
|
23228
|
+
gemini: Use Google Gemini models via the LiteLLM proxy (built-in; `litellm` block; Celigo AI or BYOK)
|
|
23229
|
+
anthropic: Use Anthropic Claude models via the LiteLLM proxy (built-in; `litellm` block; Celigo AI or BYOK)
|
|
23230
|
+
mistral: Use Mistral models (catalog provider; generic flat format, BYOK)
|
|
23231
|
+
xai: Use xAI Grok models (catalog provider; generic flat format, BYOK)
|
|
23232
|
+
huggingface: Use Hugging Face inference endpoint models (catalog provider; generic flat format, BYOK)
|
|
23233
|
+
deepseek: Use DeepSeek models (catalog provider; generic flat format, BYOK)
|
|
23234
|
+
cohere: Use Cohere models (catalog provider; generic flat format, BYOK)
|
|
23235
|
+
groq: Use Groq-hosted models (catalog provider; generic flat format, BYOK)
|
|
23236
|
+
together_ai: Use models served by Together AI (catalog provider; generic flat format, BYOK)
|
|
23237
|
+
azure_ai: Use deployments on an Azure AI Foundry / Azure OpenAI resource — `model` is the deployment name (catalog provider; generic flat format, BYOK)
|
|
23238
|
+
fireworks_ai: Use models served by Fireworks AI (catalog provider; generic flat format, BYOK)
|
|
23239
|
+
bedrock: Use AWS Bedrock models through cross-region inference profile ids such as `global.anthropic.claude-sonnet-4-6` (catalog provider; generic flat format, BYOK)
|
|
23240
|
+
nvidia_nim: Use models served by NVIDIA NIM (catalog provider; generic flat format, BYOK)
|
|
23241
|
+
ollama_chat: Use models served by Ollama Cloud (catalog provider; generic flat format, BYOK)
|
|
23242
|
+
vertex_ai: Use Gemini models on Google Vertex AI with the customer's own GCP project (catalog provider; generic flat format, BYOK)
|
|
23243
|
+
description: |-
|
|
23244
|
+
AI provider to use. Built-in providers run on Celigo AI credentials or on a
|
|
23245
|
+
BYOK connection; every other provider is a catalog row that runs only on a BYOK
|
|
23246
|
+
connection. The catalog is data — a provider can be added without a platform
|
|
23247
|
+
release, and `GET /api/aiproviders` lists the rows currently offered.
|
|
23142
23248
|
x-celigo-ai-guidance:
|
|
23143
23249
|
- |-
|
|
23144
23250
|
The provider decides the configuration format, and the server rejects a
|
|
23145
23251
|
mismatch with 422 `invalid_provider_config_format`: `openai` needs the
|
|
23146
23252
|
`openai` block, `gemini` and `anthropic` need the `litellm` block (Gemini- or
|
|
23147
|
-
Claude-specific settings under `litellm._overrides`), and
|
|
23148
|
-
|
|
23149
|
-
|
|
23150
|
-
never an `openai` or `litellm` block.
|
|
23253
|
+
Claude-specific settings under `litellm._overrides`), and every other
|
|
23254
|
+
provider (the catalog providers) needs the generic flat format — `model` and
|
|
23255
|
+
`modelOptions` directly on this object, never an `openai` or `litellm` block.
|
|
23151
23256
|
- |-
|
|
23152
23257
|
Catalog providers are BYOK-only, and the save enforces it through the model
|
|
23153
23258
|
catalog: without a `_connectionId` the guardrail fails to save with 422
|
|
@@ -23156,6 +23261,18 @@ components:
|
|
|
23156
23261
|
configuration.") — the model is a catalog row that is not offered on
|
|
23157
23262
|
platform-managed credentials. Attach an HTTP connection to the vendor's API
|
|
23158
23263
|
(token auth) before saving a catalog-provider guardrail.
|
|
23264
|
+
- |-
|
|
23265
|
+
Without a connection, a provider the catalog does not list is refused at the
|
|
23266
|
+
model check — 422 `ai_model_not_in_catalog` on `guardrail.aiAgent.model` — so the
|
|
23267
|
+
message names the model, not the provider. Check the provider against the
|
|
23268
|
+
catalog before blaming the model.
|
|
23269
|
+
- |-
|
|
23270
|
+
For `azure_ai` and `bedrock` the vendor-specific settings ride the BYOK
|
|
23271
|
+
connection, not this object: an optional connection `baseURI` (the vendor
|
|
23272
|
+
endpoint the connector asks for), and connection settings forwarded to the
|
|
23273
|
+
vendor — Azure's `apiVersion`, Bedrock's `awsRegionName`. `bedrock`
|
|
23274
|
+
authenticates with a Bedrock API key (no IAM role); for `azure_ai`, `model` is
|
|
23275
|
+
the deployment name.
|
|
23159
23276
|
model:
|
|
23160
23277
|
type: string
|
|
23161
23278
|
description: |-
|
|
@@ -24039,6 +24156,13 @@ components:
|
|
|
24039
24156
|
- deepseek
|
|
24040
24157
|
- cohere
|
|
24041
24158
|
- groq
|
|
24159
|
+
- together_ai
|
|
24160
|
+
- azure_ai
|
|
24161
|
+
- fireworks_ai
|
|
24162
|
+
- bedrock
|
|
24163
|
+
- nvidia_nim
|
|
24164
|
+
- ollama_chat
|
|
24165
|
+
- vertex_ai
|
|
24042
24166
|
required:
|
|
24043
24167
|
- provider
|
|
24044
24168
|
then:
|
|
@@ -26166,7 +26290,7 @@ components:
|
|
|
26166
26290
|
MongodbImport: MongoDB database import for document-based operations.
|
|
26167
26291
|
DynamodbImport: Amazon DynamoDB import for NoSQL table operations.
|
|
26168
26292
|
WrapperImport: Custom adaptor import built outside of Celigo (rarely used).
|
|
26169
|
-
AiAgentImport: AI agent import using OpenAI, Gemini, Anthropic Claude, or a BYOK catalog provider (Mistral, xAI, Hugging Face, DeepSeek, Cohere, Groq) for data processing.
|
|
26293
|
+
AiAgentImport: AI agent import using OpenAI, Gemini, Anthropic Claude, or a BYOK catalog provider (Mistral, xAI, Hugging Face, DeepSeek, Cohere, Groq, Together AI, Azure OpenAI, Fireworks AI, AWS Bedrock, NVIDIA NIM, Ollama Cloud, Google Vertex AI) for data processing.
|
|
26170
26294
|
GuardrailImport: Safety and compliance check import for PII detection, moderation, or AI evaluation.
|
|
26171
26295
|
FileSystemImport: Local or network file system import.
|
|
26172
26296
|
ToolImport: Import that executes a reusable Celigo Tool resource.
|
|
@@ -30534,9 +30658,10 @@ components:
|
|
|
30534
30658
|
json:
|
|
30535
30659
|
type: object
|
|
30536
30660
|
description: |-
|
|
30537
|
-
Parsing settings for JSON files. Configure when type is "json". resourcePath
|
|
30538
|
-
|
|
30539
|
-
the
|
|
30661
|
+
Parsing settings for JSON files. Configure when type is "json". resourcePath selects the
|
|
30662
|
+
record elements inside the document — the wildcard form (`*`, `rows[*]`) iterates an
|
|
30663
|
+
array, while a path that stops at the array (or an empty path on a root array) yields
|
|
30664
|
+
the whole array as one record; malformed JSON fails the entire file's processing.
|
|
30540
30665
|
|
|
30541
30666
|
Required when type is json.
|
|
30542
30667
|
x-celigo-ai-guidance:
|
|
@@ -30578,8 +30703,12 @@ components:
|
|
|
30578
30703
|
]
|
|
30579
30704
|
```
|
|
30580
30705
|
- Records are directly at the root as an array
|
|
30581
|
-
-
|
|
30582
|
-
-
|
|
30706
|
+
- Set resourcePath to `*` (or `[*]`) so each element becomes a record
|
|
30707
|
+
- An empty resourcePath returns the entire array as ONE record — a large file then
|
|
30708
|
+
fails with `record_size_exceeded` instead of being split. The export form appends
|
|
30709
|
+
the wildcard itself when the attached sample file is 10 MB or smaller (why a blank
|
|
30710
|
+
path often works in the UI — a larger sample gets no wildcard and the blank path
|
|
30711
|
+
stands); a document sent through the API carries exactly the path it names
|
|
30583
30712
|
|
|
30584
30713
|
### Container Object Pattern
|
|
30585
30714
|
```json
|
|
@@ -30595,7 +30724,8 @@ components:
|
|
|
30595
30724
|
}
|
|
30596
30725
|
```
|
|
30597
30726
|
- Records are in an array inside a container object
|
|
30598
|
-
- Requires resourcePath (e.g., "data")
|
|
30727
|
+
- Requires resourcePath with the element wildcard (e.g., "data[*]" or "data.*");
|
|
30728
|
+
"data" alone selects the array itself and yields it as one record
|
|
30599
30729
|
- Common in API responses with metadata
|
|
30600
30730
|
|
|
30601
30731
|
### Nested Container Pattern
|
|
@@ -30614,13 +30744,20 @@ components:
|
|
|
30614
30744
|
}
|
|
30615
30745
|
```
|
|
30616
30746
|
- Records are deeply nested in the hierarchy
|
|
30617
|
-
- Requires dot notation in
|
|
30747
|
+
- Requires dot notation ending in the element wildcard (e.g., "response.results[*]")
|
|
30618
30748
|
- Common in complex API responses
|
|
30619
30749
|
- |-
|
|
30620
30750
|
## ERROR PREVENTION
|
|
30621
30751
|
|
|
30622
30752
|
- **Invalid Path**: Incorrectly specified resourcePath results in zero records found
|
|
30623
|
-
- **
|
|
30753
|
+
- **Array as one record**: a path that stops at the array (or an empty path on a root
|
|
30754
|
+
array) yields the whole array as a single record; it fails `record_size_exceeded`
|
|
30755
|
+
("The size of a single record should not exceed 26214400 bytes. This may happen
|
|
30756
|
+
because the Resource path is not set correctly") once the file passes 25 MiB — the
|
|
30757
|
+
fix is the element wildcard (`*` / `path[*]`). A preSavePage hook cannot split the
|
|
30758
|
+
record instead: the rejection happens while the file is parsed, before any page of
|
|
30759
|
+
records exists for a hook to receive (an export with such a hook fails identically,
|
|
30760
|
+
with zero pages generated)
|
|
30624
30761
|
- **Empty Results**: If path resolves to null or non-existent field, no error is thrown but no records are processed
|
|
30625
30762
|
- **Parsing Failures**: Malformed JSON will cause the entire file processing to fail
|
|
30626
30763
|
- |-
|
|
@@ -30634,11 +30771,19 @@ components:
|
|
|
30634
30771
|
resourcePath:
|
|
30635
30772
|
type: string
|
|
30636
30773
|
description: |-
|
|
30637
|
-
Dot-notation path
|
|
30638
|
-
|
|
30639
|
-
|
|
30640
|
-
|
|
30641
|
-
|
|
30774
|
+
Dot-notation path that selects the record elements within the JSON document, ending
|
|
30775
|
+
in the element wildcard — `*` when the file's root is the record array,
|
|
30776
|
+
`response.data.customers[*]` (or `.customers.*`) when the array sits under a key. A
|
|
30777
|
+
path that stops at the array — `response.data.customers`, or an empty path on a root
|
|
30778
|
+
array — yields the whole array as a single record, which fails `record_size_exceeded`
|
|
30779
|
+
once it exceeds 26,214,400 bytes. The export form appends the wildcard when the
|
|
30780
|
+
attached sample file is 10 MB or smaller, so a path left blank in the UI often works
|
|
30781
|
+
where the same document sent through the API — or a form with a larger sample — does
|
|
30782
|
+
not. Array indexing and `$`-rooted JSONPath (`$[*]`,
|
|
30783
|
+
`$.rows`) are not supported; a path that resolves to nothing produces zero records
|
|
30784
|
+
without raising an error. This is the file parser's path only — the path to records
|
|
30785
|
+
in an HTTP API response is the separate `http.response.resourcePath`, with its own
|
|
30786
|
+
rules (a bare dot path such as `results.customers` selects the record array there).
|
|
30642
30787
|
x-celigo-ai-guidance:
|
|
30643
30788
|
- |-
|
|
30644
30789
|
Specifies the path to the array of records within the JSON structure.
|
|
@@ -30647,18 +30792,18 @@ components:
|
|
|
30647
30792
|
- |-
|
|
30648
30793
|
## BEHAVIOR
|
|
30649
30794
|
|
|
30650
|
-
- **Purpose**:
|
|
30651
|
-
- **Format**: Dot notation
|
|
30652
|
-
- **When Empty**:
|
|
30653
|
-
- **Result**:
|
|
30795
|
+
- **Purpose**: Selects the elements that become records within the JSON structure
|
|
30796
|
+
- **Format**: Dot notation to navigate nested objects, ending in the element wildcard (e.g., "data.records[*]")
|
|
30797
|
+
- **When Empty**: The whole document is one record — a root object is that one record; a root array is NOT split (use `*` to split it)
|
|
30798
|
+
- **Result**: Each element the wildcard selects is processed as one record; a path that stops at the array yields the array as one record
|
|
30654
30799
|
- |-
|
|
30655
30800
|
## PATH NOTATION GUIDELINES
|
|
30656
30801
|
|
|
30657
30802
|
### Basic Path Patterns
|
|
30658
30803
|
|
|
30659
|
-
- **Root Level Array**:
|
|
30660
|
-
- **Single Level Nesting**:
|
|
30661
|
-
- **Multi-Level Nesting**:
|
|
30804
|
+
- **Root Level Array**: `*` (or `[*]`) when records are a direct array at root
|
|
30805
|
+
- **Single Level Nesting**: The property name plus the wildcard (e.g., "data[*]", "results[*]", "items.*")
|
|
30806
|
+
- **Multi-Level Nesting**: Dot notation plus the wildcard (e.g., "response.data.items[*]")
|
|
30662
30807
|
|
|
30663
30808
|
### Path Construction Rules
|
|
30664
30809
|
|
|
@@ -30667,13 +30812,14 @@ components:
|
|
|
30667
30812
|
- Each segment must be a valid property name in the JSON
|
|
30668
30813
|
|
|
30669
30814
|
2. **Target Requirements**:
|
|
30670
|
-
- The path
|
|
30671
|
-
-
|
|
30672
|
-
-
|
|
30815
|
+
- The parser yields whatever the path selects as the record(s): to get one record per array element, the path MUST end in the element wildcard (`[*]` or `.*`)
|
|
30816
|
+
- A path that stops at the array ("data") selects the array itself and yields ONE record holding every element
|
|
30817
|
+
- A path that selects a single object ("response", "response.data") yields that object as one record — the shape for a file that IS one record
|
|
30818
|
+
- The wildcard iterates whatever it is applied to: on an OBJECT (`*` on a root object, "response.*") it yields one record per member value, not the object — apply it to arrays
|
|
30673
30819
|
|
|
30674
30820
|
3. **Limitations**:
|
|
30675
30821
|
- Array indexing is not supported in the path (e.g., "data[0]")
|
|
30676
|
-
-
|
|
30822
|
+
- `$`-rooted JSONPath is not supported ("$[*]", "$.data[*]" match nothing and yield zero records)
|
|
30677
30823
|
- Regular expressions are not supported
|
|
30678
30824
|
- |-
|
|
30679
30825
|
## DETERMINATION STRATEGY FOR AI AGENTS
|
|
@@ -30689,20 +30835,21 @@ components:
|
|
|
30689
30835
|
|
|
30690
30836
|
| Source Type | Common Paths | Example |
|
|
30691
30837
|
|-------------|--------------|---------|
|
|
30692
|
-
|
|
|
30693
|
-
|
|
|
30694
|
-
|
|
|
30695
|
-
|
|
|
30696
|
-
|
|
|
30838
|
+
| Root array file | "*" | "*" |
|
|
30839
|
+
| REST APIs | "data[*]", "results[*]", "items[*]" | "data[*]" |
|
|
30840
|
+
| Complex APIs | "response.data[*]", "data.items[*]" | "response.data[*]" |
|
|
30841
|
+
| Database Exports | "rows[*]", "records[*]", "exports[*]" | "rows[*]" |
|
|
30842
|
+
| CRM Systems | "contacts[*]", "accounts[*]", "opportunities[*]" | "contacts[*]" |
|
|
30843
|
+
| Analytics APIs | "data.rows[*]", "response.data.rows[*]" | "data.rows[*]" |
|
|
30697
30844
|
|
|
30698
30845
|
3. **Verification Approach**:
|
|
30699
|
-
-
|
|
30700
|
-
- Each element
|
|
30846
|
+
- Preview the export: the parse stage must show one record per array element — a single record that is itself an array means the path stopped at the array
|
|
30847
|
+
- Each element should represent one complete record
|
|
30701
30848
|
- The array should not be a property array (like tags or categories)
|
|
30702
30849
|
- |-
|
|
30703
30850
|
## IMPLEMENTATION EXAMPLES
|
|
30704
30851
|
|
|
30705
|
-
### Root Array
|
|
30852
|
+
### Root Array
|
|
30706
30853
|
|
|
30707
30854
|
JSON Structure:
|
|
30708
30855
|
```json
|
|
@@ -30714,9 +30861,11 @@ components:
|
|
|
30714
30861
|
|
|
30715
30862
|
Configuration:
|
|
30716
30863
|
```json
|
|
30717
|
-
"resourcePath": ""
|
|
30864
|
+
"resourcePath": "*"
|
|
30718
30865
|
```
|
|
30719
30866
|
|
|
30867
|
+
An empty path (or omitting it) returns this array as ONE record rather than two.
|
|
30868
|
+
|
|
30720
30869
|
### Single-Level Nesting
|
|
30721
30870
|
|
|
30722
30871
|
JSON Structure:
|
|
@@ -30732,7 +30881,7 @@ components:
|
|
|
30732
30881
|
|
|
30733
30882
|
Configuration:
|
|
30734
30883
|
```json
|
|
30735
|
-
"resourcePath": "orders"
|
|
30884
|
+
"resourcePath": "orders[*]"
|
|
30736
30885
|
```
|
|
30737
30886
|
|
|
30738
30887
|
### Multi-Level Nesting
|
|
@@ -30754,7 +30903,7 @@ components:
|
|
|
30754
30903
|
|
|
30755
30904
|
Configuration:
|
|
30756
30905
|
```json
|
|
30757
|
-
"resourcePath": "response.data.customers"
|
|
30906
|
+
"resourcePath": "response.data.customers[*]"
|
|
30758
30907
|
```
|
|
30759
30908
|
- |-
|
|
30760
30909
|
## TROUBLESHOOTING INDICATORS
|
|
@@ -30762,6 +30911,8 @@ components:
|
|
|
30762
30911
|
If you encounter these issues, review the resourcePath setting:
|
|
30763
30912
|
|
|
30764
30913
|
- Export completes successfully but processes 0 records
|
|
30914
|
+
- `record_size_exceeded` — "The size of a single record should not exceed 26214400 bytes. This may happen because the Resource path is not set correctly": the path stopped at the array, so the whole file is one record; append the element wildcard (`*` for a root array, `path[*]` for a nested one) — a preSavePage hook cannot help: the record is rejected while the file is parsed, before any page exists for a hook to receive
|
|
30915
|
+
- A preview whose single record is itself an array of the expected objects (same cause, small file)
|
|
30765
30916
|
- "Cannot read property 'forEach' of undefined" errors
|
|
30766
30917
|
- "Expected array but got object/string/number" errors
|
|
30767
30918
|
- Records appear flattened or with unexpected structure
|
|
@@ -30773,10 +30924,11 @@ components:
|
|
|
30773
30924
|
- Document the expected JSON structure alongside the configuration
|
|
30774
30925
|
- For APIs with changing response structures, implement validation checks
|
|
30775
30926
|
examples:
|
|
30776
|
-
-
|
|
30777
|
-
-
|
|
30778
|
-
-
|
|
30779
|
-
-
|
|
30927
|
+
- '*'
|
|
30928
|
+
- data.orders[*]
|
|
30929
|
+
- response.results[*]
|
|
30930
|
+
- items[*]
|
|
30931
|
+
- data.customers.records.*
|
|
30780
30932
|
xlsx:
|
|
30781
30933
|
type: object
|
|
30782
30934
|
description: |-
|
|
@@ -35184,7 +35336,7 @@ components:
|
|
|
35184
35336
|
PathToRecords:
|
|
35185
35337
|
type: string
|
|
35186
35338
|
maxLength: 250
|
|
35187
|
-
description: Path to the array of records inside each document or item fetched from the source; each array element is emitted as an individual record, which keeps records within the 5 MB page-size limit even when the source document exceeds it. Accepts dot notation (e.g. `data.orders`) or JSONPath for values starting with `$`, including unions (`$['orders','invoices'][*]`) and filter expressions (`$.items[?(@.qty>3)]`); a path that resolves to nothing emits zero records for that document or item. When omitted, each document or item is emitted as one record, exactly as before
|
|
35339
|
+
description: Path to the array of records inside each document or item fetched from the source; each array element is emitted as an individual record, which keeps records within the 5 MB page-size limit even when the source document exceeds it. Accepts dot notation (e.g. `data.orders`) or JSONPath for values starting with `$`, including unions (`$['orders','invoices'][*]`) and filter expressions (`$.items[?(@.qty>3)]`); a path that resolves to nothing emits zero records for that document or item. When omitted, each document or item is emitted as one record, exactly as before. HTTP exports configure the same capability through `http.response.resourcePath` with these same path rules; file-based exports configure it through `file.json`/`file.xml` `resourcePath`, where the JSON file parser follows its own rule — the path yields whatever it selects as the record, so it must end in the element wildcard (`*` for a root array, `data.orders[*]` under a key) to emit one record per element, and `$`-rooted JSONPath is not supported there.
|
|
35188
35340
|
examples:
|
|
35189
35341
|
- lineItems
|
|
35190
35342
|
- order.lineItems
|
package/package.json
CHANGED
package/schemas.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"provenance": {
|
|
3
3
|
"repo": "celigo/integrator-api-specs",
|
|
4
|
-
"iasCommit": "
|
|
5
|
-
"generatedAt": "2026-
|
|
4
|
+
"iasCommit": "d89238ad",
|
|
5
|
+
"generatedAt": "2026-11-02"
|
|
6
6
|
},
|
|
7
7
|
"roots": {
|
|
8
8
|
"aiagent": 128,
|
|
@@ -66,13 +66,20 @@
|
|
|
66
66
|
],
|
|
67
67
|
"e": [
|
|
68
68
|
"anthropic",
|
|
69
|
+
"azure_ai",
|
|
70
|
+
"bedrock",
|
|
69
71
|
"cohere",
|
|
70
72
|
"deepseek",
|
|
73
|
+
"fireworks_ai",
|
|
71
74
|
"gemini",
|
|
72
75
|
"groq",
|
|
73
76
|
"huggingface",
|
|
74
77
|
"mistral",
|
|
78
|
+
"nvidia_nim",
|
|
79
|
+
"ollama_chat",
|
|
75
80
|
"openai",
|
|
81
|
+
"together_ai",
|
|
82
|
+
"vertex_ai",
|
|
76
83
|
"xai"
|
|
77
84
|
]
|
|
78
85
|
},
|