API REFERENCE
List Content Agent Slack Tags (Admin)
On this page
/api/admins/content/slackReturns a list of Slack mentions of the Recoup Content Agent bot, pulled directly from the Slack API as the source of truth. Each entry includes the tagger's information, the prompt they sent, the timestamp, the channel, and any video link responses. Also returns aggregate video statistics for measuring tag-to-video conversion. Supports optional time-period filtering. Requires the authenticated account to be a Recoup admin. Authentication via x-api-key or Authorization Bearer token.
Authentication
x-api-key in header
bearerAuth bearer
Request
curl --request GET \
--url 'https://api.recoupable.dev/api/admins/content/slack' \
--header 'x-api-key: YOUR_API_KEY'Replace the YOUR_ placeholders with your values. Required query parameters are included; optional parameters are listed below.
Parameters
Query parameters
periodstring · enumTime period to filter tags. One of: all (no date filter), daily (last 24 hours), weekly (last 7 days), monthly (last 30 days). Defaults to all.
Values: "all", "daily", "weekly", "monthly"
Default: "all"
Responses
200Slack tag analytics retrieved successfully+
application/json
statusstring · enumrequiredStatus of the request
Values: "success"
totalintegerrequiredTotal number of times the Content Agent was tagged in the requested period
total_videosintegerrequiredTotal number of videos generated by the Content Agent across all tags in the requested period
tags_with_videosintegerrequiredNumber of tags that resulted in at least one video being generated
tagsarray<object>requiredList of Slack tag events
Item properties for tags
user_idstringrequiredSlack ID of the person who tagged the agent
user_namestringrequiredDisplay name of the person who tagged the agent
user_avatarstring | nullURL of the Slack avatar
promptstringrequiredThe text of the message sent to the agent
timestampstringrequiredISO 8601 timestamp of the tag event
format: date-time
channel_idstringrequiredSlack channel ID where the tag occurred
channel_namestringrequiredHuman-readable name of the Slack channel
video_linksarray<string>Video URLs generated by the Content Agent in response to this prompt, parsed from bot replies in the Slack thread
Item properties for video_links
string
401Unauthorized - missing or invalid credentials+
application/json
statusstring · enumrequiredStatus of the request
Values: "error"
messagestringrequiredError message describing what went wrong
403Forbidden - authenticated account is not a Recoup admin+
application/json
statusstring · enumrequiredStatus of the request
Values: "error"
messagestringrequiredError message describing what went wrong
500Internal server error+
application/json
statusstring · enumrequiredStatus of the request
Values: "error"
messagestringrequiredError message describing what went wrong
Full specification
Download the OpenAPI file for complete schemas, constraints, and examples.
Download accounts.jsonView operation source
{
"description": "Returns a list of Slack mentions of the Recoup Content Agent bot, pulled directly from the Slack API as the source of truth. Each entry includes the tagger's information, the prompt they sent, the timestamp, the channel, and any video link responses. Also returns aggregate video statistics for measuring tag-to-video conversion. Supports optional time-period filtering. Requires the authenticated account to be a Recoup admin. Authentication via x-api-key or Authorization Bearer token.",
"parameters": [
{
"name": "period",
"in": "query",
"description": "Time period to filter tags. One of: all (no date filter), daily (last 24 hours), weekly (last 7 days), monthly (last 30 days). Defaults to all.",
"required": false,
"schema": {
"type": "string",
"enum": [
"all",
"daily",
"weekly",
"monthly"
],
"default": "all"
}
}
],
"security": [
{
"apiKeyAuth": []
},
{
"bearerAuth": []
}
],
"responses": {
"200": {
"description": "Slack tag analytics retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"status",
"total",
"total_videos",
"tags_with_videos",
"tags"
],
"properties": {
"status": {
"type": "string",
"enum": [
"success"
],
"description": "Status of the request"
},
"total": {
"type": "integer",
"description": "Total number of times the Content Agent was tagged in the requested period",
"example": 18
},
"total_videos": {
"type": "integer",
"description": "Total number of videos generated by the Content Agent across all tags in the requested period",
"example": 12
},
"tags_with_videos": {
"type": "integer",
"description": "Number of tags that resulted in at least one video being generated",
"example": 10
},
"tags": {
"type": "array",
"description": "List of Slack tag events",
"items": {
"type": "object",
"required": [
"user_id",
"user_name",
"prompt",
"timestamp",
"channel_id",
"channel_name"
],
"properties": {
"user_id": {
"type": "string",
"description": "Slack ID of the person who tagged the agent",
"example": "U012AB3CD"
},
"user_name": {
"type": "string",
"description": "Display name of the person who tagged the agent",
"example": "Jane Smith"
},
"user_avatar": {
"type": [
"string",
"null"
],
"description": "URL of the Slack avatar",
"example": "https://avatars.slack-edge.com/..."
},
"prompt": {
"type": "string",
"description": "The text of the message sent to the agent",
"example": "create a highlight reel for the new single release"
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp of the tag event",
"example": "2024-01-15T10:30:00.000Z"
},
"channel_id": {
"type": "string",
"description": "Slack channel ID where the tag occurred",
"example": "C012AB3CD"
},
"channel_name": {
"type": "string",
"description": "Human-readable name of the Slack channel",
"example": "content-team"
},
"video_links": {
"type": "array",
"description": "Video URLs generated by the Content Agent in response to this prompt, parsed from bot replies in the Slack thread",
"items": {
"type": "string",
"format": "uri",
"example": "https://recoupable.com/v/abc123"
},
"example": [
"https://recoupable.com/v/abc123"
]
}
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized - missing or invalid credentials",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - authenticated account is not a Recoup admin",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountErrorResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountErrorResponse"
}
}
}
}
}
}