Skip to content

docs: document AI agents REST API access#669

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/fc9678b9
Open

docs: document AI agents REST API access#669
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/fc9678b9

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 19, 2026

Summary

The AI Agent endpoints are now part of the public OpenAPI spec, so they appear in the API reference automatically. This PR adds a short section to the AI agents getting-started guide pointing users to the new endpoints and showing how to authenticate.

Changes

  • Added a "Manage AI agents via the API" section to guides/ai-agents/getting-started.mdx covering:
    • Where the endpoints live (/api/v1/projects/{projectUuid}/aiAgents)
    • Common operations (agents, threads, messages, MCP servers, artifacts)
    • Authentication with a personal access token, including a curl example
    • A note that AI features must be enabled and the user must have project access

Context

Triggered by the upstream change that exposes the AI agent controller in the OpenAPI spec, making these endpoints publicly discoverable in the API reference.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 19, 2026

🤖 Documentation Bot

Status

⚠️ 1 broken link needs manual attention


🔗 Broken Links (Manual Fix Required)

Click to view details
   📄 timezones-draft.mdx

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 19, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lightdash 🟢 Ready View Preview May 19, 2026, 5:11 PM

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 19, 2026

🤖 Documentation Bot

Status

⚠️ 1 broken link needs manual attention


🔗 Broken Links (Manual Fix Required)

Click to view details
   📄 timezones-draft.mdx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants