docs: draft for codegen AI agents #3911
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| - Scale databases to zero when idle (no compute charges when idle; storage is still billed) | ||
|
|
||
| Architecture assumption: This guide uses one Neon project per user for better isolation and security. For detailed architecture patterns and billing models, see the [platform integration getting started guide](/docs/guides/platform-integration-get-started). | ||
|
|
Collaborator
There was a problem hiding this comment.
We need to cover the agent plan & how it works.
- AI Platform signs up for paid account (30K) credit (gets a "paid" Org)
- Neon creates a second "Free" org for the account (for free Neon projects)
Then, we nee to describe how the platform can transfer a project from the Free org to the paid org if the user needs higher usage limits for their app.
"The partner uses the /projects/transfer API to move the project from their Free platform-managed Org to their Paid platform-managed Org when the end user upgrades to paid on the platform."
See: https://docs.google.com/document/d/1640OEFIKYLfWcTXw0-Zkf9kK0FzGnd8uR-VOjS4-_6g/edit?tab=t.0#heading=h.2tmyzq1po7pt
| | Action | Description | Endpoint | | ||
| | ------------------------------------------------------------------ | -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | | ||
| | **[Create project](#application-provisioning)** | Creates a Postgres database in ~500ms with automatic scale-to-zero | `POST /projects` | | ||
| | **[Configure autoscaling](#autoscaling-configuration)** | Set compute limits (0.25-8 CU) based on user tiers | `PATCH /projects/{project_id}/endpoints/{endpoint_id}` | |
Collaborator
There was a problem hiding this comment.
Rather than PATCH apis to modify existing projects, I think we need to document the Create project API where we set limits. We can validate this. I don't thinking patching a project is the primary flow.
philip
force-pushed
the
ai-codegen-info
branch
from
55c62f8 to
09bc15f
Compare
philip
force-pushed
the
ai-codegen-info
branch
from
0c5c41f to
78f3629
Compare
Rough draft for review, do not publish.
philip
force-pushed
the
ai-codegen-info
branch
from
e9f16ea to
1fe7ef1
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces comprehensive documentation for AI agent platforms using Neon, moving from an external use case page to detailed developer-focused documentation within the docs site.
- Replaces external links with internal documentation paths for better integration
- Creates a new comprehensive guide for AI agent platforms with practical API examples
- Updates navigation and icon references to match the new documentation structure
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| content/docs/navigation.yaml | Updates navigation slug from external URL to internal docs path |
| content/docs/ai/ai-agents-tools.md | Updates links and icons to reference new internal documentation |
| content/docs/ai/ai-agents-platform.md | Creates comprehensive new documentation for AI agent platform integration |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| title: Neon API for AI agent platforms | ||
| subtitle: Workflow for provisioning databases, authentication, and versioning for your AI codegen platform. | ||
| enableTableOfContents: true | ||
| updatedOn: '2025-09-10T14:09:12.290Z' |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
Comment on lines
+181
to
+182
| To avoid cold starts on critical endpoints, you can prevent suspension. This keeps compute always on and increases cost. Note: `suspend_timeout_seconds: 0` uses the default timeout; set to `-1` to disable suspension. | ||
|
|
There was a problem hiding this comment.
The explanation about suspend_timeout_seconds values could be clearer. It states that '0' uses default timeout but then shows '-1' to disable suspension, which might be confusing about what the actual default behavior is.
Suggested change
| To avoid cold starts on critical endpoints, you can prevent suspension. This keeps compute always on and increases cost. Note: `suspend_timeout_seconds: 0` uses the default timeout; set to `-1` to disable suspension. | |
| To avoid cold starts on critical endpoints, you can prevent suspension. This keeps compute always on and increases cost. | |
| **Note:** | |
| - Set `"suspend_timeout_seconds": 0` to use the default suspension timeout (currently 300 seconds). | |
| - Set a positive integer (e.g., `600`) to specify a custom timeout in seconds. | |
| - Set `"suspend_timeout_seconds": -1` to disable suspension entirely (compute will always be on). |
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rough draft for review, do not publish.
Preview