> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# createKnowledgeArticle
> Create a Commerce Agent knowledge article. Defaults to DRAFT so it is not retrievable until you set status to ACTIVE.
**Required scopes:** [`commerce_agent_knowledge_write`](/docs/api-reference/v3/reference/scopes#scope-commerce_agent_knowledge_write)
## Arguments
CreateKnowledgeArticleInput!} required>
The details of the article to create.
The article body as authored. May be empty.
DateTime}>
When the article stops being retrievable. Omit or null for no end.
DateTime}>
When the article becomes retrievable if status is ACTIVE. Omit or null for immediately.
Other knowledge articles this article cites.
Product families this article cites.
KnowledgeArticleStatus}>
Retrieval status. Defaults to DRAFT.
The merchant-facing title of the article.
## Returns
KnowledgeArticle!} required>
A Commerce Agent knowledge article the merchant authored or imported. Retrieval eligibility lives on `status` and the effective window, not on the body.
The article body as authored.
DateTime!} required>
When the article was created.
DateTime}>
When the article stops being retrievable. Null means no end.
DateTime}>
When the article becomes retrievable, if `status` is ACTIVE. Null means immediately.
The id of this knowledge article.
KnowledgeArticleOrigin!} required>
How this article was created. Immutable after create.
ProductFamilyConnection!} required>
Product families this article cites.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[ProductFamilyEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
ProductFamily!} required>
The item at this edge.
[ProductFamily!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
Attribute}>
Look up a single attribute on this family by its name, if set.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
The machine name of the attribute to look up.
[Attribute!]!} required>
The merchant-defined attributes set on this family.
DateTime!} required>
When the record was created.
The product family's long-form description.
The id of this product family.
ProductFamilyImage}>
The first (default) image for this family, if any.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
ProductFamilyImageConnection!} required>
A paginated list of the family's images.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
[ProductFamilyOption!]!} required>
The variant options (e.g. Size, Color) for this family.
ProductConnection!} required>
A paginated list of the products (variants) in this family.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
Free-form tags applied to the product family.
The product family's title.
DateTime!} required>
When the record was last updated.
The vendor or manufacturer of the product family.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
KnowledgeArticleConnection!} required>
Other knowledge articles this article cites.
**Requires:** [`commerce_agent_knowledge_read`](/docs/api-reference/v3/reference/scopes#scope-commerce_agent_knowledge_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[KnowledgeArticleEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
KnowledgeArticle!} required>
The item at this edge.
[KnowledgeArticle!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
KnowledgeArticleStatus!} required>
Whether Commerce Agent may retrieve this article. Combine with the effective window.
The merchant-facing title of the article.
DateTime!} required>
When the article body was last edited.
## Example
```graphql theme={null}
mutation {
createKnowledgeArticle(input: { ... }) {
content
createdAt
effectiveEndAt
effectiveStartAt
id
origin
productFamilies {
nodes {
createdAt
description
id
tags
title
updatedAt
vendor
}
pageInfo { hasNextPage endCursor }
}
referencedArticles {
nodes {
content
createdAt
effectiveEndAt
effectiveStartAt
id
origin
status
title
# ...
}
pageInfo { hasNextPage endCursor }
}
# ...
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.