Skip to content

Sync OpenAI Tasks guide with latest Docs callback-task retrieval flow#280

Closed
Copilot wants to merge 2 commits into
mainfrom
copilot/sync-api-docs-from-platformbackend-8e4d7081-c3ca-4b3d-9baa-afb45853a636
Closed

Sync OpenAI Tasks guide with latest Docs callback-task retrieval flow#280
Copilot wants to merge 2 commits into
mainfrom
copilot/sync-api-docs-from-platformbackend-8e4d7081-c3ca-4b3d-9baa-afb45853a636

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 17, 2026

Upstream Docs updated task retrieval guidance for OpenAI image callbacks, but this repo still documented a trace_id-first polling flow. This PR syncs the OpenAI Tasks integration guide to the current task_id-first model.

  • Scope

    • Updated openai/docs/openai_tasks_api_integration_guide.md only.
    • Kept changes limited to content affected by recent Docs sync.
  • Documentation sync: callback retrieval semantics

    • Clarified that callback-mode submit endpoints return task_id synchronously.
    • Reframed trace_id as optional/correlation-only instead of default retrieval path.
    • Updated id / trace_id field descriptions to match upstream wording.
  • Documentation sync: examples

    • Changed single-task Python example from trace_id lookup to id lookup.
    • Updated end-to-end submit-and-poll example to:
      • remove generated trace_id
      • capture task_id from submit response
      • poll /openai/tasks using {"action":"retrieve","id": task_id}
submit = requests.post(
    f"{API}/openai/images/generations",
    headers=HEADERS,
    json={"model": "gpt-image-1", "prompt": "...", "callback_url": "..."},
).json()

task_id = submit["task_id"]

task = requests.post(
    f"{API}/openai/tasks",
    headers=HEADERS,
    json={"action": "retrieve", "id": task_id},
).json()

Copilot AI changed the title [WIP] Sync API documentation from PlatformBackend updates Sync OpenAI Tasks guide with latest Docs callback-task retrieval flow May 17, 2026
Copilot finished work on behalf of Germey May 17, 2026 07:03
Copilot AI requested a review from Germey May 17, 2026 07:03
@Germey
Copy link
Copy Markdown
Member

Germey commented May 18, 2026

Superseded by new sync trigger; Copilot will open a fresh PR for the latest Docs state.

@Germey Germey closed this May 18, 2026
@Germey Germey deleted the copilot/sync-api-docs-from-platformbackend-8e4d7081-c3ca-4b3d-9baa-afb45853a636 branch May 18, 2026 07:27
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.

sync: update from Docs (40bc865 docs: sync from PlatformBackend (zh-CN base + translations) [automated])

2 participants