;
};
export const Link = ({href, children, className, ...props}) => {
const localizedHref = href;
return
{children}
;
};
The Box Notes API enables developers to programmatically create Box
Notes from Markdown content. This page outlines common use cases and
provides implementation patterns to help you get started.
## AI-generated note creation
AI assistants and LLM-powered applications often generate output in
Markdown format. The Box Notes API lets you save that output directly
as a collaborative Box Note without any intermediate format handling.
**Example workflow:**
Your AI assistant generates a meeting summary, research brief, or
document draft in Markdown.
Pass the generated Markdown to `POST /2.0/notes/convert` with
the target folder and a descriptive file name.
Use the returned file ID with the
Collaborations API
to share the note with the relevant team, or use the
Shared Links API
to generate a link.
```sh theme={null}
curl -L 'https://api.box.com/2.0/notes/convert' \
-H 'box-version: 2026.0' \
-H 'Authorization: Bearer ' \
-H 'Content-Type: application/json' \
-d '{
"content": "# Meeting Summary — May 2026\n\n## Key Decisions\n\n- Approved Q3 budget\n- Launch date set for August 15\n\n## Action Items\n\n- **Alice**: Finalize vendor contracts by June 1\n- **Bob**: Prepare onboarding materials\n- **Carol**: Schedule stakeholder review",
"content_format": "markdown",
"parent": {
"id": "555555555"
},
"name": "Meeting Summary — May 2026"
}'
```
## Automated report generation
Workflow automation tools can convert system-generated reports into
Box Notes on a schedule. This is useful for dashboards, weekly
digests, and operational summaries that your team needs to review
collaboratively.
**Pattern:** Build a scheduled job (cron, AWS Lambda, Azure Function,
or any automation platform) that:
1. Gathers data from your internal systems.
2. Formats the data as Markdown (tables, lists, headings).
3. Calls the Box Notes API to create a note in a shared team folder.
4. Optionally notifies the team using Slack, email, or another channel
with the Box file link.
## Third-party content import
External applications that store content as Markdown, such as wikis, knowledge
bases, project management tools, or CMS platforms, can import that
content into Box Notes for centralized collaboration and governance.
**Common sources:**
* **Git-based wikis**: Convert repository documentation or
`README.md` files into Box Notes for non-technical stakeholders.
* **Notion or Confluence exports**: Export pages as Markdown and
batch-import them into a Box folder structure.
* **CMS content**: Publish approved content as Box Notes for
review and sign-off workflows.
When importing multiple files, use a unique `name` for each note to
avoid `409 Conflict` errors. Consider appending a timestamp or
identifier to the file name.
## Developer tooling and CLI workflows
Developers can integrate the Box Notes API into scripts, CI/CD
pipelines, or command-line tools to automate note creation as part of
their development workflow.
**Examples:**
* **Post-deployment notes**: After a successful deployment,
automatically create a Box Note with the release changelog.
* **Incident retrospectives**: A script gathers incident timeline
data and creates a structured Box Note for the team to
collaboratively edit.
* **Documentation sync**: Convert local Markdown documentation into
Box Notes to maintain a synchronized copy in Box for broader team
access.
## Combining with other Box APIs
The Box Notes API creates the note. You can combine it with other Box
APIs to build complete workflows:
| Goal | Box API | Details |
| --------------------------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| Share the note with collaborators | Collaborations | Add editors, viewers, or co-owners to the new file. |
| Generate a shared link | Shared Links | Create a public or company-scoped link to the note. |
| Retrieve full file metadata | Get file | Fetch timestamps, owner, size, and other metadata. |
| Apply metadata to the note | Create metadata | Tag the note with custom metadata for search and classification. |
| Move or copy the note | Update file | Move the note to a different folder after creation. |
| Delete the note | Delete file | Remove notes that are no longer needed. |