Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /typeface-content | Type: Application | PCID required: Yes
typeface_content_discard_feed_item
Delete Feed Item
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
feedId | string | Yes | — | Feed Id |
feedItemId | string | Yes | — | Feed Item Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"projectId": {
"type": "integer",
"description": "Unique identifier for the specific project"
},
"feedId": {
"type": "string",
"description": "Feed Id"
},
"feedItemId": {
"type": "string",
"description": "Feed Item Id"
}
},
"required": [
"PCID",
"accountId",
"projectId",
"feedId",
"feedItemId"
]
}
typeface_content_generate_content
Generate Content
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | string | Yes | — | Unique identifier for the specific project |
requestContext | object | Yes | — | Request Context |
templates | object[] | Yes | — | The templates value |
workflowName | string | No | — | Workflow Name |
workspaceId | string | Yes | — | Workspace Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"projectId": {
"type": "string",
"description": "Unique identifier for the specific project"
},
"requestContext": {
"type": "object",
"description": "Request Context"
},
"templates": {
"type": "array",
"items": {
"type": "object"
},
"description": "The templates value"
},
"workflowName": {
"type": "string",
"description": "Workflow Name"
},
"workspaceId": {
"type": "string",
"description": "Workspace Id"
}
},
"required": [
"PCID",
"accountId",
"projectId",
"requestContext",
"templates",
"workspaceId"
]
}
typeface_content_generate_feed_items_in_feed
Generate On Demand Feed Item
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
feedId | string | Yes | — | Feed Id |
useMock | boolean | No | — | Use Mock |
assetRef | string | No | — | Asset Ref |
audience | string | No | — | The audience value |
channel | string | No | — | The channel value |
featureFlags | object | No | — | Feature Flags |
feedItemProperties | object | No | — | Feed Item Properties |
feedItemType | string | No | — | Feed Item Type |
objective | string | No | — | The objective value |
stepId | string | No | — | Step Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"projectId": {
"type": "integer",
"description": "Unique identifier for the specific project"
},
"feedId": {
"type": "string",
"description": "Feed Id"
},
"useMock": {
"type": "boolean",
"description": "Use Mock"
},
"assetRef": {
"type": "string",
"description": "Asset Ref"
},
"audience": {
"type": "string",
"description": "The audience value"
},
"channel": {
"type": "string",
"description": "The channel value",
"enum": [
"IMAGE",
"EMAIL",
"PUSH_NOTIFICATION",
"TYPEFACE_APP"
]
},
"featureFlags": {
"type": "object",
"description": "Feature Flags"
},
"feedItemProperties": {
"type": "object",
"description": "Feed Item Properties"
},
"feedItemType": {
"type": "string",
"description": "Feed Item Type",
"enum": [
"IMAGE",
"EMAIL",
"EMAIL_SUBJECT_LINE",
"PUSH_NOTIFICATION",
"DOCUMENT"
]
},
"objective": {
"type": "string",
"description": "The objective value"
},
"stepId": {
"type": "string",
"description": "Step Id"
}
},
"required": [
"PCID",
"accountId",
"projectId",
"feedId"
]
}
typeface_content_get_feed_item
Get Feed Item
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
feedId | string | Yes | — | Feed Id |
feedItemId | string | Yes | — | Feed Item Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"projectId": {
"type": "integer",
"description": "Unique identifier for the specific project"
},
"feedId": {
"type": "string",
"description": "Feed Id"
},
"feedItemId": {
"type": "string",
"description": "Feed Item Id"
}
},
"required": [
"PCID",
"accountId",
"projectId",
"feedId",
"feedItemId"
]
}
typeface_content_get_read_only_document
Get Generated Content
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
projectId | integer | Yes | — | Unique identifier for the specific project |
documentId | integer | Yes | — | Document Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "Unique identifier for the specific project"
},
"documentId": {
"type": "integer",
"description": "Document Id"
}
},
"required": [
"PCID",
"projectId",
"documentId"
]
}
typeface_content_patch_feed
Patch Feed
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
feedId | string | Yes | — | Feed Id |
operations | object[] | No | — | The operations value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"projectId": {
"type": "integer",
"description": "Unique identifier for the specific project"
},
"feedId": {
"type": "string",
"description": "Feed Id"
},
"operations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The operations value"
}
},
"required": [
"PCID",
"accountId",
"projectId",
"feedId"
]
}
typeface_content_poll_batch_job_status
Poll Generation Job Status
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | string | Yes | — | Unique identifier for the specific project |
monitorId | string | Yes | — | Monitor Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"projectId": {
"type": "string",
"description": "Unique identifier for the specific project"
},
"monitorId": {
"type": "string",
"description": "Monitor Id"
}
},
"required": [
"PCID",
"accountId",
"projectId",
"monitorId"
]
}
typeface_content_query_feed_items
Query Feed Items
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
feedId | string | Yes | — | Feed Id |
$limit | integer | No | — | The $limit value |
$cursor | string | No | — | The $cursor value |
$filter | string | No | — | The $filter value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"projectId": {
"type": "integer",
"description": "Unique identifier for the specific project"
},
"feedId": {
"type": "string",
"description": "Feed Id"
},
"$limit": {
"type": "integer",
"description": "The $limit value"
},
"$cursor": {
"type": "string",
"description": "The $cursor value"
},
"$filter": {
"type": "string",
"description": "The $filter value"
}
},
"required": [
"PCID",
"accountId",
"projectId",
"feedId"
]
}