docs: clarify available API endpoints and their use cases

[mendonk]

On the API landing page, clarify the available endpoints and what they are used for.
Separate endpoints by use case (application development, codebase contribution, deprecated), and list the endpoints for each group.

Summary by CodeRabbit

• Documentation
  • Added a comprehensive “Available endpoints” catalog covering v1 and v2, consolidating CRUD, import/export, upload/download, streaming (SSE/WebSocket), batch, and trailing-slash variants.
  • Introduced a tabbed UI: Application development, Codebase contribution, and Deprecated, organizing endpoints by domain (e.g., Projects, Files, Users, Auth, Flows, Store, Voice).
  • Provided a dedicated Deprecated tab to contrast legacy endpoints with current surfaces.
  • Standardized bullet formatting in the “Next steps” section.
  • No runtime behavior or public API signatures changed.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Adds an “Available endpoints” catalog with tabbed sections (Application development, Codebase contribution, Deprecated) to the API reference docs, enumerating v1/v2 FastAPI endpoints across multiple domains. Also updates bullet formatting in “Next steps.” No code or public API changes.

Changes

Cohort / File(s)	Summary
API Reference Docs docs/docs/API-Reference/api-reference-api-examples.mdx	Introduces a tabbed, centralized list of available endpoints (v1/v2) across domains; adds Deprecated section; adjusts “Next steps” bullet formatting; documentation-only changes.

Sequence Diagram(s)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–25 minutes

Possibly related PRs

• docs: add examples for users endpoints #8273 — Documentation updates focused on /users endpoints; overlaps with the new “Available endpoints” catalog covering Users.

Suggested labels

size:L

Suggested reviewers

• KimberlyFields
• ogabrielluiz

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs-available-api-endpoints

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

🔭 Outside diff range comments (2)

docs/docs/API-Reference/api-reference-api-examples.mdx (2)

1-4: Frontmatter missing required description field

Docs under api-reference must include at least title and description. Add a concise description for SEO and consistency.

Apply this diff:

 ---
 title: Get started with the Langflow API
+description: Learn how to call Langflow API endpoints, set environment variables, and choose the right endpoint for your use case.
 slug: /api-reference-api-examples
 ---

---

129-134: Fix curl examples, duplicate export, and malformed run URL in docs/docs/API-Reference/api-reference-api-examples.mdx

Verified the file — the examples contain concrete issues; apply the fixes below.

Problems to fix

• docs/docs/API-Reference/api-reference-api-examples.mdx
  • Lines 94 & 98: duplicate export LANGFLOW_API_KEY — remove the duplicate (keep a single export).
  • Line 95: export LANGFLOW_SERVER_URL="https://localhost:7860" — base URL docs use http://localhost:7860; change to http://localhost:7860 for local deployments (or ensure scheme matches actual deployment).
  • Line 102: malformed run URL — "$LANGFLOW_SERVER_URL/api/v1/run/$FLOW_ID$?stream=false" has an extra $ before ? (remove the extra $).
  • Lines 132 and 156 (Get version / Get configuration examples): the -H "accept: application/json" lines are missing trailing backslashes so the following -H is treated as a separate command — add the continuation backslash.

Suggested corrected snippets

Request: Get version

curl -X GET \
  "$LANGFLOW_SERVER_URL/api/v1/version" \
  -H "accept: application/json" \
  -H "x-api-key: $LANGFLOW_API_KEY"

Request: Get configuration

curl -X GET \
  "$LANGFLOW_SERVER_URL/api/v1/config" \
  -H "accept: application/json" \
  -H "x-api-key: $LANGFLOW_API_KEY"

Set environment variables

# Set environment variables
export LANGFLOW_API_KEY="sk-..." 
export LANGFLOW_SERVER_URL="http://localhost:7860"
export FLOW_ID="359cd752-07ea-46f2-9d3b-a4407ef618da"
export PROJECT_ID="1415de42-8f01-4f36-bf34-539f23e47466"

Use environment variables in API requests

curl --request POST \
  --url "$LANGFLOW_SERVER_URL/api/v1/run/$FLOW_ID?stream=false" \
  --header "Content-Type: application/json" \
  --header "x-api-key: $LANGFLOW_API_KEY" \
  --data '{
  "input_value": "hello world!",
  "output_type": "chat",
  "input_type": "chat",
  "tweaks": {
    "ChatOutput-6zcZt": {
      "should_store_message": true
    }
  }
}'

