MCP tool reference
Inspect every Console MCP tool, delegated authority rule, required input, and generated input and output schema.
On this page
This reference mirrors the current public MCP catalog. Clients should load the live server's tool list when connecting and use this page for review, indexing, and agent-readable schema detail.
Authority and connection
https://api.entirefeed.com/mcp/efmcp_live_...generations:readDiscover and inspect generationCurrent delegated user capability.playground:runEstimate, create, or retry generationCurrent delegated user capability.workflows:runPrepare a local media uploadCurrent delegated user capability.generations:cancelCancel generationCurrent delegated user capability.workflows:read, workflows:manage, workflows:runRead, edit, or run workflowsCurrent delegated user capability.publishing:read, publishing:manageRead or edit publishing draftsCurrent delegated user capability.publishing:scheduleSchedule, reschedule, or cancelCurrent delegated user capability.publishing:analytics:readRead publishing analyticsCurrent delegated user capability.Generated tool contracts
Guidanceget_console_agent_best_practicesNo required input
Return concise, topic-specific best-practice guidance for Console agents. Use when the agent needs output-quality, workflow-construction, format-analysis, prompting, asset, or publishing-quality, or billing guidance. Topics: workflow_construction, prompting, reference_video_analysis, workflow_validation, billing, video_generation, output_review, assets_personas_voices, publishing_approval, anti_overfitting.
{
"properties": {
"topic": {
"default": "workflow_construction",
"title": "Topic",
"type": "string"
}
},
"title": "get_console_agent_best_practicesArguments",
"type": "object"
}Media uploadsprepare_console_media_uploadfilename, content_type, size_bytes
Prepare a short-lived, one-time multipart upload for a local image, video, or audio file. Send the raw file bytes directly to the returned URL using its method, headers, and form field; do not encode the file as base64. The upload response URL can be used in generation and workflow inputs.
{
"properties": {
"content_type": {
"maxLength": 100,
"minLength": 1,
"title": "Content Type",
"type": "string"
},
"filename": {
"maxLength": 255,
"minLength": 1,
"title": "Filename",
"type": "string"
},
"sha256": {
"anyOf": [
{
"maxLength": 64,
"minLength": 64,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sha256"
},
"size_bytes": {
"exclusiveMinimum": 0,
"title": "Size Bytes",
"type": "integer"
}
},
"required": [
"filename",
"content_type",
"size_bytes"
],
"title": "prepare_console_media_uploadArguments",
"type": "object"
}Generationcancel_console_generationgeneration_id
Cancel one queued or running generation by gen_... id.
{
"properties": {
"generation_id": {
"title": "Generation Id",
"type": "string"
}
},
"required": [
"generation_id"
],
"title": "cancel_console_generationArguments",
"type": "object"
}Generationcreate_console_generationtask, input, idempotency_key
Create one generation. Supply a stable caller-generated idempotency key to deduplicate retries. Model-less tasks must omit model.
{
"properties": {
"idempotency_key": {
"maxLength": 255,
"minLength": 1,
"title": "Idempotency Key",
"type": "string"
},
"input": {
"additionalProperties": true,
"title": "Input",
"type": "object"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"model": {
"default": null,
"title": "Model",
"type": "string"
},
"task": {
"title": "Task",
"type": "string"
}
},
"required": [
"task",
"input",
"idempotency_key"
],
"title": "create_console_generationArguments",
"type": "object"
}Generationestimate_console_generationtask, input
Estimate one generation request without creating it. Model-less tasks must omit model.
{
"properties": {
"input": {
"additionalProperties": true,
"title": "Input",
"type": "object"
},
"model": {
"default": null,
"title": "Model",
"type": "string"
},
"task": {
"title": "Task",
"type": "string"
}
},
"required": [
"task",
"input"
],
"title": "estimate_console_generationArguments",
"type": "object"
}Generationget_console_generationgeneration_id
Get one generation with its output, usage, error, and metadata.
{
"properties": {
"generation_id": {
"title": "Generation Id",
"type": "string"
}
},
"required": [
"generation_id"
],
"title": "get_console_generationArguments",
"type": "object"
}Generationget_console_generation_tasktask_id
Get one generation task with its available models, schemas, defaults, and output schema.
{
"properties": {
"task_id": {
"title": "Task Id",
"type": "string"
}
},
"required": [
"task_id"
],
"title": "get_console_generation_taskArguments",
"type": "object"
}Generationlist_console_generation_modelsNo required input
List generation models as compact summaries. Schemas and defaults are intentionally omitted; inspect the relevant task with get_console_generation_task.
{
"properties": {},
"title": "list_console_generation_modelsArguments",
"type": "object"
}Generationlist_console_generation_tasksNo required input
List generation tasks as compact summaries, including available and coming-soon tasks. Call get_console_generation_task for schemas and defaults.
{
"properties": {},
"title": "list_console_generation_tasksArguments",
"type": "object"
}Generationlist_console_generationsNo required input
List generations as compact summaries without API-key or input details.
{
"properties": {
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cursor"
},
"limit": {
"default": 50,
"title": "Limit",
"type": "integer"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"task": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Task"
}
},
"title": "list_console_generationsArguments",
"type": "object"
}Generationretry_console_generationgeneration_id, idempotency_key
Retry a failed or cancelled generation as a new billed request. Requires a caller-supplied idempotency key.
{
"properties": {
"generation_id": {
"title": "Generation Id",
"type": "string"
},
"idempotency_key": {
"maxLength": 255,
"minLength": 1,
"title": "Idempotency Key",
"type": "string"
}
},
"required": [
"generation_id",
"idempotency_key"
],
"title": "retry_console_generationArguments",
"type": "object"
}Workflowscancel_console_workflow_runrun_id
Cancel an active Console workflow run.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reason"
},
"run_id": {
"title": "Run Id",
"type": "string"
},
"run_tab_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Tab Id"
}
},
"required": [
"run_id"
],
"title": "cancel_console_workflow_runArguments",
"type": "object"
}Workflowscancel_public_workflow_runworkflow_run_id
Cancel a queued or active public workflow starter run by wrun_... id.
{
"properties": {
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reason"
},
"workflow_run_id": {
"title": "Workflow Run Id",
"type": "string"
}
},
"required": [
"workflow_run_id"
],
"title": "cancel_public_workflow_runArguments",
"type": "object"
}Workflowscreate_console_workflowname, definition
Create a Console workflow from a full workflow definition.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"definition": {
"additionalProperties": true,
"title": "Definition",
"type": "object"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"definition"
],
"title": "create_console_workflowArguments",
"type": "object"
}Workflowscreate_console_workflow_from_starterstarter_slug
Create a Console workflow from a supported workflow starter template.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"starter_slug": {
"title": "Starter Slug",
"type": "string"
}
},
"required": [
"starter_slug"
],
"title": "create_console_workflow_from_starterArguments",
"type": "object"
}Workflowsdelete_console_workflowworkflow_id
Soft-delete a Console workflow from active workflow lists.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"workflow_id": {
"title": "Workflow Id",
"type": "string"
}
},
"required": [
"workflow_id"
],
"title": "delete_console_workflowArguments",
"type": "object"
}Workflowsestimate_console_workflow_runworkflow_id
Estimate a Console workflow run and return cost plus estimate_version for run_console_workflow.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"definition_override": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Definition Override"
},
"expected_definition_hash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Expected Definition Hash"
},
"inputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Inputs"
},
"source_execution_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source Execution Id"
},
"target_node_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target Node Id"
},
"workflow_id": {
"title": "Workflow Id",
"type": "string"
}
},
"required": [
"workflow_id"
],
"title": "estimate_console_workflow_runArguments",
"type": "object"
}Workflowsestimate_public_workflow_starter_runstarter_slug
Estimate a public workflow starter run and return estimate_version for run_public_workflow_starter.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"inputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Inputs"
},
"starter_slug": {
"title": "Starter Slug",
"type": "string"
},
"starter_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Starter Version"
}
},
"required": [
"starter_slug"
],
"title": "estimate_public_workflow_starter_runArguments",
"type": "object"
}Workflowsget_console_workflowworkflow_id
Get one Console workflow including its full definition and revision hashes. Use definition_hash as expected_definition_hash for edits and runs.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"workflow_id": {
"title": "Workflow Id",
"type": "string"
}
},
"required": [
"workflow_id"
],
"title": "get_console_workflowArguments",
"type": "object"
}Workflowsget_console_workflow_node_schemanode_type
Fetch the full schema for one workflow node type.
{
"properties": {
"node_type": {
"title": "Node Type",
"type": "string"
}
},
"required": [
"node_type"
],
"title": "get_console_workflow_node_schemaArguments",
"type": "object"
}Workflowsget_console_workflow_runrun_id
Get one Console workflow run with compact jobs, outputs, and error information.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"include": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "jobs",
"title": "Include"
},
"run_id": {
"title": "Run Id",
"type": "string"
}
},
"required": [
"run_id"
],
"title": "get_console_workflow_runArguments",
"type": "object"
}Workflowsget_public_workflow_runworkflow_run_id
Get one public workflow starter run by wrun_... id.
{
"properties": {
"workflow_run_id": {
"title": "Workflow Run Id",
"type": "string"
}
},
"required": [
"workflow_run_id"
],
"title": "get_public_workflow_runArguments",
"type": "object"
}Workflowsget_public_workflow_starterstarter_slug
Get one public workflow starter with its public input/output schemas and example payloads.
{
"properties": {
"starter_slug": {
"title": "Starter Slug",
"type": "string"
}
},
"required": [
"starter_slug"
],
"title": "get_public_workflow_starterArguments",
"type": "object"
}Workflowslist_active_console_workflow_runsworkflow_id
List active Console workflow runs with compact status details.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"include": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Include"
},
"workflow_id": {
"title": "Workflow Id",
"type": "string"
}
},
"required": [
"workflow_id"
],
"title": "list_active_console_workflow_runsArguments",
"type": "object"
}Workflowslist_console_workflow_nodesNo required input
List workflow node types as compact summaries. Use get_console_workflow_node_schema for one full schema.
{
"properties": {
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Category"
},
"limit": {
"default": 80,
"title": "Limit",
"type": "integer"
}
},
"title": "list_console_workflow_nodesArguments",
"type": "object"
}Workflowslist_console_workflow_runsworkflow_id
List compact historical runs for a Console workflow.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"limit": {
"default": 10,
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"title": "Offset",
"type": "integer"
},
"workflow_id": {
"title": "Workflow Id",
"type": "string"
}
},
"required": [
"workflow_id"
],
"title": "list_console_workflow_runsArguments",
"type": "object"
}Workflowslist_console_workflow_startersNo required input
List Console workflow starters that can create starter workflows.
{
"properties": {},
"title": "list_console_workflow_startersArguments",
"type": "object"
}Workflowslist_console_workflowsNo required input
List Console workflows as compact summaries. Does not return workflow definitions. Use get_console_workflow when you need the full graph and definition_hash.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"limit": {
"default": 50,
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"title": "Offset",
"type": "integer"
},
"search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Search"
}
},
"title": "list_console_workflowsArguments",
"type": "object"
}Workflowslist_public_workflow_runsNo required input
List public workflow starter runs with optional status and starter filters.
{
"properties": {
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cursor"
},
"limit": {
"default": 50,
"title": "Limit",
"type": "integer"
},
"starter_slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Starter Slug"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"title": "list_public_workflow_runsArguments",
"type": "object"
}Workflowslist_public_workflow_startersNo required input
List public workflow starters that can be estimated and run without exposing the workflow builder.
{
"properties": {},
"title": "list_public_workflow_startersArguments",
"type": "object"
}Workflowspin_console_workflow_nodeworkflow_id, node_id, source_execution_id, expected_definition_hash
Pin a Console workflow node from an existing completed workflow run/job. Only use when the user explicitly asks to pin or reuse a node output; pinning mutates workflow state and changes workflow hashes. source_execution_id must be the workflow run id returned by get_console_workflow_run, not the operation_id returned by run_console_workflow. Requires the current definition_hash as expected_definition_hash.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"expected_definition_hash": {
"title": "Expected Definition Hash",
"type": "string"
},
"node_id": {
"title": "Node Id",
"type": "string"
},
"source_execution_id": {
"title": "Source Execution Id",
"type": "string"
},
"source_job_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Source Job Ids"
},
"upstream_hash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Upstream Hash"
},
"workflow_id": {
"title": "Workflow Id",
"type": "string"
}
},
"required": [
"workflow_id",
"node_id",
"source_execution_id",
"expected_definition_hash"
],
"title": "pin_console_workflow_nodeArguments",
"type": "object"
}Workflowsretry_console_workflow_runrun_id, idempotency_key
Retry a failed or cancelled Console workflow run. Requires an idempotency_key.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"idempotency_key": {
"title": "Idempotency Key",
"type": "string"
},
"run_id": {
"title": "Run Id",
"type": "string"
}
},
"required": [
"run_id",
"idempotency_key"
],
"title": "retry_console_workflow_runArguments",
"type": "object"
}Workflowsretry_public_workflow_runworkflow_run_id, idempotency_key
Retry a failed or cancelled public workflow starter run. Requires an idempotency_key.
{
"properties": {
"idempotency_key": {
"title": "Idempotency Key",
"type": "string"
},
"workflow_run_id": {
"title": "Workflow Run Id",
"type": "string"
}
},
"required": [
"workflow_run_id",
"idempotency_key"
],
"title": "retry_public_workflow_runArguments",
"type": "object"
}Workflowsrun_console_workflowworkflow_id, estimate_version, expected_definition_hash, idempotency_key
Run a Console workflow after estimating it. Requires an idempotency_key for billable safety.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"definition_override": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Definition Override"
},
"estimate_version": {
"title": "Estimate Version",
"type": "string"
},
"expected_definition_hash": {
"title": "Expected Definition Hash",
"type": "string"
},
"idempotency_key": {
"title": "Idempotency Key",
"type": "string"
},
"inputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Inputs"
},
"source_execution_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source Execution Id"
},
"target_node_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target Node Id"
},
"workflow_id": {
"title": "Workflow Id",
"type": "string"
}
},
"required": [
"workflow_id",
"estimate_version",
"expected_definition_hash",
"idempotency_key"
],
"title": "run_console_workflowArguments",
"type": "object"
}Workflowsrun_public_workflow_starterstarter_slug, estimate_version, idempotency_key
Run a public workflow starter after estimating it. Requires an idempotency_key for billable safety.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"estimate_version": {
"title": "Estimate Version",
"type": "string"
},
"idempotency_key": {
"title": "Idempotency Key",
"type": "string"
},
"inputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Inputs"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"starter_slug": {
"title": "Starter Slug",
"type": "string"
},
"starter_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Starter Version"
}
},
"required": [
"starter_slug",
"estimate_version",
"idempotency_key"
],
"title": "run_public_workflow_starterArguments",
"type": "object"
}Workflowssearch_console_workflow_nodesquery
Search workflow node types by node type, label, description, category, inputs, and outputs.
{
"properties": {
"limit": {
"default": 20,
"title": "Limit",
"type": "integer"
},
"query": {
"title": "Query",
"type": "string"
}
},
"required": [
"query"
],
"title": "search_console_workflow_nodesArguments",
"type": "object"
}Workflowsunpin_console_workflow_nodeworkflow_id, node_id, expected_definition_hash
Unpin a Console workflow node, restoring normal execution for that node. Requires the current definition_hash as expected_definition_hash.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"expected_definition_hash": {
"title": "Expected Definition Hash",
"type": "string"
},
"node_id": {
"title": "Node Id",
"type": "string"
},
"workflow_id": {
"title": "Workflow Id",
"type": "string"
}
},
"required": [
"workflow_id",
"node_id",
"expected_definition_hash"
],
"title": "unpin_console_workflow_nodeArguments",
"type": "object"
}Workflowsupdate_console_workflow_definitionworkflow_id, definition, expected_definition_hash
Replace a Console workflow definition. expected_definition_hash must be the definition_hash returned by get_console_workflow or the previous write result.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"definition": {
"additionalProperties": true,
"title": "Definition",
"type": "object"
},
"expected_definition_hash": {
"title": "Expected Definition Hash",
"type": "string"
},
"workflow_id": {
"title": "Workflow Id",
"type": "string"
}
},
"required": [
"workflow_id",
"definition",
"expected_definition_hash"
],
"title": "update_console_workflow_definitionArguments",
"type": "object"
}Workflowsupdate_console_workflow_metadataworkflow_id
Update Console workflow metadata without changing the graph definition.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"expected_definition_hash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Expected Definition Hash"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Active"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"workflow_id": {
"title": "Workflow Id",
"type": "string"
}
},
"required": [
"workflow_id"
],
"title": "update_console_workflow_metadataArguments",
"type": "object"
}Publishingcancel_console_publishing_scheduled_postscheduled_post_id
Cancel an existing scheduled publishing action by explicit scheduled_post_id. This does not delete the draft post. PENDING, QUEUED, CLAIMED, and FAILED scheduled actions can be cancelled.
{
"properties": {
"scheduled_post_id": {
"title": "Scheduled Post Id",
"type": "string"
}
},
"required": [
"scheduled_post_id"
],
"title": "cancel_console_publishing_scheduled_postArguments",
"type": "object"
}Publishingcreate_console_publishing_postaccount_id, platform, content_type, media_urls
Create a TikTok publishing draft from HTTPS media references. Supported content types are VIDEO, IMAGE, and CAROUSEL. This does not schedule or publish the post; call schedule_console_publishing_post separately with the returned post id.
{
"properties": {
"account_id": {
"title": "Account Id",
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Caption"
},
"caption_plain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Caption Plain"
},
"content": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Content"
},
"content_type": {
"enum": [
"VIDEO",
"IMAGE",
"CAROUSEL"
],
"title": "Content Type",
"type": "string"
},
"generation_metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Generation Metadata"
},
"generation_prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Generation Prompt"
},
"hashtags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Hashtags"
},
"media_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Media Count"
},
"media_urls": {
"items": {
"type": "string"
},
"title": "Media Urls",
"type": "array"
},
"mentions": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Mentions"
},
"platform": {
"const": "TIKTOK",
"title": "Platform",
"type": "string"
},
"platform_metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Platform Metadata"
},
"render_metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Render Metadata"
},
"source_metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Source Metadata"
},
"source_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source Url"
},
"thumbnail_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Thumbnail Url"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
}
},
"required": [
"account_id",
"platform",
"content_type",
"media_urls"
],
"title": "create_console_publishing_postArguments",
"type": "object"
}Publishingget_console_publishing_analytics_breakdowngroup_by
Get compact publishing analytics grouped by account, platform, status, or content_type.
{
"properties": {
"from_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "From Time"
},
"group_by": {
"enum": [
"account",
"platform",
"status",
"content_type"
],
"title": "Group By",
"type": "string"
},
"to_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To Time"
}
},
"required": [
"group_by"
],
"title": "get_console_publishing_analytics_breakdownArguments",
"type": "object"
}Publishingget_console_publishing_analytics_summaryNo required input
Get a compact publishing analytics summary for an optional date, account, or post filter.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"from_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "From Time"
},
"post_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Post Ids"
},
"to_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To Time"
}
},
"title": "get_console_publishing_analytics_summaryArguments",
"type": "object"
}Publishingget_console_publishing_analytics_timeseriesNo required input
Get compact daily publishing analytics points. Only day interval is supported.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"from_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "From Time"
},
"interval": {
"const": "day",
"default": "day",
"title": "Interval",
"type": "string"
},
"to_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To Time"
}
},
"title": "get_console_publishing_analytics_timeseriesArguments",
"type": "object"
}Publishingget_console_publishing_postpost_id
Get one Console publishing post with full edit context, including captions, media URLs, sanitized metadata, schedules, and analytics snapshots.
{
"properties": {
"post_id": {
"title": "Post Id",
"type": "string"
}
},
"required": [
"post_id"
],
"title": "get_console_publishing_postArguments",
"type": "object"
}Publishingget_console_publishing_schedule_boardNo required input
Get a compact publishing schedule board across active schedules and recent publish activity.
{
"properties": {
"activity_since": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Activity Since"
},
"limit": {
"default": 250,
"title": "Limit",
"type": "integer"
}
},
"title": "get_console_publishing_schedule_boardArguments",
"type": "object"
}Publishinglist_console_publishing_accountsNo required input
List Console publishing accounts with compact capability and integration status.
{
"properties": {},
"title": "list_console_publishing_accountsArguments",
"type": "object"
}Publishinglist_console_publishing_postsNo required input
List Console publishing posts as compact summaries. Does not include full captions, metadata blobs, source metadata, generation metadata, analytics snapshots, or media URLs. Use get_console_publishing_post for full edit context.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"created_after": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created After"
},
"created_before": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created Before"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cursor"
},
"limit": {
"default": 50,
"title": "Limit",
"type": "integer"
},
"platform": {
"anyOf": [
{
"const": "TIKTOK",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Platform"
},
"published_after": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Published After"
},
"published_before": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Published Before"
},
"search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Search"
},
"sort": {
"default": "created_desc",
"enum": [
"created_desc",
"updated_desc",
"published_desc",
"views_desc"
],
"title": "Sort",
"type": "string"
},
"status": {
"anyOf": [
{
"enum": [
"DRAFT",
"PENDING_REVIEW",
"APPROVED",
"SCHEDULED",
"QUEUED",
"PUBLISHING",
"PUBLISHED",
"FAILED",
"ARCHIVED"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"title": "list_console_publishing_postsArguments",
"type": "object"
}Publishinglist_console_publishing_scheduled_postsNo required input
List compact Console scheduled publishing actions. Use explicit scheduled_post_id for changes.
{
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"completed_since": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Completed Since"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cursor"
},
"limit": {
"default": 100,
"title": "Limit",
"type": "integer"
},
"status": {
"anyOf": [
{
"enum": [
"PENDING",
"QUEUED",
"CLAIMED",
"RUNNING",
"COMPLETED",
"FAILED",
"CANCELLED",
"SKIPPED"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"statuses": {
"anyOf": [
{
"items": {
"enum": [
"PENDING",
"QUEUED",
"CLAIMED",
"RUNNING",
"COMPLETED",
"FAILED",
"CANCELLED",
"SKIPPED"
],
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Statuses"
}
},
"title": "list_console_publishing_scheduled_postsArguments",
"type": "object"
}Publishingreschedule_console_publishing_scheduled_postscheduled_post_id, scheduled_for, timezone
Reschedule an existing scheduled publishing action. Requires explicit scheduled_post_id, scheduled_for, and IANA timezone; do not infer the schedule from a post id. PENDING, QUEUED, CLAIMED, and FAILED scheduled actions can be rescheduled.
{
"properties": {
"scheduled_for": {
"title": "Scheduled For",
"type": "string"
},
"scheduled_post_id": {
"title": "Scheduled Post Id",
"type": "string"
},
"timezone": {
"title": "Timezone",
"type": "string"
}
},
"required": [
"scheduled_post_id",
"scheduled_for",
"timezone"
],
"title": "reschedule_console_publishing_scheduled_postArguments",
"type": "object"
}Publishingschedule_console_publishing_postpost_id, scheduled_for, timezone
Schedule an existing Console publishing post. Requires explicit scheduled_for and IANA timezone; do not parse fuzzy natural-language times or guess ambiguous user intent.
{
"properties": {
"post_id": {
"title": "Post Id",
"type": "string"
},
"scheduled_for": {
"title": "Scheduled For",
"type": "string"
},
"timezone": {
"title": "Timezone",
"type": "string"
}
},
"required": [
"post_id",
"scheduled_for",
"timezone"
],
"title": "schedule_console_publishing_postArguments",
"type": "object"
}Publishingupdate_console_publishing_postpost_id, patch
Partially update a Console publishing post. Pass a patch object using ConsolePublishingPostUpdateRequest fields; omitted fields stay unchanged, and explicit null clears nullable fields. This does not schedule or publish the post.
{
"properties": {
"patch": {
"additionalProperties": true,
"title": "Patch",
"type": "object"
},
"post_id": {
"title": "Post Id",
"type": "string"
}
},
"required": [
"post_id",
"patch"
],
"title": "update_console_publishing_postArguments",
"type": "object"
}