Internal API

Social workflow engine

3 endpoints.

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

Attach Social Photos

Attach photos to an existing draft without rewriting it.

The photos are resolved after the draft is stored, and a PUT would demand the whole form and overwrite whatever it was not told.

Parameters

Name	In	Type	Description
`Idempotency-Key`required	header	`string`
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonToolAttachSocialPhotosBody

Field	Type	Description
`businessId`required	`string (uuid)`
`socialPostId`required	`string (uuid)`
`photoIds`	`string (uuid)[] \| null`	string (uuid)[] \| null fields
`mediaStatus`	`string \| null`
`workflowRunId`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_

Field Type Description

request_idrequired string

success true default true

datarequired object

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| 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/social/review-media

Review Social Media

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

Parameters

Name	In	Type	Description
`Idempotency-Key`required	header	`string`
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonToolReviewSocialMediaBody

Field	Type	Description
`businessId`required	`string (uuid)`
`mediaBrief`	`object \| null`
`candidates`required	`object[]`	min items 1 object[] fields
`workflowRunId`	`string \| null`
`ranked`	`boolean`	default false

Responses

200Successful Response

application/jsonSuccessResponse_dict_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| 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/social/verify-photo

Verify Social Photo

Does this reframed image work in a feed? One image, one verdict.

Parameters

Name	In	Type	Description
`Idempotency-Key`required	header	`string`
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonToolVerifySocialPhotoBody

Field	Type	Description
`businessId`required	`string (uuid)`
`mediaBrief`	`object \| null`
`assetId`required	`string (uuid)`
`intent`	`object \| null`
`workflowRunId`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

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

Error bodies: ErrorResponse. See Errors.