🧹 Nitpick comments (4)

docs/docs/API-Reference/api-reference-api-examples.mdx (4)

237-242: Punctuation and section-heading consistency (“API keys”)

Align with the pattern used elsewhere (“Bold label.” then “See …”).

Apply this diff:

-* **API keys** See [API keys and authentication](/api-keys-and-authentication).
+* **API keys**. See [API keys and authentication](/api-keys-and-authentication).

---

297-302: Punctuation and section-heading consistency (“Auth (login)”)

Match the same style used for “Projects”, “Monitor”, “Build”, etc.

Apply this diff:

-* **Auth (login)** See [API keys and authentication](/api-keys-and-authentication).
+* **Auth (login)**. See [API keys and authentication](/api-keys-and-authentication).

---

367-370: Tighten wording for parallelism and brevity in “Next steps”

Reduce repetition and keep list items concise.

Apply this diff:

-* Use the Langflow API to [run a flow](/api-flows-run).
-* Use the Langflow API to [upload files](/api-files).
-* Use the Langflow API to [get flow logs](/api-logs).
+* [Run a flow](/api-flows-run).
+* [Upload files](/api-files).
+* [Get flow logs](/api-logs).

---

22-23: Typo: “Langfow” → “Langflow”

In the tip admonition, “Langfow API response” should be “Langflow API response”.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9141005 and 5da4398.

📒 Files selected for processing (1)

• docs/docs/API-Reference/api-reference-api-examples.mdx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

docs/docs/**/*.{md,mdx}

📄 CodeRabbit Inference Engine (.cursor/rules/docs_development.mdc)

docs/docs/**/*.{md,mdx}: All documentation content must be written in Markdown or MDX files located under docs/docs/, following the prescribed directory structure for guides, reference, how-to, concepts, and API documentation.
All documentation Markdown and MDX files must begin with a frontmatter block including at least title and description fields.
Use admonitions (:::tip, :::warning, :::danger) in Markdown/MDX files to highlight important information, warnings, or critical issues.
All images referenced in documentation must include descriptive alt text for accessibility.
All code examples included in documentation must be tested and verified to work as shown.
Internal links in documentation must be functional and not broken.
Content must follow the style guide: professional but approachable tone, second person voice, present tense, short paragraphs, sentence case headers, inline code with backticks, bold for UI elements, italic for emphasis, and parallel structure in lists.
Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.

Files:

• docs/docs/API-Reference/api-reference-api-examples.mdx

🧠 Learnings (2)

📓 Common learnings

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Applies to docs/docs/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.

📚 Learning: 2025-07-18T18:26:42.027Z

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Applies to docs/docs/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.

Applied to files:

• docs/docs/API-Reference/api-reference-api-examples.mdx

🪛 LanguageTool

docs/docs/API-Reference/api-reference-api-examples.mdx

