Repository navigation
Add Agents section to API reference - #282
Merged
Merged
Conversation
- Add Agents endpoint groups (custom agents, agent files, agent threads, agent thread files, agent runtime) as the first entry in the API v1 reference layout - Add Agents overview page with verified examples for creating and copying agents, starting threads (incl. project/doc context), sending messages with inline entity mentions and file attachments, status polling, cancelling runs, files, and connectors - Document thread visibility rules for project/task-linked threads and the API key vs OAuth distinction for personal agents - Pull v1 OpenAPI spec from the develop CDN origin and bump Fern to 5.117.0 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
|
🌿 Preview your docs: https://awork-preview-01a09716-ab99-778a-9d54-b3c20d33d4ba.docs.buildwithfern.com |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds a new Agents section to the developer docs, documenting the AI agents API: custom agents, threads, messages, files, and connectors.
Navigation (
fern/docs.yml)New overview page (
fern/pages/api/agents.mdx)POST /agents/{agentId}/copy), updating + system prompt version history, starting threads (personal & custom agent, incl. project/task/doc context), sending messages, adding context to a message (inline entity mentions + file attachments), status polling viaacceptedMessageId, cancelling runs, agent/thread files, and connectors.personal-agentconversations require OAuth as a real user.Spec source
Test plan
fern checkpasses (0 errors).*
POST /agents/{agentId}/copyreturns 404 on production until the corresponding backend change is deployed; the endpoint exists in the develop spec.🤖 Generated with Claude Code