Internal API
Social posts
5 endpoints.
/api/v1/internal/businesses/{business_id}/social_postsCreate a social post draft (internal)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
Idempotency-Key | header | string | null | |
x-internal-api-key | header | string | null |
Request bodyrequired
application/jsonSocialPostWriteBody| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
content_markdownrequired | string | max length 5000 | |||||||||
link_url | string | null | ||||||||||
photo_ids | string[] | max items 10string[] fields | |||||||||
target_profile_ids | string[] | string[] fields | |||||||||
target_formats | SocialPostTargetFormatBody[] | SocialPostTargetFormatBody[] fields
| |||||||||
publish_mode | enum | one of "draft", "publish_now", "schedule" · default "draft" | |||||||||
scheduled_at | integer | null | ||||||||||
timezone | string | null | ||||||||||
workflow_run_id | string | null | ||||||||||
thread_id | string | null | ||||||||||
media_status | string | null |
Responses
201Successful Responseapplication/jsonSuccessResponse_SocialPostData_| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
success | true | default true | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
datarequired | SocialPostData | SocialPostData fields
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fields
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
meta | ResponseMeta | null | ResponseMeta fields
|
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/internal/businesses/{business_id}/social_posts/{social_post_id}Get a social post (internal)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
social_post_idrequired | path | string (uuid) | |
x-internal-api-key | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_SocialPostData_| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | SocialPostData | SocialPostData fieldsSocialPostData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/internal/businesses/{business_id}/social_posts/{social_post_id}Update a social post draft (internal)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
social_post_idrequired | path | string (uuid) | |
x-internal-api-key | header | string | null |
Request bodyrequired
application/jsonSocialPostWriteBodySocialPostWriteBody, expanded above.
Responses
200Successful Responseapplication/jsonSuccessResponse_SocialPostData_| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | SocialPostData | SocialPostData fieldsSocialPostData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/internal/businesses/{business_id}/social_posts/{social_post_id}/publishPublish a social post immediately (internal)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
social_post_idrequired | path | string (uuid) | |
x-internal-api-key | header | string | null |
Request bodyrequired
application/jsonSocialPostPublishBody| Field | Type | Description |
|---|---|---|
target_profile_ids | string[] | string[] fields |
target_formats | SocialPostTargetFormatBody[] | SocialPostTargetFormatBody[] fieldsSocialPostTargetFormatBody, expanded above. |
Responses
200Successful Responseapplication/jsonSuccessResponse_SocialPostPublishResult_| Field | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | ||||||||||||||||||||||
success | true | default true | |||||||||||||||||||||
datarequired | SocialPostPublishResult | SocialPostPublishResult fields
| |||||||||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | |||||||||||||||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/internal/businesses/{business_id}/social_posts/generateGenerate social post caption (internal)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
Idempotency-Key | header | string | null | |
x-internal-api-key | header | string | null |
Request bodyrequired
application/jsonSocialPostGenerateBody| Field | Type | Description |
|---|---|---|
prompt | string | null | |
target_profile_ids | string[] | string[] fields |
platforms | enum[] | enum[] fields |
provider | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_SocialPostGenerateData_| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | ||||||||||||||||||||||||||||||||||||||||
success | true | default true | |||||||||||||||||||||||||||||||||||||||
datarequired | SocialPostGenerateData | SocialPostGenerateData fields
| |||||||||||||||||||||||||||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | |||||||||||||||||||||||||||||||||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.