docs: recommend Jobs API instead of history/queue endpoints#742
Open
christian-byrne wants to merge 4 commits intomainfrom
Open
docs: recommend Jobs API instead of history/queue endpoints#742christian-byrne wants to merge 4 commits intomainfrom
christian-byrne wants to merge 4 commits intomainfrom
Conversation
- Add Jobs API section with list/get endpoints documentation
- Update complete example to use /api/jobs/{id} instead of /api/history_v2
- Add note about legacy endpoints being maintained for compatibility
- Update both English and Chinese examples
Amp-Thread-ID: https://ampcode.com/threads/T-019c0c6f-94c9-70a9-90c7-dee4048a242d
Co-authored-by: Amp <amp@ampcode.com>
- Add /api/jobs and /api/jobs/{job_id} to routes table with (recommended) label
- Mark /history and /queue GET endpoints as (legacy)
- Add detailed Jobs API section with parameters, response examples
- Update both English and Chinese translations
Amp-Thread-ID: https://ampcode.com/threads/T-019c0c6f-94c9-70a9-90c7-dee4048a242d
Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019c0cd7-4eea-71d7-91d1-6b7288070d65 Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019c0cd7-4eea-71d7-91d1-6b7288070d65 Co-authored-by: Amp <amp@ampcode.com>
Member
|
Is this PR good to merge now? |
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
2 participants
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
Updates cloud API documentation to recommend the Jobs API (
/api/jobs) instead of legacy/history,/history_v2, and/queueendpoints.Changes
GET /api/jobs- List jobs with filtering (status, output_type, workflow_id, sorting, pagination)GET /api/jobs/{job_id}- Get full job details including workflow and outputs/api/jobs/{id}instead of/api/history_v2/{id}Related
Notion ticket: COM-13971