[style] ~223-~223: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e}: Stream an image from a flow. * GET /v1/files/profile_pictures/{folder_nam...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~224-~224: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e}: Get a profile picture asset. * GET /v1/files/profile_pictures/list`: List...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~225-~225: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...available profile picture assets. * GET /v1/files/list/{flow_id}: List files ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~277-~277: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...lows/{flow_id}: Read a flow by ID. * GET /v1/flows/public_flow/{flow_id}`: Read...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~328-~328: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ownload a component from the Store. * GET /v1/store/tags: List Store tags. * ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~329-~329: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... /v1/store/tags: List Store tags. * GET /v1/store/users/likes: List component...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~345-~345: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...n that runs a flow and returns TTS. * WS `/v1/voice/ws/flow_tts/{flow_id}/{sessi...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~369-~369: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ow API to upload files. * Use the Langflow API to [get flow logs](/ap...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: build-and-deploy

🔇 Additional comments (1)

docs/docs/API-Reference/api-reference-api-examples.mdx (1)

189-206: Good addition: clear “Available endpoints” framing and top-level guidance

The intro explains the intent and points to the primary run/webhook use cases. The Tabs structure is appropriate for discoverability.

[coderabbitai]

💡 Verification agent

🧩 Analysis chain

Validate internal links referenced from this section

Several cross-links are introduced here. Let’s verify that the target slugs exist and anchors are present to avoid broken links in production docs.

Run this script to check linked slugs and anchors:

---

🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Slugs to verify
SLUGS=(
  "/api-flows-run"
  "/api-flows"
  "/api-files"
  "/api-monitor"
  "/api-build"
  "/api-users"
  "/api-keys-and-authentication"
  "/api-projects"
  "/api-logs"
  "/api"
  "/get-started-quickstart"
  "/environment-variables"
  "/concepts-publish"
)

echo "Verifying slugs exist in frontmatter..."
for s in "${SLUGS[@]}"; do
  if rg -n --glob "docs/docs/**/*.md*" $'^---[\\s\\S]*?slug:\\s*'${s//\//\\/} --no-line-number > /dev/null; then
    echo "OK  slug found: $s"
  else
    echo "MISS slug not found: $s"
  fi
done

# Verify specific anchors used in this file
# /api-projects#read-projects
API_PROJECTS_FILE=$(rg -n --glob "docs/docs/**/*.md*" $'^---[\\s\\S]*?slug:\\s*/api-projects\\s*$' -l | head -n1 || true)
if [[ -n "${API_PROJECTS_FILE:-}" ]]; then
  if rg -n $'^#{1,6}\\s+Read projects' "$API_PROJECTS_FILE" > /dev/null; then
    echo "OK  anchor 'Read projects' exists in /api-projects"
  else
    echo "MISS anchor 'Read projects' not found in /api-projects"
  fi
else
  echo "MISS could not locate file for slug /api-projects"
fi

# Self-referencing links
if rg -n --glob "docs/docs/**/*.md*" $'^---[\\s\\S]*?slug:\\s*/api-reference-api-examples\\s*$' -l > /dev/null; then
  echo "OK  self slug exists: /api-reference-api-examples"
else
  echo "MISS self slug not found: /api-reference-api-examples"
fi

Length of output: 4940

---

🏁 Script executed:

#!/bin/bash
set -euo pipefail

SLUGS=(
  "/api-flows-run"
  "/api-flows"
  "/api-files"
  "/api-monitor"
  "/api-build"
  "/api-users"
  "/api-keys-and-authentication"
  "/api-projects"
  "/api-logs"
  "/api"
  "/get-started-quickstart"
  "/environment-variables"
  "/concepts-publish"
)

echo "Verifying slugs exist in frontmatter..."
for s in "${SLUGS[@]}"; do
  file=$(rg -l --glob 'docs/docs/**/*.{md,mdx}' -e "^slug:\\s*${s}\\s*$" | head -n1 || true)
  if [[ -n "$file" ]]; then
    echo "OK  slug found: $s -> $file"
  else
    echo "MISS slug not found: $s"
  fi
done

# Verify specific anchors used in this file (/api-projects#read-projects)
API_PROJECTS_FILE=$(rg -l --glob 'docs/docs/**/*.{md,mdx}' -e "^slug:\\s*/api-projects\\s*$" | head -n1 || true)
if [[ -n "${API_PROJECTS_FILE:-}" ]]; then
  if rg -n -i -e '^#{1,6}\s+Read projects' "$API_PROJECTS_FILE" > /dev/null; then
    echo "OK  anchor 'Read projects' exists in /api-projects -> $API_PROJECTS_FILE"
  elif rg -n -i -e '^#{1,6}\s+Read project' "$API_PROJECTS_FILE" > /dev/null; then
    echo "OK  anchor 'Read project' exists in /api-projects -> $API_PROJECTS_FILE"
  else
    echo "MISS anchor 'Read projects' not found in /api-projects -> $API_PROJECTS_FILE"
  fi
else
  echo "MISS could not locate file for slug /api-projects"
fi

# Self-referencing link (/api-reference-api-examples)
SELF_FILE=$(rg -l --glob 'docs/docs/**/*.{md,mdx}' -e "^slug:\\s*/api-reference-api-examples\\s*$" | head -n1 || true)
if [[ -n "${SELF_FILE:-}" ]]; then
  echo "OK  self slug exists: /api-reference-api-examples -> $SELF_FILE"
else
  echo "MISS self slug not found: /api-reference-api-examples"
fi

Length of output: 6017

---

Action: Fix missing /api slug referenced from API examples

Verified slugs referenced from docs/docs/API-Reference/api-reference-api-examples.mdx — all targets exist except /api. Anchor check: "Read projects" exists. Self slug exists.

• Resolved (OK):

  • /api-flows-run -> docs/docs/API-Reference/api-flows-run.mdx
  • /api-flows -> docs/docs/API-Reference/api-flows.mdx
  • /api-files -> docs/docs/API-Reference/api-files.mdx
  • /api-monitor -> docs/docs/API-Reference/api-monitor.mdx
  • /api-build -> docs/docs/API-Reference/api-build.mdx
  • /api-users -> docs/docs/API-Reference/api-users.mdx
  • /api-keys-and-authentication -> docs/docs/Configuration/api-keys-and-authentication.mdx
  • /api-projects -> docs/docs/API-Reference/api-projects.mdx (anchor "Read projects" present)
  • /api-logs -> docs/docs/API-Reference/api-logs.mdx
  • /get-started-quickstart -> docs/docs/Get-Started/get-started-quickstart.mdx
  • /environment-variables -> docs/docs/Configuration/environment-variables.mdx
  • /concepts-publish -> docs/docs/Concepts/concepts-publish.mdx
  • /api-reference-api-examples -> docs/docs/API-Reference/api-reference-api-examples.mdx (self slug)

• Missing / action required:

  • /api -> NOT FOUND — update the link(s) in docs/docs/API-Reference/api-reference-api-examples.mdx to a valid slug or add a page with slug /api.

Please address the /api link(s) (or confirm intended target) so the docs won’t contain a broken internal link.

🧰 Tools

🪛 LanguageTool

[style] ~223-~223: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e}: Stream an image from a flow. * GET /v1/files/profile_pictures/{folder_nam...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~224-~224: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e}: Get a profile picture asset. * GET /v1/files/profile_pictures/list`: List...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~225-~225: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...available profile picture assets. * GET /v1/files/list/{flow_id}: List files ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~277-~277: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...lows/{flow_id}: Read a flow by ID. * GET /v1/flows/public_flow/{flow_id}`: Read...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~328-~328: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ownload a component from the Store. * GET /v1/store/tags: List Store tags. * ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~329-~329: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... /v1/store/tags: List Store tags. * GET /v1/store/users/likes: List component...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~345-~345: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...n that runs a flow and returns TTS. * WS `/v1/voice/ws/flow_tts/{flow_id}/{sessi...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🤖 Prompt for AI Agents

In docs/docs/API-Reference/api-reference-api-examples.mdx around lines 200 to
364 there are internal links pointing to the missing slug "/api"; locate every
occurrence of "/api" in this section and either (A) replace each with the
intended existing slug (e.g., a specific API reference page such as
/api-reference-api-examples or another accurate target) or (B) if the intent was
a top-level API landing page, create a new docs page with the slug /api and add
the appropriate anchors; after changes, run the local docs link-checker to
ensure no broken internal links remain.

[coderabbitai]

Actionable comments posted: 1

🔭 Outside diff range comments (5)

docs/docs/API-Reference/api-reference-api-examples.mdx (5)

1-4: Add required frontmatter description

API docs must include at least title and description in the frontmatter. Add a concise description to comply with the docs guideline.

 ---
 title: Get started with the Langflow API
 slug: /api-reference-api-examples
+description: Learn how to call the Langflow API, set environment variables, and see available endpoints grouped by use case.
 ---

---

93-99: Clean up environment variable setup (duplicate key and scheme consistency)

• LANGFLOW_API_KEY is exported twice; keep a single export.
• Prefer http in the quickstart to match the base URL guidance above (localhost typically serves HTTP).

 # Set environment variables
-export LANGFLOW_API_KEY="sk..."
-export LANGFLOW_SERVER_URL="https://localhost:7860"
+export LANGFLOW_SERVER_URL="http://localhost:7860"
 export FLOW_ID="359cd752-07ea-46f2-9d3b-a4407ef618da"
 export PROJECT_ID="1415de42-8f01-4f36-bf34-539f23e47466"
 export LANGFLOW_API_KEY="sk-..."

---

100-105: Fix malformed curl URL (extra “$” before query string)

The extra “$” breaks the request.

 curl --request POST \
-  --url "$LANGFLOW_SERVER_URL/api/v1/run/$FLOW_ID$?stream=false" \
+  --url "$LANGFLOW_SERVER_URL/api/v1/run/$FLOW_ID?stream=false" \
   --header "Content-Type: application/json" \
   --header "x-api-key: $LANGFLOW_API_KEY" \

---

130-134: Add missing line continuation in curl example

Without a trailing backslash at Line 132, the next -H becomes a separate (invalid) shell command.

 curl -X GET \
   "$LANGFLOW_SERVER_URL/api/v1/version" \
-  -H "accept: application/json"
+  -H "accept: application/json" \
   -H "x-api-key: $LANGFLOW_API_KEY"

---

154-158: Add missing line continuation in curl example

Same issue as above; the last header must be part of the same command.

 curl -X GET \
   "$LANGFLOW_SERVER_URL/api/v1/config" \
-  -H "accept: application/json"
+  -H "accept: application/json" \
   -H "x-api-key: $LANGFLOW_API_KEY"

🧹 Nitpick comments (5)

docs/docs/API-Reference/api-reference-api-examples.mdx (5)

22-22: Fix typo: “Langfow” → “Langflow”

Spelling error in the sentence referencing the API response.

-The quickstart demonstrates how to get automatically generated code snippets for your flows, use a script to run a flow, and extract data from the Langfow API response.
+The quickstart demonstrates how to get automatically generated code snippets for your flows, use a script to run a flow, and extract data from the Langflow API response.

---

139-146: Use proper JSON code fence for JSON result

Switch the code block language from text to json for correct highlighting and clarity.

-```text
+```json
 {
     "version": "1.1.1",
     "main_version": "1.1.1",
     "package": "Langflow"
 }

---

`178-186`: **Capitalize “Components” per style guide**

Style guide: always capitalize Component. Update the sentence accordingly.



```diff
-Returns a dictionary of all Langflow components:
+Returns a dictionary of all Langflow Components:

---

237-242: Punctuation fix for section lead-in

Minor grammar for consistency with similar sections.

-* **API keys** See [API keys and authentication](/api-keys-and-authentication).
+* **API keys.** See [API keys and authentication](/api-keys-and-authentication).

---

189-364: Future-proofing: risk of drift vs. OpenAPI spec

Enumerating endpoints is valuable, but it can drift from the live OpenAPI schema. Consider adding a short note at the start of this section reminding readers that the /docs OpenAPI spec is canonical and may be more up to date.

Proposed addition near Line 191:

 Langflow exposes many FastAPI endpoints because the API mirrors everything the platform does, not just running flows.
 
+Note: The OpenAPI specification at your deployment’s /docs endpoint is the canonical source of truth and may change more frequently than this page.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9141005 and 5da4398.

📒 Files selected for processing (1)

• docs/docs/API-Reference/api-reference-api-examples.mdx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

docs/docs/**/*.{md,mdx}

📄 CodeRabbit Inference Engine (.cursor/rules/docs_development.mdc)

docs/docs/**/*.{md,mdx}: All documentation content must be written in Markdown or MDX files located under docs/docs/, following the prescribed directory structure for guides, reference, how-to, concepts, and API documentation.
All documentation Markdown and MDX files must begin with a frontmatter block including at least title and description fields.
Use admonitions (:::tip, :::warning, :::danger) in Markdown/MDX files to highlight important information, warnings, or critical issues.
All images referenced in documentation must include descriptive alt text for accessibility.
All code examples included in documentation must be tested and verified to work as shown.
Internal links in documentation must be functional and not broken.
Content must follow the style guide: professional but approachable tone, second person voice, present tense, short paragraphs, sentence case headers, inline code with backticks, bold for UI elements, italic for emphasis, and parallel structure in lists.
Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.

Files:

• docs/docs/API-Reference/api-reference-api-examples.mdx

🧠 Learnings (1)

📚 Learning: 2025-07-18T18:26:42.027Z

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Applies to docs/docs/api-reference/**/*.{md,mdx} : API documentation pages must follow the provided template, including sections for Endpoint, Request, Response, and Example.

Applied to files:

• docs/docs/API-Reference/api-reference-api-examples.mdx

🪛 LanguageTool

docs/docs/API-Reference/api-reference-api-examples.mdx

[style] ~223-~223: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e}: Stream an image from a flow. * GET /v1/files/profile_pictures/{folder_nam...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~224-~224: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e}: Get a profile picture asset. * GET /v1/files/profile_pictures/list`: List...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~225-~225: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...available profile picture assets. * GET /v1/files/list/{flow_id}: List files ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[grammar] ~237-~237: There might be a mistake here.
Context: ...tication](/api-keys-and-authentication). * GET /v1/api_key/: List API keys for th...

