Keystone Developers
Open Keystone
API reference

Internal API

Blog workflow engine

3 endpoints.

POST/api/v1/internal/workflow-engine/blog/attach-photos

Attach Blog Photos

Attach photos to an existing draft without rewriting it.

The hero is resolved after the draft is stored, and a PUT would demand title/slug/status and blank whatever it was not told.

Parameters

NameInTypeDescription
Idempotency-Keyrequiredheaderstring
x-internal-api-keyheaderstring | null

Request bodyrequired

application/jsonToolAttachBlogPhotosBody
FieldTypeDescription
businessIdrequiredstring (uuid)
blogPostIdrequiredstring (uuid)
photoIdsstring (uuid)[] | null
string (uuid)[] | null fields
mediaStatusstring | null
workflowRunIdstring | null

Responses

200Successful Response
application/jsonSuccessResponse_dict_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredobject
metadataResponseMetadata | null
ResponseMetadata fields
FieldTypeDescription
paginationPaginationMetadata | null
PaginationMetadata fields
FieldTypeDescription
limitrequiredinteger
next_cursorstring | null
prev_cursorstring | null
has_morerequiredboolean
has_prevbooleandefault false
total_countinteger | null
status_countsobject | null
object | null fields

Map of string to integer

lifecycle_countsLifecycleCounts | null
LifecycleCounts fields
FieldTypeDescription
leadintegerdefault 0
prospectintegerdefault 0
customerintegerdefault 0
former_customerintegerdefault 0
classification_countsClassificationCounts | null
ClassificationCounts fields
FieldTypeDescription
signalobject
object fields

Nested object (not expanded)

touchobject
object fields

Nested object (not expanded)

stageobject
object fields

Nested object (not expanded)

metaResponseMeta | null
ResponseMeta fields
FieldTypeDescription
totalinteger | null
total_countinteger | null
pageinteger | null
per_pageinteger | null
  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/workflow-engine/blog/review-media

Review Blog Media

Vision-review hero photo candidates the worker found in the library.

Parameters

NameInTypeDescription
Idempotency-Keyrequiredheaderstring
x-internal-api-keyheaderstring | null

Request bodyrequired

application/jsonToolReviewBlogMediaBody
FieldTypeDescription
businessIdrequiredstring (uuid)
mediaBriefobject | null
candidatesrequiredobject[]min items 1
object[] fields
workflowRunIdstring | null
rankedbooleandefault false

Responses

200Successful Response
application/jsonSuccessResponse_dict_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredobject
metadataResponseMetadata | null
ResponseMetadata fields

ResponseMetadata, expanded above.

metaResponseMeta | null
ResponseMeta fields

ResponseMeta, expanded above.

  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/workflow-engine/blog/verify-hero

Verify Blog Hero

Check a reframed hero before it is attached to the post.

Parameters

NameInTypeDescription
Idempotency-Keyrequiredheaderstring
x-internal-api-keyheaderstring | null

Request bodyrequired

application/jsonToolVerifyBlogHeroBody
FieldTypeDescription
businessIdrequiredstring (uuid)
mediaBriefobject | null
assetIdrequiredstring (uuid)
intentobject
workflowRunIdstring | null

Responses

200Successful Response
application/jsonSuccessResponse_dict_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredobject
metadataResponseMetadata | null
ResponseMetadata fields

ResponseMetadata, expanded above.

metaResponseMeta | null
ResponseMeta fields

ResponseMeta, expanded above.

  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.