Server definition
- Hash
- sha256:e3d54382660e0fa7a71abdb0e6565b5bb975997cb69bc031c5bc323fd656e843
- What it is
- What a remote MCP server returned when asked what it offers: 81 tools
The blob, as servednamed by its sha256
{
"instructions": null,
"tools": [
{
"description": "add contacts to a campaign, by id or by creating them inline. a campaign needs at least one contact before it can be activated. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"contact_ids": {
"description": "ids of existing contacts to link",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"contacts": {
"description": "new contacts to create and link (same shape as create_contact)",
"items": {
"additionalProperties": {},
"type": "object"
},
"type": "array"
},
"deduplicate": {
"description": "skip contacts already linked (default true)",
"type": "boolean"
},
"id": {
"description": "campaign ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "add_campaign_contacts",
"outputSchema": null
},
{
"description": "queue AI analysis of a campaign to generate its target profiles: from the product for product_promotion campaigns, from goal_description for any other campaign. runs asynchronously; poll get_campaign until analysis_status is completed, then search_campaign_contacts. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "campaign ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "analyze_campaign",
"outputSchema": null
},
{
"description": "analyze an inbound message using AI to determine sentiment, intent, and suggested actions. requires generate scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"conversation_id": {
"description": "conversation ID",
"format": "uuid",
"type": "string"
},
"message_content": {
"description": "message content to analyze",
"maxLength": 10000,
"minLength": 1,
"type": "string"
}
},
"required": [
"conversation_id",
"message_content"
],
"type": "object"
},
"name": "analyze_response",
"outputSchema": null
},
{
"description": "approve a pending message for sending. requires send scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "message ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "approve_message",
"outputSchema": null
},
{
"description": "copy a library audience into a campaign. the response is the campaign's own copy (a target profile) - editing it never touches the library master. if the campaign already has a same-named profile, the existing copy is returned. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"campaign_id": {
"description": "campaign to attach to (must be yours and not completed or deleted)",
"format": "uuid",
"type": "string"
},
"id": {
"description": "audience (library profile) ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"campaign_id"
],
"type": "object"
},
"name": "attach_audience_to_campaign",
"outputSchema": null
},
{
"description": "import multiple contacts at once, optionally adding them to a campaign. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"campaign_id": {
"description": "campaign ID to add contacts to",
"format": "uuid",
"type": "string"
},
"contacts": {
"description": "array of contacts to import",
"items": {
"additionalProperties": false,
"properties": {
"company_name": {
"description": "company name",
"type": "string"
},
"email": {
"description": "contact email",
"format": "email",
"type": "string"
},
"first_name": {
"description": "first name",
"type": "string"
},
"job_title": {
"description": "job title",
"type": "string"
},
"last_name": {
"description": "last name",
"type": "string"
},
"tags": {
"description": "tags",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"email"
],
"type": "object"
},
"maxItems": 500,
"minItems": 1,
"type": "array"
}
},
"required": [
"contacts"
],
"type": "object"
},
"name": "bulk_import_contacts",
"outputSchema": null
},
{
"description": "approve or reject multiple messages at once. requires send scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"action": {
"description": "action to perform",
"enum": [
"approve",
"reject"
],
"type": "string"
},
"message_ids": {
"description": "message IDs to act on",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"type": "array"
}
},
"required": [
"action",
"message_ids"
],
"type": "object"
},
"name": "bulk_message_action",
"outputSchema": null
},
{
"description": "check which outreach channels are available and configured. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "check_channel_availability",
"outputSchema": null
},
{
"description": "create or update the autopilot config (merge: only the fields you send change; first call creates the config with defaults). autopilot is review-only - drafts wait in the approval queue, nothing sends without approval. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"campaign_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "the ONE standing campaign autopilot tends (draft, scheduled, or active); null to unset"
},
"enabled": {
"description": "turn the nightly loop on or off (enabling requires a campaign_id and clears pause state)",
"type": "boolean"
},
"max_new_contacts_per_run": {
"description": "discovery batch size per nightly run (default 10)",
"maximum": 50,
"minimum": 10,
"type": "integer"
},
"max_pending_reviews": {
"description": "skip discovery while this many drafts sit unreviewed (default 25)",
"maximum": 200,
"minimum": 5,
"type": "integer"
},
"run_hour": {
"description": "local hour the nightly run fires (default 2)",
"maximum": 23,
"minimum": 0,
"type": "integer"
},
"timezone": {
"description": "IANA timezone for run_hour (default America/New_York)",
"maxLength": 64,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"name": "configure_autopilot",
"outputSchema": null
},
{
"description": "create or update the responder config (merge: only the fields you send change; the first call creates the config). with auto_reply on, replies are sent without review. Instagram only allows a reply within 24 hours of the person's last message, and only to someone who wrote first. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"auto_reply": {
"description": "let iris send replies itself, with no review. requires enabled, and either instructions or a profile background to answer from.",
"type": "boolean"
},
"booking_url": {
"anyOf": [
{
"format": "uri",
"maxLength": 500,
"type": "string"
},
{
"type": "null"
}
],
"description": "shared when someone asks to talk or book (https url); null to unset"
},
"disclosure": {
"anyOf": [
{
"maxLength": 200,
"minLength": 10,
"type": "string"
},
{
"type": "null"
}
],
"description": "the line that says the reply is automated, sent once per conversation with the first reply; null uses the default"
},
"enabled": {
"description": "thread Instagram DMs from anyone into the inbox. turning it off also turns auto_reply off. true clears any pause state.",
"type": "boolean"
},
"instructions": {
"anyOf": [
{
"maxLength": 4000,
"type": "string"
},
{
"type": "null"
}
],
"description": "what you offer, prices, answers to common questions, tone; null to unset"
},
"max_replies_per_conversation": {
"description": "after this many automatic replies the conversation is handed to you (default 8)",
"maximum": 30,
"minimum": 1,
"type": "integer"
},
"qualifying_questions": {
"description": "asked one per message, in order, before the booking link is shared (max 5 items)",
"items": {
"maxLength": 200,
"type": "string"
},
"maxItems": 5,
"type": "array"
}
},
"type": "object"
},
"name": "configure_responder",
"outputSchema": null
},
{
"description": "create a library audience profile manually. names are unique per library (case-insensitive). requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"buying_signals": {
"description": "signals they're ready to buy",
"items": {
"maxLength": 100,
"type": "string"
},
"maxItems": 10,
"type": "array"
},
"description": {
"description": "who this audience is",
"maxLength": 500,
"type": "string"
},
"discovery_keywords": {
"description": "keywords for contact discovery",
"items": {
"maxLength": 100,
"type": "string"
},
"maxItems": 10,
"type": "array"
},
"fit_score": {
"description": "how well this audience fits (0-100)",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"industries": {
"description": "target industries",
"items": {
"maxLength": 100,
"type": "string"
},
"maxItems": 10,
"type": "array"
},
"job_titles": {
"description": "target job titles",
"items": {
"maxLength": 100,
"type": "string"
},
"maxItems": 10,
"type": "array"
},
"name": {
"description": "audience name",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"outreach_angle": {
"description": "the hook messages should lead with",
"maxLength": 500,
"type": "string"
},
"pain_points": {
"description": "problems they feel",
"items": {
"maxLength": 100,
"type": "string"
},
"maxItems": 10,
"type": "array"
},
"profile_type": {
"description": "target profile type",
"enum": [
"local_business",
"content_creator",
"influencer",
"b2b_professional",
"ecommerce",
"saas_company",
"agency",
"freelancer",
"other"
],
"type": "string"
}
},
"required": [
"name",
"profile_type"
],
"type": "object"
},
"name": "create_audience",
"outputSchema": null
},
{
"description": "create a new outreach campaign. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"name": {
"description": "campaign name",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"objective_type": {
"description": "campaign objective type",
"enum": [
"venue_dj",
"venue_host",
"product_promotion",
"custom"
],
"type": "string"
},
"product_description": {
"description": "product description (for product_promotion objective)",
"maxLength": 2000,
"type": "string"
},
"product_name": {
"description": "product name (for product_promotion objective)",
"maxLength": 200,
"type": "string"
},
"product_url": {
"description": "product URL (for product_promotion objective)",
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"objective_type"
],
"type": "object"
},
"name": "create_campaign",
"outputSchema": null
},
{
"description": "create a new contact. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"company_name": {
"description": "company name",
"maxLength": 200,
"type": "string"
},
"email": {
"description": "contact email address",
"format": "email",
"type": "string"
},
"first_name": {
"description": "first name",
"maxLength": 100,
"type": "string"
},
"job_title": {
"description": "job title",
"maxLength": 200,
"type": "string"
},
"last_name": {
"description": "last name",
"maxLength": 100,
"type": "string"
},
"phone": {
"description": "phone number",
"maxLength": 50,
"type": "string"
},
"tags": {
"description": "tags for categorization",
"items": {
"type": "string"
},
"type": "array"
},
"website": {
"description": "website URL",
"format": "uri",
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
},
"name": "create_contact",
"outputSchema": null
},
{
"description": "find-or-create a conversation for a contact - the hub conversation by default, or the campaign-scoped thread when campaign_id is passed (contact must be in that campaign). requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"campaign_id": {
"description": "scope to a campaign the contact belongs to",
"format": "uuid",
"type": "string"
},
"contact_id": {
"description": "contact ID to converse with",
"format": "uuid",
"type": "string"
}
},
"required": [
"contact_id"
],
"type": "object"
},
"name": "create_conversation",
"outputSchema": null
},
{
"description": "create a message in a conversation. status pending_approval places it in the human review queue instead of sending. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"channel": {
"description": "delivery channel (tiktok is manual-send: record only)",
"enum": [
"email",
"twitter",
"instagram",
"tiktok"
],
"type": "string"
},
"content": {
"description": "message content",
"minLength": 1,
"type": "string"
},
"direction": {
"description": "message direction",
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"id": {
"description": "conversation ID",
"format": "uuid",
"type": "string"
},
"platform_recipient_id": {
"description": "platform recipient id (twitter/instagram channels)",
"type": "string"
},
"status": {
"description": "initial message status",
"enum": [
"draft",
"queued",
"sending",
"pending_approval",
"sent",
"delivered",
"failed",
"bounced",
"rejected"
],
"type": "string"
}
},
"required": [
"id",
"content",
"direction",
"status",
"channel"
],
"type": "object"
},
"name": "create_conversation_message",
"outputSchema": null
},
{
"description": "create a comment trigger. when someone comments the keyword on the account's instagram post, iris sends that person one direct message: the owner's message as written, followed by the notice that it is automated. instagram allows one such message per comment, within 7 days of the comment, and nothing more unless the person replies. it only sends while status.comment_triggers on get_responder is ready; needs_permission means the owner has to reconnect instagram from the responder settings page in the iris web app, unavailable means the feature isn't offered on the account yet. each message sent counts as a message against the plan. needs an API key and a connected instagram account; x402 and MPP identities cannot use it. at most 20 triggers per account, and a second trigger with the same keyword on the same post is refused. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "whether the trigger is active (default true)",
"type": "boolean"
},
"keyword": {
"description": "matched as a whole word or phrase in the comment, case-insensitive (1-50 characters)",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"media_id": {
"anyOf": [
{
"pattern": "^\\d{5,40}$",
"type": "string"
},
{
"type": "null"
}
],
"description": "the numeric instagram media id to limit the trigger to one post (5-40 digits; get it from list_responder_posts); omit or send null to match every post"
},
"message": {
"description": "the DM sent to the commenter, before the automated notice (1-900 characters, and at most 700 bytes)",
"maxLength": 900,
"minLength": 1,
"type": "string"
}
},
"required": [
"keyword",
"message"
],
"type": "object"
},
"name": "create_responder_comment_trigger",
"outputSchema": null
},
{
"description": "create a target profile for a campaign. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"discovery_keywords": {
"description": "keywords for contact discovery",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "campaign ID",
"format": "uuid",
"type": "string"
},
"industries": {
"description": "target industries",
"items": {
"type": "string"
},
"type": "array"
},
"job_titles": {
"description": "target job titles",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "profile name",
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"profile_type": {
"description": "type of target profile",
"enum": [
"local_business",
"content_creator",
"influencer",
"b2b_professional",
"ecommerce",
"saas_company",
"agency",
"freelancer",
"other"
],
"type": "string"
},
"recommended_channels": {
"description": "recommended outreach channels",
"items": {
"enum": [
"email",
"instagram",
"twitter"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"name",
"profile_type"
],
"type": "object"
},
"name": "create_target_profile",
"outputSchema": null
},
{
"description": "delete a library audience profile. campaigns it was attached to keep their copy. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "audience (library profile) ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "delete_audience",
"outputSchema": null
},
{
"description": "soft-delete a campaign (sets status to deleted). requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "campaign ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "delete_campaign",
"outputSchema": null
},
{
"description": "soft-delete a chat session. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"chat_id": {
"description": "chat session ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"chat_id"
],
"type": "object"
},
"name": "delete_campaign_chat",
"outputSchema": null
},
{
"description": "soft-delete a contact. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "contact ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "delete_contact",
"outputSchema": null
},
{
"description": "delete a notification. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "notification ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "delete_notification",
"outputSchema": null
},
{
"description": "delete a comment trigger. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "comment trigger ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "delete_responder_comment_trigger",
"outputSchema": null
},
{
"description": "delete a target profile from a campaign. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "campaign ID",
"format": "uuid",
"type": "string"
},
"profile_id": {
"description": "target profile ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"profile_id"
],
"type": "object"
},
"name": "delete_target_profile",
"outputSchema": null
},
{
"description": "AI-generate audience profiles from a product (scrape + analysis) into the library. generated names already in the library are skipped, not overwritten. rate limited to 5 per hour. requires generate scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"product_description": {
"description": "what it does and who it's for",
"maxLength": 2000,
"type": "string"
},
"product_name": {
"description": "product name",
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"product_url": {
"description": "product website - scraped for extra context",
"format": "uri",
"type": "string"
}
},
"required": [
"product_name"
],
"type": "object"
},
"name": "generate_audiences",
"outputSchema": null
},
{
"description": "generate campaign-level outreach content (email sequence, templates) from a campaign brief. content-first: takes the strategy inline, not a campaign id. requires generate scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"campaign_name": {
"description": "campaign name (used as the brief title)",
"minLength": 1,
"type": "string"
},
"key_benefits": {
"description": "non-empty list of key benefits to emphasise",
"items": {
"minLength": 1,
"type": "string"
},
"minItems": 1,
"type": "array"
},
"objective": {
"description": "campaign objective (e.g. 'book DJ gigs', 'sell SaaS to VPs of Eng')",
"minLength": 1,
"type": "string"
},
"target_audience": {
"description": "target audience description",
"minLength": 1,
"type": "string"
},
"tone": {
"description": "tone (e.g. professional, casual, warm-direct)",
"minLength": 1,
"type": "string"
}
},
"required": [
"campaign_name",
"objective",
"target_audience",
"key_benefits",
"tone"
],
"type": "object"
},
"name": "generate_campaign_content",
"outputSchema": null
},
{
"description": "generate AI outreach content (email or DM draft) for a contact/campaign. the contact's tags + enrichment_data feed the generation context automatically. requires generate scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"campaign_id": {
"description": "campaign to scope the generation to",
"format": "uuid",
"type": "string"
},
"contact_id": {
"description": "target contact - its tags + enrichment_data are used automatically",
"format": "uuid",
"type": "string"
},
"format": {
"description": "dm = short platform-native message text with empty subject. defaults to email",
"enum": [
"email",
"dm"
],
"type": "string"
},
"generation_type": {
"description": "type of content to generate",
"enum": [
"initial_outreach",
"follow_up",
"response_negotiation",
"meeting_request",
"closing"
],
"type": "string"
},
"include_cta": {
"description": "include a clear call-to-action",
"type": "boolean"
},
"prompt": {
"description": "additional freeform instructions",
"type": "string"
},
"tone": {
"description": "tone (e.g. professional, friendly, casual, formal, persuasive, informative)",
"minLength": 1,
"type": "string"
}
},
"required": [
"generation_type",
"tone"
],
"type": "object"
},
"name": "generate_content",
"outputSchema": null
},
{
"description": "get AI generation usage limits and current counts for the billing period. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "get_ai_usage",
"outputSchema": null
},
{
"description": "get a high-level overview of all campaign analytics. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "get_analytics_overview",
"outputSchema": null
},
{
"description": "get autopilot status: whether it's configured, the current config, the pending-review count for the standing campaign, and the latest run's step results. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "get_autopilot_status",
"outputSchema": null
},
{
"description": "get all available billing plans with pricing and feature limits. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "get_billing_plans",
"outputSchema": null
},
{
"description": "get a campaign by ID with stats. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "campaign ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_campaign",
"outputSchema": null
},
{
"description": "get detailed analytics for a specific campaign. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "campaign ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_campaign_analytics",
"outputSchema": null
},
{
"description": "list the messages in a chat session, oldest first. `content` is an array of opaque blocks (text / tool_use / tool_result). requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"chat_id": {
"description": "chat session ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"chat_id"
],
"type": "object"
},
"name": "get_campaign_chat_messages",
"outputSchema": null
},
{
"description": "get usage limits and current counts for a campaign. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "campaign ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_campaign_usage",
"outputSchema": null
},
{
"description": "machine-readable release history (public) - version, date, type, summary, migration notes on breaking entries. the X-Notice header's structured backstory.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "get_changelog",
"outputSchema": null
},
{
"description": "get a contact by ID. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "contact ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_contact",
"outputSchema": null
},
{
"description": "the contact's social handles (instagram/twitter/tiktok) - verify a handle write landed. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "contact ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_contact_handles",
"outputSchema": null
},
{
"description": "get breakdown of contacts by type/source. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "get_contact_types",
"outputSchema": null
},
{
"description": "get contact usage limits and current counts for the billing period. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "get_contact_usage",
"outputSchema": null
},
{
"description": "get a conversation by ID with contact and campaign details. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "conversation ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_conversation",
"outputSchema": null
},
{
"description": "get all messages in a conversation. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "conversation ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_conversation_messages",
"outputSchema": null
},
{
"description": "get the responder's status for a single conversation: active, paused, handed off, or never seen, plus the reason and reply counts. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"conversation_id": {
"description": "conversation ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"conversation_id"
],
"type": "object"
},
"name": "get_conversation_responder",
"outputSchema": null
},
{
"description": "get the status, progress, and contacts of a discovery job. status values: pending, running, completed, failed. contacts populated only when status=completed. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "discovery job ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_discovery_job",
"outputSchema": null
},
{
"description": "get overall engagement metrics across all conversations. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "get_engagement_metrics",
"outputSchema": null
},
{
"description": "get email performance metrics over time. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"campaign_id": {
"description": "filter by campaign ID",
"format": "uuid",
"type": "string"
},
"days": {
"description": "time window in days (1–90, default 30)",
"maximum": 90,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"name": "get_performance_metrics",
"outputSchema": null
},
{
"description": "get responder status: whether it's configured, the current config, connection and pause status, and activity counts for the last 30 days. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "get_responder",
"outputSchema": null
},
{
"description": "get average response time analytics. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"campaign_id": {
"description": "filter by campaign ID",
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"name": "get_response_time",
"outputSchema": null
},
{
"description": "get your current plan, quota usage (campaigns used/remaining this period), and billing period (requires read scope)",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "get_usage",
"outputSchema": null
},
{
"description": "list the audience library - reusable target profiles created once and attachable to any campaign. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"page": {
"description": "page number (default 1)",
"exclusiveMinimum": 0,
"type": "integer"
},
"page_size": {
"description": "items per page (default 50, max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"name": "list_audiences",
"outputSchema": null
},
{
"description": "list your iris chat sessions (the conversational campaign builder), most recently updated first, max 100. the live chat turn itself is a server-sent-events stream outside this tool set. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "list_campaign_chats",
"outputSchema": null
},
{
"description": "list contacts in a campaign with optional status filter. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "campaign ID",
"format": "uuid",
"type": "string"
},
"page": {
"description": "page number (default 1)",
"exclusiveMinimum": 0,
"type": "integer"
},
"page_size": {
"description": "items per page (default 50, max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"status": {
"description": "filter by contact status",
"enum": [
"pending",
"queued",
"contacted",
"responded",
"converted",
"bounced",
"opted_out"
],
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "list_campaign_contacts",
"outputSchema": null
},
{
"description": "list all campaigns with optional filtering by status. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"page": {
"description": "page number (default 1)",
"exclusiveMinimum": 0,
"type": "integer"
},
"page_size": {
"description": "items per page (default 50, max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"status": {
"description": "filter by campaign status",
"enum": [
"draft",
"active",
"paused",
"completed",
"deleted"
],
"type": "string"
}
},
"type": "object"
},
"name": "list_campaigns",
"outputSchema": null
},
{
"description": "list all connected social media accounts. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "list_connected_accounts",
"outputSchema": null
},
{
"description": "list all conversations for a specific contact. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "contact ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "list_contact_conversations",
"outputSchema": null
},
{
"description": "list all contacts with optional search. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"page": {
"description": "page number (default 1)",
"exclusiveMinimum": 0,
"type": "integer"
},
"page_size": {
"description": "items per page (default 50, max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"search": {
"description": "search by name, email, or company",
"type": "string"
}
},
"type": "object"
},
"name": "list_contacts",
"outputSchema": null
},
{
"description": "list conversations with optional filtering. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"campaign_id": {
"description": "filter by campaign ID",
"format": "uuid",
"type": "string"
},
"page": {
"description": "page number (default 1)",
"exclusiveMinimum": 0,
"type": "integer"
},
"page_size": {
"description": "items per page (default 50, max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"status": {
"description": "filter by conversation status",
"enum": [
"active",
"completed",
"failed",
"human_review"
],
"type": "string"
}
},
"type": "object"
},
"name": "list_conversations",
"outputSchema": null
},
{
"description": "list available discovery data sources and their status. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "list_discovery_sources",
"outputSchema": null
},
{
"description": "list user notifications. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"page": {
"description": "page number (default 1)",
"exclusiveMinimum": 0,
"type": "integer"
},
"page_size": {
"description": "items per page (default 50, max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"name": "list_notifications",
"outputSchema": null
},
{
"description": "list messages awaiting approval before sending. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"campaign_id": {
"description": "filter by campaign ID",
"format": "uuid",
"type": "string"
},
"page": {
"description": "page number (default 1)",
"exclusiveMinimum": 0,
"type": "integer"
},
"page_size": {
"description": "items per page (default 50, max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"name": "list_pending_messages",
"outputSchema": null
},
{
"description": "list the responder's activity log (replies sent, handoffs, skips, and failures), newest first. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"page": {
"description": "page number (default 1)",
"exclusiveMinimum": 0,
"type": "integer"
},
"page_size": {
"description": "items per page (default 50, max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"name": "list_responder_activity",
"outputSchema": null
},
{
"description": "list the account's comment triggers. a comment trigger watches for a keyword in instagram comments and sends the commenter one automatic DM. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "list_responder_comment_triggers",
"outputSchema": null
},
{
"description": "list the account's recent instagram posts with their media ids, for limiting a comment trigger to one post. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "list_responder_posts",
"outputSchema": null
},
{
"description": "list target profiles for a campaign. requires read scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "campaign ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "list_target_profiles",
"outputSchema": null
},
{
"description": "mark all notifications as read. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "mark_all_notifications_read",
"outputSchema": null
},
{
"description": "mark a conversation as read. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "conversation ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "mark_conversation_read",
"outputSchema": null
},
{
"description": "mark a pending manual-channel draft (tiktok, or instagram cold first-touch) as sent outside the platform. API-sendable drafts must use approve_message instead. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "approval queue item ID, or the message ID for drafts created via create_message (they have no approval item)",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "mark_message_sent",
"outputSchema": null
},
{
"description": "reject a pending message with an optional reason. requires send scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "message ID",
"format": "uuid",
"type": "string"
},
"reason": {
"description": "reason for rejection",
"maxLength": 500,
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "reject_message",
"outputSchema": null
},
{
"description": "rename a chat session. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"chat_id": {
"description": "chat session ID",
"format": "uuid",
"type": "string"
},
"title": {
"description": "new title",
"maxLength": 200,
"minLength": 1,
"type": "string"
}
},
"required": [
"chat_id",
"title"
],
"type": "object"
},
"name": "rename_campaign_chat",
"outputSchema": null
},
{
"description": "retry sending a failed message. requires send scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "message ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "retry_message",
"outputSchema": null
},
{
"description": "queue a manual autopilot run immediately (insights refresh + discovery top-up on the standing campaign). steps that already completed today are skipped. rate limited to 2 per hour. requires generate scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "run_autopilot_now",
"outputSchema": null
},
{
"description": "search for contacts matching a campaign's target profiles. requires generate scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"campaign_id": {
"description": "campaign ID",
"format": "uuid",
"type": "string"
},
"target_profile_id": {
"description": "specific target profile to search for",
"format": "uuid",
"type": "string"
}
},
"required": [
"campaign_id"
],
"type": "object"
},
"name": "search_campaign_contacts",
"outputSchema": null
},
{
"description": "kick off a multi-source contact discovery job (Apify-backed). returns a job_id and contacts when ready (waits up to 90s; if status=queued, poll get_discovery_job). closed source list: google_maps, instagram, twitter, tiktok, reddit. requires generate scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"campaign_id": {
"description": "campaign to attach discovered contacts to on finalize",
"format": "uuid",
"type": "string"
},
"enrich_emails": {
"default": true,
"description": "run waterfall email enrichment (BetterContact → FullEnrich → ZeroBounce). default true.",
"type": "boolean"
},
"keywords": {
"description": "non-empty array of search keywords (e.g. ['boutique hotel', 'rooftop venue'])",
"items": {
"minLength": 1,
"type": "string"
},
"minItems": 1,
"type": "array"
},
"location": {
"description": "location for geo-scoped goals (local_business / venue / brick-and-mortar). omit for global goals (creators, b2b, saas).",
"type": "string"
},
"max_results": {
"description": "max contacts to return (10-500, default 50; server clamps to plan cap)",
"maximum": 500,
"minimum": 10,
"type": "integer"
},
"profile_type": {
"description": "ICP profile type — drives default source mix when sources is omitted",
"enum": [
"local_business",
"content_creator",
"influencer",
"b2b_professional",
"ecommerce",
"saas_company",
"agency",
"freelancer",
"other"
],
"type": "string"
},
"radius_miles": {
"default": 25,
"description": "search radius in miles (default 25)",
"exclusiveMinimum": 0,
"type": "number"
},
"sources": {
"description": "override the default per-profile_type source mix. valid: google_maps, instagram, twitter, tiktok, reddit. omit to let the orchestrator pick.",
"items": {
"enum": [
"google_maps",
"instagram",
"twitter",
"tiktok",
"reddit"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"keywords"
],
"type": "object"
},
"name": "search_contacts",
"outputSchema": null
},
{
"description": "send a message through a specific channel in a conversation. requires send scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"channel": {
"description": "outreach channel to use",
"enum": [
"email",
"instagram",
"twitter"
],
"type": "string"
},
"content": {
"description": "message content",
"maxLength": 10000,
"minLength": 1,
"type": "string"
},
"conversation_id": {
"description": "conversation ID",
"format": "uuid",
"type": "string"
},
"recipient_id": {
"description": "recipient (email address for email channel; platform handle/ID for social channels)",
"minLength": 1,
"type": "string"
},
"subject": {
"description": "subject (email channel only)",
"type": "string"
}
},
"required": [
"channel",
"conversation_id",
"recipient_id",
"content"
],
"type": "object"
},
"name": "send_channel_message",
"outputSchema": null
},
{
"description": "pause or resume the responder for a single conversation. pausing works on any conversation; resuming is refused after the person asked iris to stop. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"conversation_id": {
"description": "conversation ID",
"format": "uuid",
"type": "string"
},
"status": {
"description": "new responder status for this conversation",
"enum": [
"active",
"paused"
],
"type": "string"
}
},
"required": [
"conversation_id",
"status"
],
"type": "object"
},
"name": "set_conversation_responder",
"outputSchema": null
},
{
"description": "submit feedback on an AI-generated message to improve future generations. requires send scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"feedback": {
"description": "feedback text",
"maxLength": 2000,
"minLength": 1,
"type": "string"
},
"id": {
"description": "message ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"feedback"
],
"type": "object"
},
"name": "submit_message_feedback",
"outputSchema": null
},
{
"description": "update a campaign's details. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"follow_up_delay_days": {
"description": "days between follow-ups",
"maximum": 30,
"minimum": 1,
"type": "integer"
},
"follow_up_enabled": {
"description": "enable follow-up emails",
"type": "boolean"
},
"follow_up_max_count": {
"description": "max follow-up count",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"id": {
"description": "campaign ID",
"format": "uuid",
"type": "string"
},
"name": {
"description": "new campaign name",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"status": {
"description": "new campaign status",
"enum": [
"draft",
"active",
"paused",
"completed",
"deleted"
],
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "update_campaign",
"outputSchema": null
},
{
"description": "update a contact's details. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"company_name": {
"description": "company name",
"maxLength": 200,
"type": "string"
},
"email": {
"description": "email address",
"format": "email",
"type": "string"
},
"first_name": {
"description": "first name",
"maxLength": 100,
"type": "string"
},
"id": {
"description": "contact ID",
"format": "uuid",
"type": "string"
},
"job_title": {
"description": "job title",
"maxLength": 200,
"type": "string"
},
"last_name": {
"description": "last name",
"maxLength": 100,
"type": "string"
},
"phone": {
"description": "phone number",
"maxLength": 50,
"type": "string"
},
"tags": {
"description": "tags for categorization",
"items": {
"type": "string"
},
"type": "array"
},
"website": {
"description": "website URL",
"format": "uri",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "update_contact",
"outputSchema": null
},
{
"description": "update a conversation's status: active, archived, or closed. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "conversation ID",
"format": "uuid",
"type": "string"
},
"status": {
"description": "new conversation status",
"enum": [
"active",
"archived",
"closed"
],
"type": "string"
}
},
"required": [
"id",
"status"
],
"type": "object"
},
"name": "update_conversation",
"outputSchema": null
},
{
"description": "update a notification (e.g., mark as read). requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "notification ID",
"format": "uuid",
"type": "string"
},
"read": {
"description": "mark as read or unread",
"type": "boolean"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "update_notification",
"outputSchema": null
},
{
"description": "update a comment trigger's keyword, message, media_id, or enabled state. give at least one field besides id. someone else's trigger, or an id that isn't a comment trigger on this account, is a 404. requires write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "whether the trigger is active",
"type": "boolean"
},
"id": {
"description": "comment trigger ID",
"format": "uuid",
"type": "string"
},
"keyword": {
"description": "matched as a whole word or phrase in the comment, case-insensitive (1-50 characters)",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"media_id": {
"anyOf": [
{
"pattern": "^\\d{5,40}$",
"type": "string"
},
{
"type": "null"
}
],
"description": "the numeric instagram media id to limit the trigger to one post (5-40 digits; get it from list_responder_posts); null matches every post"
},
"message": {
"description": "the DM sent to the commenter, before the automated notice (1-900 characters, and at most 700 bytes)",
"maxLength": 900,
"minLength": 1,
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "update_responder_comment_trigger",
"outputSchema": null
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:e3d54382660e0fa7a71abdb0e6565b5bb975997cb69bc031c5bc323fd656e843 | sha256sum