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

# SmartConnector APIs

{% hint style="success" %}
**Audience**: Developers, Integrators, Solution architects.

**Purpose**: Introduces the API endpoints and dev package that let you work with <code class="expression">space.vars.smartconnectors</code> outside the <code class="expression">space.vars.Kizen\_company\_name</code> UI.
{% endhint %}

## Overview

<code class="expression">space.vars.smartconnectors</code> can be managed programmatically through a set of <code class="expression">space.vars.Kizen\_company\_name</code> APIs and a downloadable dev package for local execution. Together, these options allow external systems and developer workflows to trigger runs, monitor execution status, cancel executions, and manage <code class="expression">space.vars.smartconnector</code> SQL outside of the <code class="expression">space.vars.Kizen\_company\_name</code> UI.

### How SmartConnectors Are Exposed Programmatically

<code class="expression">space.vars.smartconnectors</code> are available through APIs and supporting developer tools in ways that align with their execution lifecycle:

* File and webhook ingestion endpoints support triggering runs from external systems and pipelines
* Execution status endpoints provide visibility into in-progress and completed runs
* Cancellation endpoints allow orchestration logic to stop a run that should not complete
* The dev package allows a <code class="expression">space.vars.smartconnector</code> to be executed locally for debugging and iteration

All API behavior respects <code class="expression">space.vars.smartconnector</code> configuration, permissions, and execution state, ensuring consistent behavior across the UI, external integrations, and automated pipelines.

### When to Use the APIs

In general:

* Use the APIs when you need to trigger, monitor, or cancel <code class="expression">space.vars.smartconnector</code> runs from external systems or automated workflows
* Use the dev package when you need to reproduce and debug a <code class="expression">space.vars.smartconnector</code> execution locally

***

## API Topics in this Section

* File Upload (Trigger Run) API **(Topic Coming Soon)**
* Webhook Trigger API **(Topic Coming Soon)**
* Execution Status API **(Topic Coming Soon)**
* Cancel Execution API **(Topic Coming Soon)**

{% hint style="info" %}
**Note**: Canceling an execution does not roll back data that has already been processed. Records committed before cancellation remain in their post-execution state. Plan cancellation logic accordingly.
{% endhint %}

### Developer Tools

In addition to the API endpoints above, a developer tool supports <code class="expression">space.vars.smartconnector</code> workflows outside the UI:

* **Dev Package**: A downloadable bundle containing a <code class="expression">space.vars.smartconnector</code>'s SQL script, configuration, and input data for local execution. The package can be downloaded from the UI or via API. If `source_file_id` is specified, the package is pre-loaded with the input file from that execution; if not, the package is pre-loaded with the sample file.

For full setup, usage, and deployment guidance for both tools, see Build with <code class="expression">space.vars.smartconnectors</code> **(Topic Coming Soon).**

***

## What's Next

Review the individual topics in this section to learn how to work with specific <code class="expression">space.vars.smartconnector</code> endpoints and developer tools. Each page includes endpoint details, examples, and usage considerations. The File Upload (Trigger Run) API **(Topic Coming Soon)** is the most commonly used programmatic entry point and is a good starting point for developers new to the <code class="expression">space.vars.smartconnector</code> API surface.


---

# 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:

```
GET https://developer.kizen.com/docs/concepts/smartconnectors/smartconnector-apis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.