consult

Ask the multi-agent Director for editing advice (never writes)

Ask the Director for editing advice on the project's current composition — it NEVER saves; you stay the decider. Async: poll the returned job for the advisory envelope. Modes: 'advise' = the planner agent (fast, ~30s-2min) returns a PLAN (framing/cuts/captions/graphics intents) as guidance you re-author from — no grounded scores; 'amend' = the full author→judge→refine loop (minutes) returns a GRADED assessment + an adoptable fix candidate (adopt via POST /compose/jobs/:jobId/select with its candidateIndex). ('explore' — a ranked slate of directions — is coming soon.)

post/v1/projects/{id}/consult

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/projects/{id}/consult
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.cueframe.ai/api/auth/mcp/authorize, token URL https://api.cueframe.ai/api/auth/mcp/token, scopes: projects:write)
    • API key in header PAYMENT-SIGNATURE

Path parameters

idstring required

Request body

intentstring required

Plain-English goal — what you're trying to achieve with this edit.

mode'advise' | 'amend' | 'explore'

advise = proposer-only (no render/judge, no grounded assessment); amend (default) = grade the current composition + author the fix for the weakest criterion; explore = ranked slate of diverse directions. All modes are async — poll the returned job.

focus'editorial' | 'spatial' | 'brand' | 'caption'

Optional criterion to concentrate the advice on.

ifMatchstring

Etag of the composition the advice is computed against. Proposals are bound to it; apply a proposal BEFORE any other edit or it will 409.

Response

Consult job queued.

consultJobIdstring required

Opaque consult job id; poll it for the advisory result.

projectIdstring required
status'queued' | 'failed' required

queued = normal; failed = startup failed and the job is already terminal.

streamUrlstring

Relative SSE endpoint to stream this job's events.

Changes

No recorded changes to this operation across all 1 revision of this API.