> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/strapi.md).

# Strapi

Strapi CMS integration. Manage entries across content types, upload media, and control publish state from self-hosted or cloud Strapi instances.

* Knowledge base source

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector        | Authentication   |
| ---------------- | ---------------- |
| Strapi (API Key) | API key or token |

### Strapi (API Key)

Connect to Strapi CMS. Uses admin credentials to auto-discover collection types and API token for data queries.

#### Set up in Strapi

1. Sign in to your Strapi admin panel (self-hosted or Strapi Cloud) as an administrator.
2. Open Settings then, under Global Settings, API Tokens, and create a new API token with the access level your workflow needs (read-only or full access).
3. Copy the API token when it is shown; it is only displayed once.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Strapi (API Key)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field    | Required                 | What to enter                                                                                                                                                                                                                |
| ---------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Base URL         | Yes                      | Your Strapi instance URL (e.g., <https://cms.example.com>).                                                                                                                                                                  |
| API Token        | Yes                      | Your Strapi API token with read access. Used for all data queries.                                                                                                                                                           |
| Admin Email      | Yes                      | Strapi admin user email. Used only to discover available collection types. Not used for data queries.                                                                                                                        |
| Admin Password   | Yes                      | Strapi admin user password. Used only once per session to discover collection types via the Content-Type Builder API. Not used for data queries.                                                                             |
| Admin Login Path | Optional / as applicable | Custom admin login endpoint path if different from default /admin/login. Only change this if your Strapi instance uses a custom admin panel URL.                                                                             |
| Default Filters  | Optional / as applicable | JSON object of Strapi REST API filters applied to every knowledge base query. Keys use Strapi bracket notation, values are strings. Example: {"filters\[fair]\[id]\[$eq]": "123", "filters\[$or]\[0]\[locale]\[$eq]": "en"}. |

**Provider documentation:** [Setup reference](https://docs.strapi.io/user-docs/settings/API-tokens).

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Strapi** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### List Entries

List entries from a Strapi content type with pagination and filters.

#### Inputs

| Field          | Type            | Required | Description                                                                                                                                |
| -------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Content Type   | select (string) | Yes      | Strapi content type plural API ID (e.g. 'articles'). Select from the dropdown or type manually. Options load from the selected connection. |
| Page           | integer         | No       | Page number (1-indexed). Default: 1.                                                                                                       |
| Page Size      | integer         | No       | Entries per page (max 100). Values above the max are clamped. Default: 25.                                                                 |
| Populate       | string          | No       | Strapi populate parameter controlling relation expansion. Default '\*' populates all first-level relations. Default: \*.                   |
| Sort           | string          | No       | Comma-separated sort expressions in Strapi format (field:asc\|desc).                                                                       |
| Status         | string          | No       | Strapi v5 draft/publish filter ('draft' or 'published'). Ignored on Strapi v4.                                                             |
| Filters (JSON) | string          | No       | JSON object of Strapi query-string filters using bracket notation (e.g. {"filters\[title]\[$contains]": "news"}).                          |

#### Outputs

| Field   | Type   | Description                                     |
| ------- | ------ | ----------------------------------------------- |
| Entries | array  | Array of Strapi entries for the requested page. |
| Meta    | object | Strapi metadata block (pagination info, etc.).  |

### Get Entry

Get a single entry by id from a Strapi content type.

#### Inputs

| Field        | Type            | Required | Description                                                                                                                                |
| ------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Content Type | select (string) | Yes      | Strapi content type plural API ID (e.g. 'articles'). Select from the dropdown or type manually. Options load from the selected connection. |
| Entry ID     | string          | Yes      | Entry ID. Accepts the numeric id (Strapi v4) or documentId (Strapi v5).                                                                    |
| Populate     | string          | No       | Strapi populate parameter. Default '\*' populates first-level relations. Default: \*.                                                      |

#### Outputs

| Field | Type   | Description                       |
| ----- | ------ | --------------------------------- |
| Entry | object | Strapi entry returned by the API. |
| Meta  | object | Strapi metadata block.            |

### Create Entry

Create a new entry in a Strapi content type.

#### Inputs

| Field        | Type            | Required | Description                                                                                                                                |
| ------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Content Type | select (string) | Yes      | Strapi content type plural API ID (e.g. 'articles'). Select from the dropdown or type manually. Options load from the selected connection. |
| Fields       | object          | Yes      | Object of field values for the new entry. Wrapped by Strapi as {"data": ...}.                                                              |

#### Outputs

| Field | Type   | Description               |
| ----- | ------ | ------------------------- |
| Entry | object | The created Strapi entry. |
| Meta  | object | Strapi metadata block.    |

### Update Entry

Update an entry in a Strapi content type.

#### Inputs

| Field        | Type            | Required | Description                                                                                                                                |
| ------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Content Type | select (string) | Yes      | Strapi content type plural API ID (e.g. 'articles'). Select from the dropdown or type manually. Options load from the selected connection. |
| Entry ID     | string          | Yes      | Entry ID. Accepts the numeric id (Strapi v4) or documentId (Strapi v5).                                                                    |
| Fields       | object          | Yes      | Object of fields to update on the entry. Only listed fields are changed.                                                                   |

#### Outputs

| Field | Type   | Description               |
| ----- | ------ | ------------------------- |
| Entry | object | The updated Strapi entry. |
| Meta  | object | Strapi metadata block.    |

### Delete Entry

Delete an entry from a Strapi content type.

#### Inputs

| Field        | Type            | Required | Description                                                                                                                                |
| ------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Content Type | select (string) | Yes      | Strapi content type plural API ID (e.g. 'articles'). Select from the dropdown or type manually. Options load from the selected connection. |
| Entry ID     | string          | Yes      | Entry ID. Accepts the numeric id (Strapi v4) or documentId (Strapi v5).                                                                    |

#### Outputs

| Field   | Type    | Description                                                  |
| ------- | ------- | ------------------------------------------------------------ |
| Entry   | object  | The deleted entry body as returned by Strapi (may be empty). |
| Success | boolean | True when Strapi responded successfully.                     |

### Publish Entry

Publish a Strapi entry by setting its publishedAt timestamp.

#### Inputs

| Field        | Type            | Required | Description                                                                                                                                |
| ------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Content Type | select (string) | Yes      | Strapi content type plural API ID (e.g. 'articles'). Select from the dropdown or type manually. Options load from the selected connection. |
| Entry ID     | string          | Yes      | Entry ID. Accepts the numeric id (Strapi v4) or documentId (Strapi v5).                                                                    |

#### Outputs

| Field        | Type    | Description                                                      |
| ------------ | ------- | ---------------------------------------------------------------- |
| Entry        | object  | The published Strapi entry.                                      |
| Is Published | boolean | True when the entry has a non-null publishedAt after the update. |

### Unpublish Entry

Unpublish a Strapi entry by clearing its publishedAt timestamp.

#### Inputs

| Field        | Type            | Required | Description                                                                                                                                |
| ------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Content Type | select (string) | Yes      | Strapi content type plural API ID (e.g. 'articles'). Select from the dropdown or type manually. Options load from the selected connection. |
| Entry ID     | string          | Yes      | Entry ID. Accepts the numeric id (Strapi v4) or documentId (Strapi v5).                                                                    |

#### Outputs

| Field        | Type    | Description                                                      |
| ------------ | ------- | ---------------------------------------------------------------- |
| Entry        | object  | The unpublished Strapi entry.                                    |
| Is Published | boolean | True when the entry has a non-null publishedAt after the update. |

### Upload Media

Upload a media file to the Strapi upload plugin.

#### Inputs

| Field               | Type   | Required | Description                                                                                                                   |
| ------------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
| File Name           | string | Yes      | Name the file will have in the Strapi media library.                                                                          |
| File Content or URL | string | Yes      | Either a public URL to download the file from, or raw text content (converted to PDF/DOCX based on the file\_name extension). |
| Content Type        | string | No       | MIME type override. Defaults to a value detected from the file.                                                               |
| Folder Path         | string | No       | Optional Strapi media folder path (e.g. '/marketing/images').                                                                 |

#### Outputs

| Field        | Type   | Description                                                       |
| ------------ | ------ | ----------------------------------------------------------------- |
| File ID      | number | Strapi media library file id.                                     |
| URL          | string | Path returned by Strapi (may be relative).                        |
| Absolute URL | string | Absolute URL built by prepending the Strapi base URL when needed. |
| MIME Type    | string | MIME type reported by Strapi.                                     |
| Name         | string | Final file name as stored by Strapi.                              |
| Size (bytes) | number | Uploaded file size in bytes.                                      |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/strapi.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
