> For the complete documentation index, see [llms.txt](https://developer.celigo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.celigo.com/api/api-reference.md).

# API Reference

Every integrator.io REST resource, generated from the OpenAPI specs. Each page lists that resource's endpoints, parameters, schemas, and example requests and responses.

Use the sidebar when you know the resource name. Use the groups below when you are exploring what exists.

New to the API? Start with [Make your first API request](/api/getting-started/getting-started.md) and [Authentication](/api/getting-started/authentication.md). For behavior shared across every resource, see [Pagination](/api/using-the-api/pagination.md), [Sort & filter](/api/using-the-api/sorting-filtering.md), [Rate limits](/api/using-the-api/rate-limits.md), and [Errors & status codes](/api/using-the-api/errors.md).

Need the specs as files, for client generation or request validation? The same OpenAPI documents are on npm as `@celigo/api-specs` — see [OpenAPI specs](/api/using-the-api/openapi-specs.md).

## Build integrations

Assemble and extend the pipelines that move data between systems.

| Resource                                                                      | What it covers                                                                      |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| [Integrations](https://developer.celigo.com/api/api-reference/integrations)   | Containers that group related flows, connections, and settings.                     |
| [Flows](https://developer.celigo.com/api/api-reference/flows)                 | Pipelines that chain exports into imports or routers.                               |
| [Exports](https://developer.celigo.com/api/api-reference/exports)             | The data source step. Reads records from a connection.                              |
| [Imports](https://developer.celigo.com/api/api-reference/imports)             | The data destination step. Writes records with mappings and upsert logic.           |
| [Syncs](https://developer.celigo.com/api/api-reference/syncs)                 | Data ingestion pipelines that replicate a source application into a data warehouse. |
| [Async Helpers](https://developer.celigo.com/api/api-reference/async-helpers) | Polling configurations for long-running export and import operations.               |
| [Scripts](https://developer.celigo.com/api/api-reference/scripts)             | JavaScript hooks that run inside flow execution.                                    |
| [Stacks](https://developer.celigo.com/api/api-reference/stacks)               | Your own server or AWS Lambda runtime for executing extension code.                 |

## Connect to systems

Authenticate to an external application and reach systems behind a firewall.

| Resource                                                                                            | What it covers                                                           |
| --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| [Connections](https://developer.celigo.com/api/api-reference/connections)                           | Credentials and configuration for one external system.                   |
| [iClients](https://developer.celigo.com/api/api-reference/iclients)                                 | Shared OAuth 2.0 client registrations that multiple connections reuse.   |
| [HTTP Connectors](https://developer.celigo.com/api/api-reference/http-connectors)                   | Connector definitions that power HTTP connections, exports, and imports. |
| [HTTP Connector Endpoints](https://developer.celigo.com/api/api-reference/http-connector-endpoints) | The individual endpoint definitions inside an HTTP connector.            |
| [HTTP Connector Resources](https://developer.celigo.com/api/api-reference/http-connector-resources) | The resource definitions that group an HTTP connector's endpoints.       |
| [On Premise Agents](https://developer.celigo.com/api/api-reference/on-premise-agents)               | Secure tunnels that let flows reach systems inside your own network.     |

## Handle files and stored data

Parse file formats, store files, and keep values between runs.

| Resource                                                                                      | What it covers                                                                   |
| --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| [File Definitions](https://developer.celigo.com/api/api-reference/file-definitions)           | Parsing and generation rules for fixed-width, delimited, X12, and EDIFACT files. |
| [Parsers & Generators](https://developer.celigo.com/api/api-reference/parsers-and-generators) | Stateless calls that convert CSV, XML, and EDI text to JSON, and back.           |
| [File Storage](https://developer.celigo.com/api/api-reference/file-storage)                   | Files held in Celigo-hosted storage instead of an external file provider.        |
| [Lookup Caches](https://developer.celigo.com/api/api-reference/lookup-caches)                 | In-memory key-value stores for deduplication and cross-reference lookups.        |
| [State](https://developer.celigo.com/api/api-reference/state)                                 | Durable JSON values keyed by name, account-wide or scoped to one resource.       |

## AI, Tools, and APIs

Add AI steps to a flow, then expose your logic to external callers.

| Resource                                                                                  | What it covers                                                                  |
| ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| [AI Agents](https://developer.celigo.com/api/api-reference/ai-agents)                     | LLM-powered flow steps that classify, extract, validate, or generate data.      |
| [Guardrails](https://developer.celigo.com/api/api-reference/guardrails)                   | Safety checks that flag, reject, or mask records that violate policy.           |
| [Tools](https://developer.celigo.com/api/api-reference/tools)                             | Reusable building blocks callable from flows, APIs, AI agents, and MCP servers. |
| [APIs](https://developer.celigo.com/api/api-reference/apis)                               | Custom HTTP endpoints that external systems call synchronously.                 |
| [APIM](https://developer.celigo.com/api/api-reference/apim)                               | Setup, settings, and analytics for the API management layer.                    |
| [MCP Servers](https://developer.celigo.com/api/api-reference/mcp-servers)                 | Your own MCP endpoints exposing a chosen slice of Tools and APIs.               |
| [MCP OAuth Providers](https://developer.celigo.com/api/api-reference/mcp-oauth-providers) | OAuth registrations that let external MCP clients authenticate.                 |

## B2B and EDI

Onboard trading partners and exchange X12 and EDIFACT documents.

| Resource                                                                                                | What it covers                                                                    |
| ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| [EDI Profiles](https://developer.celigo.com/api/api-reference/edi-profiles)                             | Parsing and enveloping rules for one trading partner's documents.                 |
| [File Definitions](https://developer.celigo.com/api/api-reference/file-definitions)                     | The X12 and EDIFACT parsing and enveloping rules that EDI profiles reference.     |
| [Parsers & Generators](https://developer.celigo.com/api/api-reference/parsers-and-generators)           | Stateless calls that turn X12 and EDIFACT text into JSON, and JSON back into EDI. |
| [EDI Transactions](https://developer.celigo.com/api/api-reference/edi-transactions)                     | The transaction log behind the B2B Manager dashboard.                             |
| [Trading Partner Connectors](https://developer.celigo.com/api/api-reference/trading-partner-connectors) | Prebuilt connection definitions covering EDI, AS2, and VAN transports.            |

## Templates and connectors

Install prebuilt integration content instead of building each flow yourself.

| Resource                                                                  | What it covers                                                                |
| ------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| [Marketplace](https://developer.celigo.com/api/api-reference/marketplace) | The published catalog of templates and Integration Apps.                      |
| [Templates](https://developer.celigo.com/api/api-reference/templates)     | Your own installable template resources, plus preview and install.            |
| [Connectors](https://developer.celigo.com/api/api-reference/connectors)   | Installable Integration Apps, their install base, and per-connector licenses. |

## Monitor and troubleshoot

Inspect runs, trace changes, route alerts, and recover deleted resources.

| Resource                                                                      | What it covers                                                              |
| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| [Jobs](https://developer.celigo.com/api/api-reference/jobs)                   | Flow run history, current runs, produced files, and per-run errors.         |
| [Sync Jobs](https://developer.celigo.com/api/api-reference/sync-jobs)         | The read-only executions a sync produces, with extraction and error counts. |
| [Event Reports](https://developer.celigo.com/api/api-reference/event-reports) | Async exports of integration event data, downloaded through a signed URL.   |
| [Audit Logs](https://developer.celigo.com/api/api-reference/audit-logs)       | Who changed which resource, when, and from where.                           |
| [Notifications](https://developer.celigo.com/api/api-reference/notifications) | Email and webhook alerts for flow, connection, and integration events.      |
| [Tags](https://developer.celigo.com/api/api-reference/tags)                   | Labels that mark flows, errors, and integrations for filtering and triage.  |
| [Recycle Bin](https://developer.celigo.com/api/api-reference/recycle-bin)     | Soft-deleted resources, retained for a limited window before removal.       |

## Users and access

Manage account collaborators and the external end users of your MCP servers.

| Resource                                                              | What it covers                                                           |
| --------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| [Users](https://developer.celigo.com/api/api-reference/users)         | Your team's account collaborators, their access levels, and invitations. |
| [Profile](https://developer.celigo.com/api/api-reference/profile)     | The signed-in user's own profile and preferences.                        |
| [End Users](https://developer.celigo.com/api/api-reference/end-users) | External people who sign in through MCP OAuth to use your MCP servers.   |
| [Groups](https://developer.celigo.com/api/api-reference/groups)       | Bundles of roles and MCP grants applied to every member end user.        |
| [Roles](https://developer.celigo.com/api/api-reference/roles)         | Reusable sets of MCP server grants assigned to groups or end users.      |

## Account and environments

Read account settings, manage environments, and check licensing.

| Resource                                                                                                    | What it covers                                                            |
| ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| [Account](https://developer.celigo.com/api/api-reference/account)                                           | Account details, shared access records, and the current token's identity. |
| [Environments](https://developer.celigo.com/api/api-reference/environments)                                 | Named, isolated spaces that segregate resources by lifecycle stage.       |
| [Subscription & Entitlements](https://developer.celigo.com/api/api-reference/subscription-and-entitlements) | License tier, entitlement usage, and month-over-month trends.             |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.celigo.com/api/api-reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.