read

Reads the state of one request made to the designer (a composition, a campaign set, an edit, takes, a soundtrack or a ph

Reads the state of one request made to the designer (a composition, a campaign set, an edit, takes, a soundtrack or a photo tool): queued, running, done or failed, the design and version it produced, the designer's reply and any error. For takes that are done, lists each take by index with its title and what it changes; for a campaign set whose plan is done, each concept with its angle, hook and message, and the state and design of the request that designs it. Read-only.

post/api/v1/tools/get_design_request

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/tools/get_design_request
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: creative:read)

Request body

request_idstring required

The request id a composition, campaign set, edit, takes or soundtrack returned.

Response

Tool result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.