Recipe Covers

Create a cover candidate from an uploaded image URL

post/api/v1/recipes/{id}/covers

Request

  • Base URL: https://spoonjoy.app
  • URL: https://spoonjoy.app/api/v1/recipes/{id}/covers
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __session
    • OAuth 2 (authorization code, authorization URL https://spoonjoy.app/oauth/authorize, token URL https://spoonjoy.app/oauth/token, scopes: kitchen:write)

Path parameters

idstring required

Spoonjoy resource id from a previous list response.

Headers

X-Request-Idstring

Optional client-generated request id. Spoonjoy echoes it in X-Request-Id and the REST envelope for logs, retries, and support.

Request body

clientMutationIdstring required
imageUrlstring required
activateboolean
generateEditorialboolean
promptAdditionstring nullable

Response

Success

okunknown required
requestIdstring required

Changes

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