(QB_NEW_EN)

---

[style] ~277-~277: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...lows/{flow_id}: Read a flow by ID. * GET /v1/flows/public_flow/{flow_id}`: Read...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[grammar] ~286-~286: There might be a mistake here.
Context: ... List basic example flows. * Validate * POST /v1/validate/code: Validate a Pyt...

(QB_NEW_EN)

---

[grammar] ~312-~312: There might be a mistake here.
Context: ...cp/project/{project_id}: Post messages to project MCP server. * POST /v1/mcp/p...

(QB_NEW_EN)

---

[grammar] ~312-~312: There might be a mistake here.
Context: ...}: Post messages to project MCP server. * POST /v1/mcp/project/{project_id}/` (tr...

(QB_NEW_EN)

---

[grammar] ~318-~318: There might be a mistake here.
Context: ... config installed. * Starter projects * GET /v1/starter-projects/: Return a li...

(QB_NEW_EN)

---

[grammar] ~321-~321: There might be a mistake here.
Context: ... projects. * Store (Components Store) * GET /v1/store/check/: Return whether t...

(QB_NEW_EN)

---

[grammar] ~322-~322: There might be a mistake here.
Context: ...rn whether the Store feature is enabled. * GET /v1/store/check/api_key: Check if ...

(QB_NEW_EN)

---

[grammar] ~323-~323: There might be a mistake here.
Context: ... if a Store API key exists and is valid. * POST /v1/store/components/: Share a co...

(QB_NEW_EN)

---

[grammar] ~324-~324: There might be a mistake here.
Context: ...nents/: Share a component to the Store. * PATCH /v1/store/components/{component_i...

(QB_NEW_EN)

---

[grammar] ~326-~326: There might be a mistake here.
Context: ...le Store components (filters supported). * GET `/v1/store/components/{component_id}...

(QB_NEW_EN)

---

[grammar] ~327-~327: There might be a mistake here.
Context: ...}: Download a component from the Store. * GET /v1/store/tags`: List Store tags. ...

(QB_NEW_EN)

---

[style] ~328-~328: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ownload a component from the Store. * GET /v1/store/tags: List Store tags. * ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[grammar] ~328-~328: There might be a mistake here.
Context: ...* GET /v1/store/tags: List Store tags. * GET /v1/store/users/likes: List compon...

(QB_NEW_EN)

---

[style] ~329-~329: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... /v1/store/tags: List Store tags. * GET /v1/store/users/likes: List component...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[grammar] ~332-~332: There might be a mistake here.
Context: ...nt_id}: Like a component. * **Validate** * POST /v1/validate/prompt`: Validate a p...

(QB_NEW_EN)

---

[style] ~345-~345: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...n that runs a flow and returns TTS. * WS `/v1/voice/ws/flow_tts/{flow_id}/{sessi...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~369-~369: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ow API to upload files. * Use the Langflow API to [get flow logs](/ap...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🔇 Additional comments (1)

docs/docs/API-Reference/api-reference-api-examples.mdx (1)

189-206: Strong addition: clear endpoint catalog and use-case tabs

The new “Available endpoints” section, structured by application development vs. codebase contribution and deprecated, greatly improves discoverability. Good use of Tabs/TabItem and cross-links to focused pages.

[coderabbitai]

💡 Verification agent

🧩 Analysis chain

Validate all internal links exist to avoid 404s

Given the breadth of links introduced here, please verify that each referenced slug exists in the docs. The script below checks for pages with matching slug frontmatter.

---

🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Slugs referenced in this page
slugs=(
  "/get-started-quickstart"
  "/environment-variables"
  "/api-projects"
  "/api-files"
  "/api-keys-and-authentication"
  "/api-flows-run"
  "/api-flows"
  "/api-build"
  "/api-users"
  "/api-monitor"
  "/api-logs"
  "/api"
)

missing=0
for s in "${slugs[@]}"; do
  # Look for exact slug frontmatter in repo
  if ! rg -n --no-messages "^\s*slug:\s*${s}\s*$" > /dev/null; then
    echo "Missing slug page for: ${s}"
    missing=1
  fi
done

if [ $missing -eq 0 ]; then
  echo "All referenced slugs are present."
else
  echo "Some slugs appear missing. Please confirm redirects or add the pages."
fi

Length of output: 1443

---

Action required — missing doc slug /api referenced in API examples

I ran the slug-check script; all referenced slugs exist except /api.

• Affected file: docs/docs/API-Reference/api-reference-api-examples.mdx (lines 200–364) — referenced slug: /api — no matching frontmatter found in the repo.

Please either:

• Add a page with frontmatter slug: /api, or
• Update the link in the file to the correct existing slug, or
• Add a redirect from /api to the intended page.

🧰 Tools

🪛 LanguageTool

[style] ~223-~223: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e}: Stream an image from a flow. * GET /v1/files/profile_pictures/{folder_nam...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~224-~224: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e}: Get a profile picture asset. * GET /v1/files/profile_pictures/list`: List...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~225-~225: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...available profile picture assets. * GET /v1/files/list/{flow_id}: List files ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[grammar] ~237-~237: There might be a mistake here.
Context: ...tication](/api-keys-and-authentication). * GET /v1/api_key/: List API keys for th...

(QB_NEW_EN)

---

[style] ~277-~277: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...lows/{flow_id}: Read a flow by ID. * GET /v1/flows/public_flow/{flow_id}`: Read...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[grammar] ~286-~286: There might be a mistake here.
Context: ... List basic example flows. * Validate * POST /v1/validate/code: Validate a Pyt...

(QB_NEW_EN)

---

[grammar] ~312-~312: There might be a mistake here.
Context: ...cp/project/{project_id}: Post messages to project MCP server. * POST /v1/mcp/p...

(QB_NEW_EN)

---

[grammar] ~312-~312: There might be a mistake here.
Context: ...}: Post messages to project MCP server. * POST /v1/mcp/project/{project_id}/` (tr...

(QB_NEW_EN)

---

[grammar] ~318-~318: There might be a mistake here.
Context: ... config installed. * Starter projects * GET /v1/starter-projects/: Return a li...

(QB_NEW_EN)

---

[grammar] ~321-~321: There might be a mistake here.
Context: ... projects. * Store (Components Store) * GET /v1/store/check/: Return whether t...

(QB_NEW_EN)

---

[grammar] ~322-~322: There might be a mistake here.
Context: ...rn whether the Store feature is enabled. * GET /v1/store/check/api_key: Check if ...

(QB_NEW_EN)

---

[grammar] ~323-~323: There might be a mistake here.
Context: ... if a Store API key exists and is valid. * POST /v1/store/components/: Share a co...

(QB_NEW_EN)

---

[grammar] ~324-~324: There might be a mistake here.
Context: ...nents/: Share a component to the Store. * PATCH /v1/store/components/{component_i...

(QB_NEW_EN)

---

[grammar] ~326-~326: There might be a mistake here.
Context: ...le Store components (filters supported). * GET `/v1/store/components/{component_id}...

(QB_NEW_EN)

---

[grammar] ~327-~327: There might be a mistake here.
Context: ...}: Download a component from the Store. * GET /v1/store/tags`: List Store tags. ...

(QB_NEW_EN)

---

[style] ~328-~328: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ownload a component from the Store. * GET /v1/store/tags: List Store tags. * ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[grammar] ~328-~328: There might be a mistake here.
Context: ...* GET /v1/store/tags: List Store tags. * GET /v1/store/users/likes: List compon...

(QB_NEW_EN)

---

[style] ~329-~329: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... /v1/store/tags: List Store tags. * GET /v1/store/users/likes: List component...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[grammar] ~332-~332: There might be a mistake here.
Context: ...nt_id}: Like a component. * **Validate** * POST /v1/validate/prompt`: Validate a p...

(QB_NEW_EN)

---

[style] ~345-~345: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...n that runs a flow and returns TTS. * WS `/v1/voice/ws/flow_tts/{flow_id}/{sessi...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🤖 Prompt for AI Agents

In docs/docs/API-Reference/api-reference-api-examples.mdx around lines 200–364,
the file references the slug "/api" which does not exist in the repo; either
create a new docs page that contains frontmatter with slug: /api (add title and
content or a redirect meta), or update the markdown links in this file to point
to the correct existing slug(s) (search for the intended target and replace /api
with that slug), or add a redirect rule from /api to the intended page in your
site config/redirects; locate all occurrences of "/api" in this range, choose
one of the three options, and apply the change so the link resolves.

[aimurphy]

@mendonk please look at my changes to make sure it's all good, and then you can merge if you are ready.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[github-actions]

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft