Skip to main content

Tiktok-Marketing

The Tiktok-Marketing agent connector is a Python package that equips AI agents to interact with Tiktok-Marketing through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.

Connector for the TikTok Marketing API (Business API v1.3). Provides access to advertiser accounts, campaigns, ad groups, ads, audiences, creative assets (images and videos), Spark Ads, product catalogs, and daily performance reports at the advertiser, campaign, ad group, and ad levels. Requires an Access Token from the TikTok for Business platform. All list operations require an advertiser_id parameter to scope results to a specific advertiser account.

Example prompts​

The Tiktok-Marketing connector is optimized to handle prompts like these.

  • List all my TikTok advertisers
  • Show me all campaigns for my advertiser account
  • List all ad groups
  • Show me all ads
  • List my custom audiences
  • Show me all creative asset images
  • List creative asset videos
  • Show me daily ad performance reports
  • Get campaign performance metrics for the last 30 days
  • Show me advertiser spend reports
  • Show me hourly ad performance reports
  • Get lifetime ad performance metrics
  • List all Spark Ad posts
  • Show me my product catalogs
  • Which campaigns have the highest budget?
  • Find all paused ad groups
  • What ads were created last month?
  • Show campaigns with lifetime budget mode
  • Which ads had the most impressions yesterday?
  • What is my total ad spend this month?
  • Which campaigns have the highest click-through rate?
  • Which Spark Ads are currently authorized?
  • Find catalogs with the most products

Unsupported prompts​

The Tiktok-Marketing connector isn't currently able to handle prompts like these.

  • Create a new campaign
  • Update ad group targeting
  • Delete an ad

Entities and actions​

This connector supports the following entities and actions. For more details, see this connector's full reference documentation.

EntityActions
AdvertisersList, Context Store Search, Context Store SQL Query
CampaignsList, Context Store Search, Context Store SQL Query
Ad GroupsList, Context Store Search, Context Store SQL Query
AdsList, Context Store Search, Context Store SQL Query, Semantic Search
AudiencesList, Context Store Search, Context Store SQL Query
Creative Assets ImagesList, Context Store Search, Context Store SQL Query
Creative Assets VideosList, Context Store Search, Context Store SQL Query
Spark AdsList, Context Store Search, Context Store SQL Query
CatalogsList
Advertisers Reports DailyList, Context Store Search, Context Store SQL Query
Campaigns Reports DailyList, Context Store Search, Context Store SQL Query
Ad Groups Reports DailyList, Context Store Search, Context Store SQL Query
Ads Reports DailyList, Context Store Search, Context Store SQL Query
Ads Reports HourlyList, Context Store Search, Context Store SQL Query
Ads Reports LifetimeList, Context Store Search, Context Store SQL Query

Tiktok-Marketing API docs​

See the official Tiktok-Marketing API reference.

Interfaces​

Use the Tiktok-Marketing connector through the Airbyte Agent CLI, the Python SDK, or the API.

CLI​

Install the CLI:

curl -fsSL https://airbyte.ai/install.sh | bash

Authenticate with Airbyte:

airbyte-agent login

Create the connector. The CLI opens the hosted setup flow:

airbyte-agent connectors create --json '{
  "workspace": "<your_workspace_name>",
  "name": "tiktok-marketing"
}'

Describe the connector to see its supported entities and actions:

airbyte-agent connectors describe --json '{
  "workspace": "<your_workspace_name>",
  "name": "tiktok-marketing"
}'

Execute an action:

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "tiktok-marketing",
  "entity": "advertisers",
  "action": "list"
}'

Python SDK​

Installation​

uv pip install airbyte-agent-sdk

Usage​

Connectors can run in hosted or open source mode.

Hosted​

In hosted mode, API credentials are stored securely in Airbyte Agents. You provide your Airbyte credentials instead. If your Airbyte client can access multiple organizations, also set organization_id.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

The connect() factory returns a fully typed TiktokMarketingConnector and reads AIRBYTE_CLIENT_ID / AIRBYTE_CLIENT_SECRET from the environment:

The recommended pattern is build_connector_tools, which gives the agent three tools bound to this connector: inspect_connector, read_skill_docs, and execute. The agent can inspect the connector, read only the skill-doc section it needs, and then execute:

inspect_connector() -> read_skill_docs() -> read_skill_docs(section="...") -> execute(entity, action, params)

Pass section IDs verbatim as the outline lists them, prefix included (actions.<entity>.<action>, not <entity>.<action>); anything else returns an error the agent has to recover from.

The builder names its tools inspect_connector, read_skill_docs, and execute, so the tool sets for more than one connector collide when registered on the same agent. Renaming the callables at registration avoids the collision, but the generated execute guidance still names inspect_connector and read_skill_docs, pointing the model at the wrong tools. Use the agent_tool pattern below instead: it weaves your own names into that guidance.

Pydantic AI
from airbyte_agent_sdk import build_connector_tools
from pydantic_ai import Agent
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.tiktok_marketing import TiktokMarketingConnector

