---
canonical_url: "https://docs.composio.dev/toolkits/inistate"
markdown_url: "https://docs.composio.dev/toolkits/inistate.md"
product: "platform"
version: null
last_updated: null
---

# Inistate

Inistate is a workspace platform for building workflow and record-management applications, configuring modules, managing entries and activities, auditing changes, and handling files.

- **Category:** app builder
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 12
- **Triggers:** 0
- **Slug:** `INISTATE`
- **Version:** 00000000_00

## Tools

### Bulk Change Entry States

**Slug:** `INISTATE_BULK_CHANGE_ENTRY_STATES`

Request state transitions for 1-100 entries in one module. Inistate processes items sequentially and returns fail-soft per-item results; low confidence may flag and suppress individual transitions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | One to 100 entry state changes. Inistate processes them sequentially and does not roll back successful transitions when another item fails. |
| `ai_model` | string | Yes | Name of the AI model that decided to request these transitions. |
| `ai_sources` | array | No | Optional sources supporting the transition decision. |
| `module_name` | string | Yes | Exact module name containing all entries. |
| `ai_reasoning` | string | Yes | Concise reason for these state transitions. |
| `workspace_id` | string | Yes | Workspace ID returned by INISTATE_LIST_WORKSPACES. |
| `ai_confidence` | number | Yes | Confidence from 0 to 1 applied to every item; low confidence may flag and suppress a transition. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Update Entries

**Slug:** `INISTATE_BULK_UPDATE_ENTRIES`

Update fields on 1-100 entries in one module. Inistate processes items sequentially and returns fail-soft per-item results, so one failure does not roll back or stop the remaining updates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | One to 100 entry updates. Inistate processes them sequentially and does not roll back successful items when another item fails. |
| `ai_model` | string | Yes | Name of the AI model that decided to apply these updates. |
| `ai_sources` | array | No | Optional sources supporting the batch update decision. |
| `module_name` | string | Yes | Exact module name containing all entries. |
| `ai_reasoning` | string | Yes | Concise reason for applying these updates. |
| `workspace_id` | string | Yes | Workspace ID returned by INISTATE_LIST_WORKSPACES. |
| `ai_confidence` | number | Yes | Confidence from 0 to 1 applied to every item in the batch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Entry State

**Slug:** `INISTATE_CHANGE_ENTRY_STATE`

Request a state transition for one module record; low confidence can flag the result and suppress the transition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `state` | string | Yes | Exact target state name from INISTATE_GET_MODULE_SCHEMA. |
| `ai_model` | string | Yes | Name of the AI model that decided to request the transition. |
| `entry_id` | string | Yes | ID of the record whose state should change. |
| `ai_sources` | array | No | Optional traceability sources supporting the transition decision. |
| `module_name` | string | Yes | Exact module name containing the record. |
| `ai_reasoning` | string | Yes | Concise reason the AI is requesting this transition. |
| `workspace_id` | string | Yes | Workspace ID returned by INISTATE_LIST_WORKSPACES; sent as the wsid header. |
| `ai_confidence` | number | Yes | Confidence from 0 to 1; below the activity threshold may suppress the transition and return flagged=true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Entry

**Slug:** `INISTATE_CREATE_ENTRY`

Create one record in a module through its create activity and return whether low confidence caused it to be flagged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | object | Yes | Record values keyed by exact field display names from INISTATE_GET_ACTIVITY_FORM. |
| `ai_model` | string | Yes | Name of the AI model that decided to create the record. |
| `ai_sources` | array | No | Optional traceability sources with a type, reference, or relevant excerpt. |
| `module_name` | string | Yes | Exact module name in which to create the record. |
| `ai_reasoning` | string | Yes | Concise reason the AI is creating this record. |
| `workspace_id` | string | Yes | Workspace ID returned by INISTATE_LIST_WORKSPACES. |
| `ai_confidence` | number | Yes | Confidence from 0 to 1; a value below the form threshold may be flagged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Activity Form

**Slug:** `INISTATE_GET_ACTIVITY_FORM`

Get the required fields, current values, options, defaults, and confidence threshold for a module activity before submitting it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `activity` | string | Yes | Activity name from INISTATE_GET_MODULE_SCHEMA, such as create, edit, view, or a custom activity. |
| `entry_id` | string | No | Existing record ID for entry-specific activities; omit for create. |
| `module_name` | string | Yes | Exact module name containing the activity. |
| `workspace_id` | string | Yes | Workspace ID returned by INISTATE_LIST_WORKSPACES. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Entry