connector = connect("tiktok-marketing", workspace_name="<your_workspace_name>")

tools = build_connector_tools(connector, framework="pydantic_ai")
agent = Agent("openai:gpt-4o", tools=tools.as_list())
Custom tool bodies​

When you need custom tool bodies — or a framework without native support — use TiktokMarketingConnector.agent_tool. Register execute, inspect, and docs together so the agent can fetch connector guidance progressively. Pass the framework explicitly when it has a supported failure strategy:

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.tiktok_marketing import TiktokMarketingConnector

connector = connect("tiktok-marketing", workspace_name="<your_workspace_name>")

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@TiktokMarketingConnector.agent_tool(
    framework="pydantic_ai",
    inspect_tool="tiktok_marketing_inspect",
    docs_tool="tiktok_marketing_read_docs",
)
async def tiktok_marketing_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

@agent.tool_plain
@TiktokMarketingConnector.agent_tool(framework="pydantic_ai")
async def tiktok_marketing_inspect():
    return await connector.inspect_connector()

@agent.tool_plain
@TiktokMarketingConnector.agent_tool(framework="pydantic_ai")
async def tiktok_marketing_read_docs(section: str | None = None):
    return await connector.read_skill_docs(section)

Use the same three-function pattern with framework="langchain", "openai_agents", or "mcp" and that framework's registration decorator. Each value translates connector failures into the framework's own signal:

framework=Tool failures surface as
"pydantic_ai"pydantic_ai.ModelRetry
"langchain"langchain_core.tools.ToolException (set handle_tool_error=True to feed it back to the model)
"openai_agents"the failure message returned to the model as the tool result
"mcp"fastmcp.exceptions.ToolError
"none" (default)airbyte_agent_sdk.AirbyteToolError

On a framework the SDK does not support natively — or in a raw LLM dispatch loop — omit framework= and handle AirbyteToolError yourself:

No framework
from airbyte_agent_sdk import AirbyteToolError
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.tiktok_marketing import TiktokMarketingConnector

connector = connect("tiktok-marketing", workspace_name="<your_workspace_name>")

@TiktokMarketingConnector.agent_tool(
    inspect_tool="tiktok_marketing_inspect",
    docs_tool="tiktok_marketing_read_docs",
)
async def tiktok_marketing_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

@TiktokMarketingConnector.agent_tool()
async def tiktok_marketing_inspect():
    return await connector.inspect_connector()

@TiktokMarketingConnector.agent_tool()
async def tiktok_marketing_read_docs(section: str | None = None):
    return await connector.read_skill_docs(section)

# Advertise all three to the model, using each function's docstring as its description.
handlers = {
    fn.__name__: fn
    for fn in (tiktok_marketing_inspect, tiktok_marketing_read_docs, tiktok_marketing_execute)
}

# `tool_name` and `tool_args` come from the model's tool call in your dispatch loop.
try:
    tool_result = await handlers[tool_name](**tool_args)
except AirbyteToolError as err:
    tool_result = str(err)  # hand the message back to the model as an errored tool result

Each function's docstring carries the guidance the model needs, so pass it through as the tool description wherever you register it.

Legacy alternatives​

These examples are kept for existing integrations. The deprecated TiktokMarketingConnector.tool_utils pattern loads the connector's full generated catalog into one broad execute tool description instead of letting the agent read skill docs on demand. For new code, use build_connector_tools or TiktokMarketingConnector.agent_tool above.

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.tiktok_marketing import TiktokMarketingConnector

connector = connect("tiktok-marketing", workspace_name="<your_workspace_name>")

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@TiktokMarketingConnector.tool_utils
async def tiktok_marketing_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Or pass credentials explicitly (equivalent, useful when you're not loading them from the environment):

Pydantic AI
from airbyte_agent_sdk import build_connector_tools
from pydantic_ai import Agent
from airbyte_agent_sdk.connectors.tiktok_marketing import TiktokMarketingConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig

connector = TiktokMarketingConnector(
    auth_config=AirbyteAuthConfig(
        workspace_name="<your_workspace_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

tools = build_connector_tools(connector, framework="pydantic_ai")
agent = Agent("openai:gpt-4o", tools=tools.as_list())
Open source​

In open source mode, you provide API credentials directly to the connector.

The recommended pattern is build_connector_tools, which gives the agent three tools bound to this connector: inspect_connector, read_skill_docs, and execute. The agent can inspect the connector, read only the skill-doc section it needs, and then execute:

inspect_connector() -> read_skill_docs() -> read_skill_docs(section="...") -> execute(entity, action, params)

Pass section IDs verbatim as the outline lists them, prefix included (actions.<entity>.<action>, not <entity>.<action>); anything else returns an error the agent has to recover from.

The builder names its tools inspect_connector, read_skill_docs, and execute, so the tool sets for more than one connector collide when registered on the same agent. Renaming the callables at registration avoids the collision, but the generated execute guidance still names inspect_connector and read_skill_docs, pointing the model at the wrong tools. Use the agent_tool pattern below instead: it weaves your own names into that guidance.

Pydantic AI
from airbyte_agent_sdk import build_connector_tools
from pydantic_ai import Agent
from airbyte_agent_sdk.connectors.tiktok_marketing import TiktokMarketingConnector
from airbyte_agent_sdk.connectors.tiktok_marketing.models import TiktokMarketingAuthConfig

connector = TiktokMarketingConnector(
    auth_config=TiktokMarketingAuthConfig(
        access_token="<Your TikTok Marketing API access token>"
    )
)

tools = build_connector_tools(connector, framework="pydantic_ai")
agent = Agent("openai:gpt-4o", tools=tools.as_list())
Custom tool bodies​

When you need custom tool bodies — or a framework without native support — use TiktokMarketingConnector.agent_tool. Register execute, inspect, and docs together so the agent can fetch connector guidance progressively. Pass the framework explicitly when it has a supported failure strategy:

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk.connectors.tiktok_marketing import TiktokMarketingConnector
from airbyte_agent_sdk.connectors.tiktok_marketing.models import TiktokMarketingAuthConfig

connector = TiktokMarketingConnector(
    auth_config=TiktokMarketingAuthConfig(
        access_token="<Your TikTok Marketing API access token>"
    )
)

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@TiktokMarketingConnector.agent_tool(
    framework="pydantic_ai",
    inspect_tool="tiktok_marketing_inspect",
    docs_tool="tiktok_marketing_read_docs",
)
async def tiktok_marketing_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

@agent.tool_plain
@TiktokMarketingConnector.agent_tool(framework="pydantic_ai")
async def tiktok_marketing_inspect():
    return await connector.inspect_connector()

@agent.tool_plain
@TiktokMarketingConnector.agent_tool(framework="pydantic_ai")
async def tiktok_marketing_read_docs(section: str | None = None):
    return await connector.read_skill_docs(section)

Use the same three-function pattern with framework="langchain", "openai_agents", or "mcp" and that framework's registration decorator. Each value translates connector failures into the framework's own signal:

framework=Tool failures surface as
"pydantic_ai"pydantic_ai.ModelRetry
"langchain"langchain_core.tools.ToolException (set handle_tool_error=True to feed it back to the model)
"openai_agents"the failure message returned to the model as the tool result
"mcp"fastmcp.exceptions.ToolError
"none" (default)airbyte_agent_sdk.AirbyteToolError

On a framework the SDK does not support natively — or in a raw LLM dispatch loop — omit framework= and handle AirbyteToolError yourself:

No framework
from airbyte_agent_sdk import AirbyteToolError
from airbyte_agent_sdk.connectors.tiktok_marketing import TiktokMarketingConnector
from airbyte_agent_sdk.connectors.tiktok_marketing.models import TiktokMarketingAuthConfig

connector = TiktokMarketingConnector(
    auth_config=TiktokMarketingAuthConfig(
        access_token="<Your TikTok Marketing API access token>"
    )
)

@TiktokMarketingConnector.agent_tool(
    inspect_tool="tiktok_marketing_inspect",
    docs_tool="tiktok_marketing_read_docs",
)
async def tiktok_marketing_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

@TiktokMarketingConnector.agent_tool()
async def tiktok_marketing_inspect():
    return await connector.inspect_connector()

@TiktokMarketingConnector.agent_tool()
async def tiktok_marketing_read_docs(section: str | None = None):
    return await connector.read_skill_docs(section)

# Advertise all three to the model, using each function's docstring as its description.
handlers = {
    fn.__name__: fn
    for fn in (tiktok_marketing_inspect, tiktok_marketing_read_docs, tiktok_marketing_execute)
}

# `tool_name` and `tool_args` come from the model's tool call in your dispatch loop.
try:
    tool_result = await handlers[tool_name](**tool_args)
except AirbyteToolError as err:
    tool_result = str(err)  # hand the message back to the model as an errored tool result

Each function's docstring carries the guidance the model needs, so pass it through as the tool description wherever you register it.

Legacy alternatives​

These examples are kept for existing integrations. The deprecated TiktokMarketingConnector.tool_utils pattern loads the connector's full generated catalog into one broad execute tool description instead of letting the agent read skill docs on demand. For new code, use build_connector_tools or TiktokMarketingConnector.agent_tool above.

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk.connectors.tiktok_marketing import TiktokMarketingConnector
from airbyte_agent_sdk.connectors.tiktok_marketing.models import TiktokMarketingAuthConfig

connector = TiktokMarketingConnector(
    auth_config=TiktokMarketingAuthConfig(
        access_token="<Your TikTok Marketing API access token>"
    )
)

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@TiktokMarketingConnector.tool_utils
async def tiktok_marketing_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Authentication​

For all authentication options, see the connector's authentication documentation.

IP allow list​

If your organization restricts access to specific IPs, add the Airbyte Agents IP addresses to your allow list.

Version information​

Connector version: 1.1.6

Was this page helpful?