**Slug:** `INISTATE_GET_ENTRY`

Get one module record by ID, including its current values, state, audit metadata, and available activities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entry_id` | string | Yes | Record ID returned by INISTATE_LIST_ENTRIES or a create activity. |
| `module_name` | string | Yes | Exact module name containing the record. |
| `workspace_id` | string | Yes | Workspace ID returned by INISTATE_LIST_WORKSPACES. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Entry History

**Slug:** `INISTATE_GET_ENTRY_HISTORY`

Return one chronological 50-item page of a record's audit trail, comments, field changes, and AI traceability context. Pagination is explicit and zero-based because Inistate does not document a continuation or completion field in the successful response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Zero-based history page to return. Each page contains up to 50 items; increment this value explicitly to request another page. |
| `entry_id` | string | Yes | Record ID whose audit history should be returned. |
| `module_name` | string | Yes | Exact module name containing the record. |
| `workspace_id` | string | Yes | Workspace ID returned by INISTATE_LIST_WORKSPACES; sent as the wsid header. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Module Schema

**Slug:** `INISTATE_GET_MODULE_SCHEMA`

Get a module's fields and states, optionally including its activities and flows, before querying or changing records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `detail` | string ("basic" | "extended") | No | Use basic for fields and states, or extended to also include activities and flows. |
| `module_name` | string | Yes | Exact module name returned by INISTATE_LIST_MODULES. |
| `workspace_id` | string | Yes | Workspace ID returned by INISTATE_LIST_WORKSPACES; sent as the wsid header. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Entries

**Slug:** `INISTATE_LIST_ENTRIES`

Return one page of records from a module using a saved listing, field filters, search, sorting, and field projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `state` | string | No | Return records in this exact module state. |
| `fields` | array | No | Exact field display names to include in each record's data projection. |
| `search` | string | No | Free-text search; supports * and ? wildcards. |
| `filters` | string | No | Filters keyed by exact field display names. Values may be equality values or operator objects using contains, startsWith, endsWith, min, max, above, below, between, after, before, empty, exists, yes, no, is, not, or excludes. Multiple top-level fields are ANDed; use {or: [{...}, {...}]} for alternatives, for example {'Amount': {'min': 10}} or {'or': [{'Status': 'Open'}, {'Status': 'Pending'}]}. |
| `listing` | string | No | Saved listing name, case-insensitive; use archive for archived records. Non-admin users may need an accessible named listing. |
| `sort_by` | string | No | Exact field display name to sort by. |
| `page_size` | integer | No | Maximum records to return in this page (1-500). |
| `module_name` | string | Yes | Exact module name returned by INISTATE_LIST_MODULES. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged. |
| `workspace_id` | string | Yes | Workspace ID returned by INISTATE_LIST_WORKSPACES; sent as the wsid header. |
| `sort_direction` | string ("asc" | "desc") | No | Sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Modules

**Slug:** `INISTATE_LIST_MODULES`

List modules available in a workspace so their exact names can be used in schema and record tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Workspace ID returned by INISTATE_LIST_WORKSPACES. Inistate returns an empty list for a missing or invalid workspace ID, so provide a verified ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspaces

**Slug:** `INISTATE_LIST_WORKSPACES`

List workspaces accessible to the connected API key, optionally filtering by workspace name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Case-insensitive workspace name filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Entry

**Slug:** `INISTATE_UPDATE_ENTRY`

Update fields on one existing module record through its edit activity and return whether low confidence caused it to be flagged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | object | Yes | Fields to update, keyed by exact display names from INISTATE_GET_ACTIVITY_FORM. |
| `ai_model` | string | Yes | Name of the AI model that decided to update the record. |
| `entry_id` | string | Yes | ID of the record to update. |
| `ai_sources` | array | No | Optional sources supporting the update decision. |
| `module_name` | string | Yes | Exact module name containing the record. |
| `ai_reasoning` | string | Yes | Concise reason the AI is updating this record. |
| `workspace_id` | string | Yes | Workspace ID returned by INISTATE_LIST_WORKSPACES. |
| `ai_confidence` | number | Yes | Confidence from 0 to 1; low confidence may flag the result. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |