← The evidence ledger
Evidence row 528315
Observed , by probe.mcp/1.
- Kind
- mcp.tools
- About
- endpoint 2ad83249-f134-4b1a-963d-962bbb191644
- Recorded
- Previous row
- None: the first of its kind about this subject
- Body SHA-256
- 8275b1125533bf9ae6be3352090ece6d96028c10729a8e6a76905447415404d1
- Leaf
- 0x7be994afeb2706fee1b33bc36f6637faa33eff069d906b73c1ce87b82eb56759
What was observed
{
"count": 154,
"tools": [
{
"description": "Pack 2 or 3 images of one of your thumbnails, edit or Optimize calls for YouTube\n Studio's Test and Compare: a zip of A, B, C (1280x720, under 2 MB) and a note of what each\n tests. Free. Same as POST /v1/ab.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"picks": {
"items": {
"type": "integer"
},
"title": "Picks",
"type": "array"
},
"source_call_id": {
"title": "Source Call Id",
"type": "string"
}
},
"required": [
"source_call_id",
"picks"
],
"title": "ab_setArguments",
"type": "object"
},
"name": "ab_set"
},
{
"description": "Join the team an invite names. From then on what you spend comes from the team's pool;\n your own runs stay private and your own balance waits for you. Each link works once\n (409 invite_used) for 7 days (410 invite_expired). Needs admin. Free. Same as POST\n /v1/team/invites/{token}/accept.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"token": {
"description": "the hdt_... token, the part of the link after #",
"title": "Token",
"type": "string"
}
},
"required": [
"token"
],
"title": "accept_team_inviteArguments",
"type": "object"
},
"name": "accept_team_invite"
},
{
"description": "Add channels to one of your trackers. Same as POST /v1/trackers/{tracker_id}/channels.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"channels": {
"items": {
"type": "string"
},
"maxItems": 50,
"minItems": 1,
"title": "Channels",
"type": "array"
},
"tracker_id": {
"title": "Tracker Id",
"type": "string"
}
},
"required": [
"tracker_id",
"channels"
],
"title": "add_to_trackerArguments",
"type": "object"
},
"name": "add_to_tracker"
},
{
"description": "Owner only: add or remove an account's credits, as POST\n /v1/admin/accounts/{account_id}/credits. A change that would take the balance below\n zero is 422 credits_below_zero and nothing changes; an unknown account is 404\n account_not_found. Every change is audited (admin_list_actions). Returns {account_id,\n credits, delta}.",
"inputSchema": {
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "the id from admin_list_accounts",
"title": "Account Id"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"delta": {
"anyOf": [
{
"maximum": 1000000,
"minimum": -1000000,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "credits to add (positive) or remove (negative), -1000000 to 1000000, not zero",
"title": "Delta"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "why, for the audit: 1 to 200 characters, required",
"title": "Note"
}
},
"title": "admin_adjust_creditsArguments",
"type": "object"
},
"name": "admin_adjust_credits"
},
{
"description": "Owner only: every account, newest first, as GET /v1/admin/accounts: {total,\n accounts: [{id, email, name, label, credits, created_at, last_seen_at, runs, hooks,\n charged_total, is_admin, admitted_by, keys_active}]}. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"limit": {
"anyOf": [
{
"maximum": 200,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "page size, 1 to 200 (default 50)",
"title": "Limit"
},
"offset": {
"anyOf": [
{
"maximum": 1000000,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "how many to skip",
"title": "Offset"
},
"q": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "up to 200 characters: part of an email or label (any case), or the start of an id",
"title": "Q"
}
},
"title": "admin_list_accountsArguments",
"type": "object"
},
"name": "admin_list_accounts"
},
{
"description": "Owner only: the audit of password sign-ins and credit changes, newest first, as GET\n /v1/admin/actions: {actions: [{id, action, actor_email, target_account_id, detail,\n created_at}]}. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"limit": {
"anyOf": [
{
"maximum": 200,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "page size, 1 to 200 (default 50)",
"title": "Limit"
}
},
"title": "admin_list_actionsArguments",
"type": "object"
},
"name": "admin_list_actions"
},
{
"description": "Owner only: every account's research runs, newest first, as GET /v1/admin/runs:\n {runs: [{run_id, account_id, email, topic, language, country, status, requested,\n hooks, reserved, charged, failure_kind, error, created_at, finished_at}]}. Free.",
"inputSchema": {
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "only this account's",
"title": "Account Id"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"limit": {
"anyOf": [
{
"maximum": 200,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "page size, 1 to 200 (default 50)",
"title": "Limit"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "only runs with this status: queued, running, done, failed",
"title": "Status"
}
},
"title": "admin_list_runsArguments",
"type": "object"
},
"name": "admin_list_runs"
},
{
"description": "Owner only: the whole service at a glance, as GET /v1/admin/overview. Counts of\n accounts and people; runs (total, last_24h, last_7d, failed_24h, in_flight); hooks;\n credits (charged_24h, charged_7d, charged_total, balance_total); access\n (pending_requests, active_codes, redemptions); search (credits_left, low,\n accepting_runs; null when not read yet); and the running commit. Needs the admin scope\n and an admin account (403 admin_required otherwise). Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"title": "admin_overviewArguments",
"type": "object"
},
"name": "admin_overview"
},
{
"description": "Owner only: approve an access request. Makes a one-use code, marks the request\n approved and emails the code. The code is in this result once, with emailed true or\n false; when false, send it yourself or approve again (the unused code is revoked and\n a new one sent). 409 request_already_decided once its code was used. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"request_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Request Id"
}
},
"title": "approve_access_requestArguments",
"type": "object"
},
"name": "approve_access_request"
},
{
"description": "Your account and remaining credits right now: account_id, credits, key_prefix and\n key_id of the key making this call, label, created_at, and that key's scopes,\n credit_limit and expires_at, and user (the person signed in with Google, or null).\n Same shape as GET /v1/me. A\n run needs at least 40 credits and reserves up to 200. For spend, credits held by\n in-flight runs and daily history, call usage. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"title": "balanceArguments",
"type": "object"
},
"name": "balance"
},
{
"description": "A channel's own outliers (scope own), or outliers for a channel like it from other\n channels in the shared index (scope niche, 3x and over by default). Free. Same as\n GET /v1/channels/{ref}/outliers.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"limit": {
"default": 24,
"maximum": 50,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"min_multiple": {
"anyOf": [
{
"maximum": 1000,
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Multiple"
},
"ref": {
"title": "Ref",
"type": "string"
},
"scope": {
"default": "own",
"description": "own or niche",
"title": "Scope",
"type": "string"
}
},
"required": [
"ref"
],
"title": "channel_outliersArguments",
"type": "object"
},
"name": "channel_outliers"
},
{
"description": "One conversational turn, for an agent relaying a person's words. It either asks\n ONE clarifying question (action \"clarify\"), answers about delivered hooks or the tool\n (action \"answer\", run null, no credits), or starts a research run (action\n \"research\", with the started run under \"run\"), exactly like POST /v1/chat.\n Every response has suggestions: 0 to 4 follow-ups, [] for research.\n\n A deck size typed into the message (\"..., 15 hooks\") and a recency phrase (\"this\n month\", \"last week\") set the run's count and posted_within_days; the count argument\n sets the deck size when the message states none. Asked to make one of\n the conversation's hooks yours for a niche (\"make hook 2 mine for dentists\"), the turn\n writes lines from that hook's structure (1 credit, like remix_hook) and answers them\n labelled, the full result under \"remix\".\n\n language and country select the search locale: omitted or null keeps the current\n conversation setting; a value sets it for this and later turns; an empty string\n clears it to any language / any country. The picker wins over the message's locale;\n replies stay in the language the person writes in. Invalid locale: 422 invalid_request.\n\n message is 1 to 4000 characters. Pass conversation_id from an earlier turn to keep\n the context; leave it out to start a conversation. Cost: a turn itself is free but is\n a model call, so turns are limited per account per hour (429 rate_limited); a turn\n that starts a run reserves credits like find_hooks. Next step: on \"research\", call\n get_run with run.run_id and wait_seconds=50. Errors: 503 model_unavailable when the\n model is down (nothing charged, try again), 402 insufficient_credits. For direct\n research without the question step, call find_hooks instead. Needs the write\n permission, and research for a turn that starts a run (403 insufficient_scope, nothing\n reserved).",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"conversation_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Conversation Id"
},
"count": {
"anyOf": [
{
"maximum": 30,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "how many hooks a run this turn starts should deliver, 1 to 30; a size typed into the message (\"15 hooks\") wins over it, and it wins over the turn's own guess; null or omitted lets the turn decide. Fewer hooks is a faster, cheaper run",
"title": "Count"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional: only clips from creators in this country, as an assigned ISO 3166-1 alpha-2 code: MA, EG, BR, US (UK is read as GB). For a region that is not a country, send its country's code and name the regional variety in language: Quebec is country CA with language \"Quebec French\", Flanders BE with \"Flemish\", Catalonia ES with \"Catalan\". The country places the TikTok search there; the language judge does the regional filtering, and Instagram reports no country. A country alone does not restrict the language. For chat, omitted or null keeps the conversation's current setting; a value sets it for this and later turns; the empty string clears it back to any language / any country.",
"examples": [
"MA"
],
"pattern": "^[A-Za-z]{2}$",
"title": "Country"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "retry safely: a turn that started a run with this key within 24 hours answers that run again, no model call, nothing reserved",
"title": "Idempotency Key"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional, up to 60 characters: only clips spoken or written in this language or dialect, in words or as a tag: \"Moroccan Darija\", \"ar-MA\", \"Egyptian Arabic\", \"Brazilian Portuguese\". Any language works, including a regional variety (\"Quebec French\", \"Flemish\", \"Catalan\") and a mixed, code-switched one (\"Hinglish\", \"Taglish\", \"Moroccan Darija with French\"), or two joined by \"or\" (\"Tagalog or Taglish\"). The value is handed to the judges exactly as written; how well they honour a mixed or either-of value is not measured yet. Saying it inside topic works too; this field wins when both are given. For chat, omitted or null keeps the conversation's current setting; a value sets it for this and later turns; the empty string clears it back to any language / any country.",
"examples": [
"Moroccan Darija"
],
"maxLength": 60,
"title": "Language"
},
"message": {
"maxLength": 4000,
"minLength": 1,
"title": "Message",
"type": "string"
},
"platforms": {
"default": null,
"description": "since 2026-10-10: optional, which platforms to search and deliver from, a non-empty list of \"tiktok\", \"instagram\" and \"youtube\" (YouTube Shorts); left out (or all three) searches all three. [\"instagram\"] delivers Instagram reels only. Names are read without regard to case and a repeat counts once; an empty list or any other name is 422 naming platforms. The run echoes it as `platforms`.",
"examples": [
[
"instagram"
]
],
"items": {
"enum": [
"tiktok",
"instagram",
"youtube"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"title": "Platforms",
"type": [
"array",
"null"
],
"uniqueItems": true
},
"posted_within_days": {
"default": null,
"description": "since 2026-10-01: optional, how recent the clips must be, as days: 7, 30, 90, 365. The search asks the platforms for that window and the floor for a clip under 7 days old uses views per day (10,000 a day passes); null or left out means any time. A clip's `posted_at` and `age_days` say what the run found. For chat (the recency chip): omitted keeps the conversation's current setting; 7, 30, 90 or 365 sets it for this and later turns and wins over a recency phrase in the message; an explicit null on REST, or 0 on either door, clears it back to any time.",
"enum": [
7,
30,
90,
365,
0,
null
],
"title": "Posted Within Days",
"type": [
"integer",
"null"
]
},
"seed_hook_ids": {
"default": null,
"description": "since 2026-10-01: optional, up to 10 hook ids from your runs (a kept hook from GET /v1/keeps, or any hook you can read): \"find more like these\". The engine reads their lines, topics, creators and languages to steer the search phrases and the creators it expands; a seed is never delivered again. An id that is not one of your hooks is 422.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 10,
"title": "Seed Hook Ids",
"type": [
"array",
"null"
],
"uniqueItems": true
}
},
"required": [
"message"
],
"title": "chatArguments",
"type": "object"
},
"name": "chat"
},
{
"description": "The talking-head cleaner (15 credits), like 1of10's AutoCut: silences tightened, retakes, false starts, stutters and fillers cut with a reason on every cut, other microphones or cameras synced to the first, as Premiere XML, FCPXML and a CMX 3600 EDL. Takes 1 to 4 file_id values staged with POST /v1/clean/files (a chat cannot send the file itself). Runs as a job; get_call reads it. Same as POST /v1/clean.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"files": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Files"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
}
},
"title": "clean_recordingArguments",
"type": "object"
},
"name": "clean_recording"
},
{
"description": "Undo keep_hook: the hook goes back to having no verdict, so it leaves list_keeps and\n its export row carries none. Returns {\"hook_id\", \"verdict\": null}. Clearing a hook with\n no decision is the same success, so a retry is safe. Same as DELETE\n /v1/hooks/{hook_id}/decision. Free. Errors: 404 hook_not_found, 422 for an id that is\n not a UUID.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"hook_id": {
"title": "Hook Id",
"type": "string"
}
},
"required": [
"hook_id"
],
"title": "clear_decisionArguments",
"type": "object"
},
"name": "clear_decision"
},
{
"description": "Undo keep_find: the video goes back to having no verdict, on every find of it, and\n leaves list_kept_finds.\n Returns {\"find_id\", \"verdict\": null}. Clearing a find with no decision is the same\n success, so a retry is safe. Same as DELETE /v1/finds/{find_id}/decision. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"find_id": {
"title": "Find Id",
"type": "string"
}
},
"required": [
"find_id"
],
"title": "clear_find_decisionArguments",
"type": "object"
},
"name": "clear_find_decision"
},
{
"description": "Copy a public or shared tracker into a private one of yours. Same as POST\n /v1/trackers/{tracker_id}/clone.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Token"
},
"tracker_id": {
"title": "Tracker Id",
"type": "string"
}
},
"required": [
"tracker_id"
],
"title": "clone_trackerArguments",
"type": "object"
},
"name": "clone_tracker"
},
{
"description": "End your poll now: no more votes, the votes so far kept with its results. Free. Same as\n POST /v1/polls/{poll_id}/close.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"poll_id": {
"description": "the poll's id",
"title": "Poll Id",
"type": "string"
}
},
"required": [
"poll_id"
],
"title": "close_pollArguments",
"type": "object"
},
"name": "close_poll"
},
{
"description": "What a subject's audience asks and struggles with: the top comments of its outliers\n (videos that beat their own channel; or your video_ids, or a channel's best uploads),\n grouped into questions, pain points and requests. clusters: label, kind (question,\n pain_point, request, other), count (comments in the group, counted in code, never by the\n model), likes, videos, and quotes: two real comments found word for word, each with its\n link (url opens the comment). videos: what was read, with views, multiple (views over the\n channel's usual), comments_read and comments_off. basis says what the counts are from.\n Costs 3 credits, refunded when the read fails; a request naming nothing or two things is\n 422 and costs nothing. Takes about 60 to 100 seconds (measured 2026-10-26). Same as POST\n /v1/comments/insights. Read it back with get_call.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"channel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a YouTube @handle or channel link: its uploads that beat its usual views",
"title": "Channel"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "what the videos are about, 3 to 120 characters: its outliers are read. Send this, video_ids or channel",
"title": "Subject"
},
"video_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 8 YouTube video ids or links whose comments to read",
"title": "Video Ids"
}
},
"title": "comment_insightsArguments",
"type": "object"
},
"name": "comment_insights"
},
{
"description": "Owner only: make an access code to hand out. max_uses 1 to 100000 (default 1),\n expires_in_days 1 to 365 (optional), note your own. email binds it to one person: then\n only Google sign-in with that verified email redeems it, never the API or MCP; leave\n it out for a code that works on every door. The code is in this result only. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"expires_in_days": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Expires In Days"
},
"max_uses": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Uses"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Note"
}
},
"title": "create_access_codeArguments",
"type": "object"
},
"name": "create_access_code"
},
{
"description": "Create an account and get an API key with free credits. Needs a beta access code\n (access_code, HD-XXXX-XXXX; case and dashes do not matter): without one the error is\n 403 access_code_required, and a code that does not work is 403 invalid_access_code.\n Ask for a code with request_access, or at hookdetector.com/access. No key needed for\n this call. label is an optional note up to 120 characters.\n\n Keep the api_key it returns: it is the only copy. Send it as the header\n 'Authorization: Bearer hd_...' or pass it as api_key on every other tool. Signups,\n and wrong codes, are limited per address per hour. Next step: find_hooks.\n ",
"inputSchema": {
"properties": {
"access_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Access Code"
},
"label": {
"anyOf": [
{
"maxLength": 120,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Label"
}
},
"title": "create_accountArguments",
"type": "object"
},
"name": "create_account"
},
{
"description": "An agent that runs a Video Review on each new long upload of a tracker's channels,\n inside a monthly credit budget. Same as POST /v1/agents.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"monthly_budget": {
"maximum": 10000,
"minimum": 1,
"title": "Monthly Budget",
"type": "integer"
},
"name": {
"maxLength": 80,
"minLength": 1,
"title": "Name",
"type": "string"
},
"tracker_id": {
"title": "Tracker Id",
"type": "string"
}
},
"required": [
"tracker_id",
"name",
"monthly_budget"
],
"title": "create_agentArguments",
"type": "object"
},
"name": "create_agent"
},
{
"description": "Save a search checked daily or weekly; a new video at your line (default 3x its\n channel) is a hit, emailed, with a Monday digest. 1 credit a check. Same as\n POST /v1/alerts.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"email": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"frequency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "daily or weekly",
"title": "Frequency"
},
"min_multiple": {
"anyOf": [
{
"maximum": 1000,
"minimum": 1,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Multiple"
},
"min_vph": {
"anyOf": [
{
"exclusiveMinimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Vph"
},
"query": {
"maxLength": 200,
"minLength": 3,
"title": "Query",
"type": "string"
}
},
"required": [
"query"
],
"title": "create_alertArguments",
"type": "object"
},
"name": "create_alert"
},
{
"description": "Make a named folder on one tab to file hooks or finds in. The same name again on\n that tab (case and spaces aside) returns the folder already there with created false,\n so a retry never makes two. At most 200 folders an account (409\n folder_limit_reached). Returns the folder: folder_id, kind, name, item_count, cover,\n shared, share_url, created. Same as POST /v1/folders. Free. Next: save_to_folder.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional, up to 280 characters",
"title": "Description"
},
"kind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "the tab: \"short\" (Short form hooks), \"long\" (Long form finds) or \"packaging\" (Packaging finds)",
"title": "Kind"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 80 characters; the same name again on the tab is the folder already there",
"title": "Name"
},
"team": {
"default": false,
"description": "true: your team's folder, which every member sees and edits (404 not_in_team without a team)",
"title": "Team",
"type": "boolean"
}
},
"title": "create_folderArguments",
"type": "object"
},
"name": "create_folder"
},
{
"description": "Create another API key on your account, for example one per agent or machine, so\n you can revoke one without touching the others. name is up to 60 characters.\n\n Give the key only what it needs. scopes: any of \"read\" (read runs, hooks, keeps,\n usage), \"write\" (keep, reject, undo, chat), \"research\" (start runs, which spend\n credits), \"admin\" (manage keys, delete the account); all four when left out. An agent\n that finds hooks needs [\"read\", \"write\", \"research\"]. credit_limit: the most credits\n runs started with this key may spend over its life, 1 to 100000 (a run then reserves\n at most what is left). expires_in_days: 1 to 365; the key then stops working (401\n key_expired).\n\n The new key is in this result once and never again: store it now. Needs admin. An\n account holds at most 10 active keys (409 beyond) and may create 20 per hour by\n default (429 beyond). Free.\n Next step: use the returned api_key; revoke old ones with revoke_key.\n ",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"credit_limit": {
"default": null,
"minimum": 1,
"title": "Credit Limit",
"type": "integer"
},
"expires_in_days": {
"default": null,
"minimum": 1,
"title": "Expires In Days",
"type": "integer"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"scopes": {
"default": null,
"items": {
"enum": [
"read",
"write",
"research",
"admin"
],
"type": "string"
},
"minItems": 1,
"title": "Scopes",
"type": "array"
}
},
"title": "create_keyArguments",
"type": "object"
},
"name": "create_key"
},
{
"description": "Put 2 to 4 packages to Hook Detector's users, who pick the one they would click, blind.\n Closes at votes_wanted or after 7 days. 2 credits, given back when a picture cannot be\n stored. Results with get_poll. Same as POST /v1/polls.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"options": {
"description": "2 to 4 packages, each {title, thumbnail}: a title of 1 to 100 characters and a JPEG, PNG or WebP in base64 or an i.ytimg.com URL",
"items": {},
"title": "Options",
"type": "array"
},
"question": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "default: Which would you click?",
"title": "Question"
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "what the video is about",
"title": "Subject"
},
"votes_wanted": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "10 to 200, default 30",
"title": "Votes Wanted"
}
},
"required": [
"options"
],
"title": "create_pollArguments",
"type": "object"
},
"name": "create_poll"
},
{
"description": "Create a team this account owns, funding its pool from your balance with credits\n (402 when you hold less). Members' spending comes from the pool; you keep spending your\n own balance. 409 already_in_team. Needs admin. Free. Same as POST /v1/team.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"credits": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "credits to move from your balance into the team's pool now; 0 or left out moves none",
"title": "Credits"
},
"name": {
"description": "the team's name, 1 to 80 characters",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "create_teamArguments",
"type": "object"
},
"name": "create_team"
},
{
"description": "Make a tracker of up to 50 channels: hourly reads of their newest uploads, alerts when\n one reaches the multiple (default 3x its channel) or views per hour, in the app and by\n email. 1 credit a tracked channel a day. Same as POST /v1/trackers.",
"inputSchema": {
"properties": {
"alert_email": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Alert Email"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"channels": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "UC ids, @handles or addresses",
"title": "Channels"
},
"multiple_threshold": {
"anyOf": [
{
"maximum": 1000,
"minimum": 1,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Multiple Threshold"
},
"name": {
"maxLength": 80,
"minLength": 1,
"title": "Name",
"type": "string"
},
"team": {
"default": false,
"description": "true: your team's tracker, which every member sees and edits",
"title": "Team",
"type": "boolean"
},
"visibility": {
"default": "private",
"description": "private, shared or public",
"title": "Visibility",
"type": "string"
},
"vph_threshold": {
"anyOf": [
{
"exclusiveMinimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Vph Threshold"
}
},
"required": [
"name"
],
"title": "create_trackerArguments",
"type": "object"
},
"name": "create_tracker"
},
{
"description": "Post every new tracker alert and saved-search hit to your https URL, signed with the\n secret this returns once (X-HD-Signature). Same as POST /v1/webhooks.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"events": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "tracker.alert, search.hit",
"title": "Events"
},
"url": {
"description": "https, port 443, public host",
"maxLength": 500,
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "create_webhookArguments",
"type": "object"
},
"name": "create_webhook"
},
{
"description": "Your daily idea sets (turn them on per saved search or tracker with daily_ideas), each\n idea with the real finds behind it, none repeated within a week. Same as\n GET /v1/ideas/daily.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"days": {
"default": 7,
"maximum": 60,
"minimum": 1,
"title": "Days",
"type": "integer"
},
"source_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source Id"
}
},
"title": "daily_ideasArguments",
"type": "object"
},
"name": "daily_ideas"
},
{
"description": "Erase your account and everything in it, for good: every API key, run, hook, keep\n or reject decision, conversation and message. Unspent credits go with it. It cannot\n be undone.\n\n confirm must be exactly \"delete my account\", or nothing happens (422\n confirmation_required). Refused with 409 run_in_flight while a run is queued or\n running: wait for it with get_run first. Returns {\"deleted\": true, \"account_id\",\n \"erased\": {counts per kind}, \"message\"}. Every key of the account stops working at\n once; create_account starts a new one. Same as DELETE /v1/account. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"confirm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Confirm"
}
},
"title": "delete_accountArguments",
"type": "object"
},
"name": "delete_account"
},
{
"description": "Delete one of your agents. Same as DELETE /v1/agents/{agent_id}.",
"inputSchema": {
"properties": {
"agent_id": {
"title": "Agent Id",
"type": "string"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"required": [
"agent_id"
],
"title": "delete_agentArguments",
"type": "object"
},
"name": "delete_agent"
},
{
"description": "Delete a saved search. Same as DELETE /v1/alerts/{alert_id}.",
"inputSchema": {
"properties": {
"alert_id": {
"title": "Alert Id",
"type": "string"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"required": [
"alert_id"
],
"title": "delete_alertArguments",
"type": "object"
},
"name": "delete_alert"
},
{
"description": "Delete a folder, its items and its share link at once (the link stops working). The\n hooks and finds in it, and their keeps, stay. Returns {\"folder_id\", \"deleted\": true}.\n Same as DELETE /v1/folders/{folder_id}. Free. Errors: 404 folder_not_found.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"folder_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "one of your folders (from list_folders or create_folder)",
"title": "Folder Id"
}
},
"title": "delete_folderArguments",
"type": "object"
},
"name": "delete_folder"
},
{
"description": "Delete your poll, its votes and its pictures. Free. Same as DELETE /v1/polls/{poll_id}.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"poll_id": {
"description": "the poll's id",
"title": "Poll Id",
"type": "string"
}
},
"required": [
"poll_id"
],
"title": "delete_pollArguments",
"type": "object"
},
"name": "delete_poll"
},
{
"description": "Delete one of your presets. Same as DELETE /v1/presets/{preset_id}. Free. Errors:\n 404 preset_not_found.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"preset_id": {
"title": "Preset Id",
"type": "string"
}
},
"required": [
"preset_id"
],
"title": "delete_presetArguments",
"type": "object"
},
"name": "delete_preset"
},
{
"description": "Delete one of your trackers. Same as DELETE /v1/trackers/{tracker_id}.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"tracker_id": {
"title": "Tracker Id",
"type": "string"
}
},
"required": [
"tracker_id"
],
"title": "delete_trackerArguments",
"type": "object"
},
"name": "delete_tracker"
},
{
"description": "Delete one of your webhooks. Same as DELETE /v1/webhooks/{webhook_id}.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"webhook_id": {
"title": "Webhook Id",
"type": "string"
}
},
"required": [
"webhook_id"
],
"title": "delete_webhookArguments",
"type": "object"
},
"name": "delete_webhook"
},
{
"description": "Set the note on one item of a folder. Returns the item. Same as PATCH\n /v1/folders/{folder_id}/items/{item_id}. Free. Errors: 404 item_not_found.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"folder_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "one of your folders (from list_folders or create_folder)",
"title": "Folder Id"
},
"item_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "an item of that folder (from get_folder or save_to_folder)",
"title": "Item Id"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "the note, up to 1000 characters; \"\" or null clears it",
"title": "Note"
}
},
"title": "edit_folder_itemArguments",
"type": "object"
},
"name": "edit_folder_item"
},
{
"description": "Edit one thumbnail (an image of your thumbnails call, or a picture you send): op erase,\n edit, face_swap, text, text_variations, upscale, fix, crop or color. crop and color are\n free; upscale 12; the rest 4 (a version each for text_variations), charged only for what\n is delivered. Answers at once; read it with get_thumbnails. Same as POST /v1/thumbnails/edit.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"brightness": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Brightness"
},
"contrast": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Contrast"
},
"faces": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Faces"
},
"fixes": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Fixes"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"op": {
"title": "Op",
"type": "string"
},
"prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Prompt"
},
"region": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Region"
},
"saturation": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Saturation"
},
"score_call_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Score Call Id"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source"
},
"source_call_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source Call Id"
},
"source_n": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Source N"
},
"variations": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Variations"
},
"words": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Words"
}
},
"required": [
"op"
],
"title": "edit_thumbnailArguments",
"type": "object"
},
"name": "edit_thumbnail"
},
{
"description": "Official TikTok or Instagram embed HTML for a hook, so the clip plays inside your\n own page. kind is \"embed\", or \"fallback\" when the creator disabled embedding or the\n clip is a photo post found before 2026-09-26 (then show thumbnail, which falls back to\n the hook's still_url, and the transcript). For a plain vertical iframe use the hook's\n player_url instead. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"hook_id": {
"title": "Hook Id",
"type": "string"
}
},
"required": [
"hook_id"
],
"title": "embed_hookArguments",
"type": "object"
},
"name": "embed_hook"
},
{
"description": "A finished run's hooks as a file a creator can open: format \"csv\" (default; one row\n per hook, opens in any spreadsheet, formula-like cells defused with a leading quote),\n \"json\" (the full hook objects) or \"md\" (Markdown notes, one section per hook).\n\n Returns {\"filename\", \"content_type\", \"format\", \"content\"}, where content is the whole\n file as text: write it to filename. The same bytes as GET\n /v1/runs/{run_id}/export?format=... . Free.\n Errors: 404 run_not_found, 409 run_not_finished while the run is queued or running\n (call get_run with wait_seconds=50 first), 422 invalid_request for another format.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"format": {
"default": "csv",
"title": "Format",
"type": "string"
},
"run_id": {
"title": "Run Id",
"type": "string"
}
},
"required": [
"run_id"
],
"title": "export_runArguments",
"type": "object"
},
"name": "export_run"
},
{
"description": "Start hook research on a topic across TikTok, Instagram and YouTube Shorts (Shorts\n only, never long-form YouTube; platform \"youtube\"). platforms (since 2026-10-10, any of\n \"tiktok\", \"instagram\", \"youtube\"; all three when left out) searches and delivers only\n those: [\"instagram\"] is Instagram reels only.\n\n What it does: searches both platforms, reads what each clip says and shows, and\n returns ranked hooks. Each hook has its verbatim opening line, most quotable line,\n main idea, why it travelled, topic, on-screen text, full transcript, a watch link and\n a vertical player_url (9:16 iframe).\n\n Talking heads only (since 2026-09-29): `hooks` holds only clips where a person on\n camera is talking (talking head, podcast, interview). A clip where nobody talks is\n dropped; Bonus was removed on 2026-10-08 and `bonus` is always []. Every hook carries\n format (talking_head, podcast, interview, stage; null on older hooks) and section\n (always \"main\"). A run that finds fewer talking heads than count says so in outcome;\n it never fills hooks with clips that do not talk.\n\n Where it comes from (since 2026-09-30): every hook has creator_country (ISO alpha-2\n of the creator's TikTok account; always null on Instagram, which states none), place\n (the place the creator tagged, or null) and place_country (that place's country when\n the platform states it). Never guessed.\n\n Banner (since 2026-09-30): every hook has banner, the title-style text the creator\n placed on the video to hook the viewer, verbatim (at most 200 characters), or null\n when it has none; subtitles are never a banner. onscreen_text keeps all text read.\n\n Match (since 2026-09-30, runs with a language or country): every hook has match,\n \"exact\" when the clip is about the subject itself or \"close\" when it is about a\n neighbouring subject with the same intent (a close match, delivered after every exact\n match; label it as one); null on runs with no language or country and on older hooks.\n\n Analysis (since 2026-10-02): every hook carries hook_type (curiosity_gap,\n contrarian_claim, specific_number, identity_callout, stakes_threat, promise_payoff,\n pattern_interrupt, story_open, question, direct_command, other with hook_type_other),\n mechanism (why the opening stops the scroll, quoting the clip; why_it_travelled holds\n the same text), visual_hook, audience, template and steal_it; null on older hooks.\n\n Virality v2 (since 2026-10-01): the deck is ranked by virality (0 to 1, since\n 2026-10-02 on one fixed scale, the same clip scoring the same in every run), built from outlier (views over the creator's usual views per video,\n creator_median_views, with outlier_basis saying how it was measured), freshness\n (posted_at, age_days, views_per_day), travel (shares and saves per 1,000 views),\n own_sound and sound_reuse, and a paid penalty; virality_why names the strongest\n signal in one line. Every hook also carries duration_s and hashtags. Null on older\n hooks. posted_within_days (7, 30, 90 or 365) keeps the search to recent clips (a clip\n under 7 days old passes the floor at 10,000 views a day). seed_hook_ids (up to 10 of\n your hooks, for example kept ones) means \"find more like these\": their lines, topics,\n creators and languages steer the search, and a seed is never delivered again. A done\n run carries patterns: up to 3 hook structures winning in the deck (name, template,\n why, hook_ids, count), computed after delivery; null until then. remix_hook writes\n lines from one hook's structure for your niche (1 credit).\n\n Arguments: topic is 3 to 500 characters, count 1 to 30 (default 10). Instructions\n inside the topic are fine: only the subject read out of it is searched. reuse=true\n (default) starts from clips you already paid for on the same topic, so a rerun is\n close to free and often finishes in seconds. idempotency_key: any string up to 255\n characters; the same key within 24 hours returns the first run instead of starting\n and paying for a second one, so always pass one and reuse it when you retry.\n wait_seconds 0 to 50: 0 returns the run_id at once; above 0 waits for the run and\n returns the run object, as get_run does.\n\n Any language, dialect or country: language is optional free text up to 60 characters\n naming the language or dialect every clip must be in (\"Moroccan Darija\", \"ar-MA\",\n \"Egyptian Arabic\", \"Brazilian Portuguese\"); country is an optional ISO 3166-1 alpha-2\n code for where the creators are (MA, EG, BR). Saying it inside topic works too; these\n fields win when both are given. A country alone does not restrict the language. Each\n hook reports the language it was judged to be in.\n\n A region that is not a country: send its country's code and name the regional variety\n in language (Quebec: country \"CA\", language \"Quebec French\"; Flanders: \"BE\" and\n \"Flemish\"; Catalonia: \"ES\" and \"Catalan\"). The country places the TikTok search there\n and the language judge does the regional filtering; Instagram reports no country.\n language may name a mixed, code-switched variety (\"Hinglish\", \"Taglish\", \"Moroccan\n Darija with French\") or two joined by \"or\" (\"Tagalog or Taglish\"); it reaches the\n judges exactly as written, and how well they honour such a value is not measured yet.\n\n Cost: reserves up to 200 credits up front (less if your balance is smaller, down to\n 40) and charges only what it used; the rest is refunded. A failed run costs nothing,\n and so does a run that finds no hooks, within a per-account allowance (llms.txt has\n the numbers; its outcome says which applied).\n\n Timing and next step: a fresh run takes about 2 to 3 minutes, up to about 5 when the\n language is a dialect. Call get_run with wait_seconds=50 repeatedly until status is\n \"done\" or \"failed\", which is usually 3 or 4 calls (up to 6 on a dialect request). Watch progress.stage and progress.message meanwhile.\n\n Needs a key with the research permission (403 insufficient_scope otherwise). A key\n with a credit_limit reserves at most what is left of it; under the minimum it is 403\n key_credit_limit_reached and nothing is reserved.\n ",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"conversation_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "attach the run to one of your conversations",
"title": "Conversation Id"
},
"count": {
"default": 10,
"description": "how many hooks to deliver, 1 to 30",
"maximum": 30,
"minimum": 1,
"title": "Count",
"type": "integer"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional: only clips from creators in this country, as an assigned ISO 3166-1 alpha-2 code: MA, EG, BR, US (UK is read as GB). For a region that is not a country, send its country's code and name the regional variety in language: Quebec is country CA with language \"Quebec French\", Flanders BE with \"Flemish\", Catalonia ES with \"Catalan\". The country places the TikTok search there; the language judge does the regional filtering, and Instagram reports no country. A country alone does not restrict the language.",
"examples": [
"MA"
],
"pattern": "^[A-Za-z]{2}$",
"title": "Country"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key within 24 hours returns the first run instead of paying for a second",
"title": "Idempotency Key"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional, up to 60 characters: only clips spoken or written in this language or dialect, in words or as a tag: \"Moroccan Darija\", \"ar-MA\", \"Egyptian Arabic\", \"Brazilian Portuguese\". Any language works, including a regional variety (\"Quebec French\", \"Flemish\", \"Catalan\") and a mixed, code-switched one (\"Hinglish\", \"Taglish\", \"Moroccan Darija with French\"), or two joined by \"or\" (\"Tagalog or Taglish\"). The value is handed to the judges exactly as written; how well they honour a mixed or either-of value is not measured yet. Saying it inside topic works too; this field wins when both are given.",
"examples": [
"Moroccan Darija"
],
"maxLength": 60,
"title": "Language"
},
"platforms": {
"default": null,
"description": "since 2026-10-10: optional, which platforms to search and deliver from, a non-empty list of \"tiktok\", \"instagram\" and \"youtube\" (YouTube Shorts); left out (or all three) searches all three. [\"instagram\"] delivers Instagram reels only. Names are read without regard to case and a repeat counts once; an empty list or any other name is 422 naming platforms. The run echoes it as `platforms`.",
"examples": [
[
"instagram"
]
],
"items": {
"enum": [
"tiktok",
"instagram",
"youtube"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"title": "Platforms",
"type": [
"array",
"null"
],
"uniqueItems": true
},
"posted_within_days": {
"default": null,
"description": "since 2026-10-01: optional, how recent the clips must be, as days: 7, 30, 90, 365. The search asks the platforms for that window and the floor for a clip under 7 days old uses views per day (10,000 a day passes); null or left out means any time. A clip's `posted_at` and `age_days` say what the run found.",
"enum": [
7,
30,
90,
365,
null
],
"examples": [
30
],
"title": "Posted Within Days",
"type": [
"integer",
"null"
]
},
"reuse": {
"default": true,
"description": "start from clips you already paid for",
"title": "Reuse",
"type": "boolean"
},
"seed_hook_ids": {
"default": null,
"description": "since 2026-10-01: optional, up to 10 hook ids from your runs (a kept hook from GET /v1/keeps, or any hook you can read): \"find more like these\". The engine reads their lines, topics, creators and languages to steer the search phrases and the creators it expands; a seed is never delivered again. An id that is not one of your hooks is 422.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 10,
"title": "Seed Hook Ids",
"type": [
"array",
"null"
],
"uniqueItems": true
},
"topic": {
"description": "what the clips are about, 3 to 500 characters. Instructions inside it are fine: a long topic, or one with a language or country, is searched by the subject read out of it, never verbatim.",
"examples": [
"short term rental tax strategy"
],
"maxLength": 500,
"minLength": 3,
"title": "Topic",
"type": "string"
},
"wait_seconds": {
"default": 0,
"description": "0 to 50: seconds to wait for the run to finish; 0 returns at once",
"maximum": 50,
"minimum": 0,
"title": "Wait Seconds",
"type": "integer"
}
},
"required": [
"topic"
],
"title": "find_hooksArguments",
"type": "object"
},
"name": "find_hooks"
},
{
"description": "Find long-form hooks: how the YouTube videos that beat their own channel open, on a\n topic. Long-form YouTube only, never Shorts, TikTok or Instagram (for those: find_hooks).\n\n What it does: searches YouTube for long-form videos on the topic, keeps only the\n outliers (a video whose views are at least min_outlier times the median views of its\n own channel's recent uploads; 2 by default) posted in 2023 or later (nothing older is\n ever delivered), reads the first intro_seconds (60 by default) of each one's\n transcript, and says why that opening holds a viewer.\n\n What comes back: the run's `finds`, ranked, strongest outlier first. Each has title,\n channel, watch_url, player_url (an iframe src), thumbnail_url, views,\n channel_median_views, outlier (28.2 means 28 times the channel's usual), outlier_score\n (0 to 100 on one fixed scale: nothing else a run found moves it, so finds from\n different runs rank together), outlier_tier, channel_size, likes_per_1k, posted_at,\n duration_s, and the opening: intro (the first minute as it was said: lines of n, t in\n seconds, text) and intro_text, always whole; and inside it the hook (verbatim: the lines\n the analysis marks as the hook, ending on a sentence end, at most 25 seconds and 60\n words, with hook_words, hook_start_s and hook_end_s, a sponsor read or greeting at the\n front left out; hook_seconds is hook_end_s). auto_captions says the opening has almost\n no punctuation. about_subject is yes or partly: a video the model judges not to be\n about the subject is dropped. The analysis: hook_type (the same list as find_hooks),\n mechanism (why it holds, quoting the opening word for word), promise, open_loop,\n title_link (how the first lines pay off the title), beats (the opening in parts: from,\n to, beat, does),\n opens_with (cold_open, greeting, teaser, question, sponsor), format (the kind of\n video), angle, template (the hook as a fill-in structure), steal_it and audience. When\n the topic asks for a kind of opening (\"question hooks\", \"storytime\"), style_match says\n whether each find is that kind and the matches come first. analysed is false\n when the model could not analyse an opening: the opening is still real, its analysis\n fields are null. The run's report.patterns lists the opening types at least two finds\n share; report.shape says how the openings are built, counted from the finds\n (hook_seconds, how long the hook runs, and hook_words as medians, beats with how many\n openings use each and the second it usually starts_at, and the sequence of beats most\n of them share); and\n report.openers holds up to `openers` (3 by default, 0 for none) openings WRITTEN for\n your topic from those structures (hook, then, hook_type, based_on). report.openers_label\n is always \"Written by Hook Detector from the structure of these real openings\": show\n it with them, never present one as a real video's opening. report.landscape is the\n subject at a glance, counted from the videos the run held against their own channel\n (videos, channels, outliers and their share, breakouts, small_channel_outliers,\n recent_outliers). The run's hooks and bonus are always empty.\n\n A link instead of a subject: when topic is a channel's YouTube address\n (https://www.youtube.com/@name, or just @name) the run returns that channel's OWN\n outliers, its recent long-form uploads that beat its usual (one provider call, no\n search); when it is a long-form video's address the run returns that one video,\n whatever its multiple (requested is 1). options.link says \"channel\" or \"video\". No\n openings are written for a link (use remix_find on a find to write for your niche).\n A Short's address is refused with 422.\n\n Arguments: topic 3 to 500 characters; count 1 to 30 (default 8); language and country\n optional; posted_within_days 30, 90, 365 or 730 to narrow the 2023 floor further;\n channel_size \"small\", \"medium\" or \"large\" to keep only channels of that size (by what\n their uploads usually get), so a small creator sees breakouts from channels their own\n size; reuse=true (default) starts from the videos your last long or packaging run on\n this topic bought within a week, and a video you already had read is delivered from\n that read (analysis_from_earlier_read) at no model or provider cost. seen_before says\n an earlier run of yours already found the video. idempotency_key: always pass one and\n reuse it on a retry. wait_seconds 0 to 50: 0 returns the run_id at once; above 0 waits\n and returns the run. Starts are limited per account per hour (429 rate_limited).\n\n Cost: reserves up to 90 credits for 20 videos or fewer and 5 more for each video above\n that (140 at 30; less on a smaller balance, down to 25) and charges\n only the provider calls it made: the searches, one call per channel measured, one per\n transcript read. A failed run costs nothing, and so does a run that\n finds nothing, inside the same allowance a hook run has (the outcome says so).\n\n Timing and next step: how long a run takes has not been measured yet, so never assume\n a time. Call get_run with wait_seconds=50 until status is done or failed;\n progress.items holds the finds written so far as cards\n and progress.scan the videos it is looking at while it runs. Then keep_find, export_run. Same as POST /v1/longform. Needs the research\n permission (403 insufficient_scope otherwise).",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"channel_size": {
"default": null,
"description": "optional: only videos from channels of this size, by what the channel's uploads usually get (its median views, the figure the outlier is measured against): small (under 20,000), medium (up to 200,000) or large. Null or left out: any size",
"enum": [
"small",
"medium",
"large",
null
],
"examples": [
"small"
],
"title": "Channel Size",
"type": [
"string",
"null"
]
},
"count": {
"default": 8,
"description": "how many long-form hooks to deliver, 1 to 30",
"maximum": 30,
"minimum": 1,
"title": "Count",
"type": "integer"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional, an assigned ISO 3166-1 alpha-2 code (US, GB, MA): searches YouTube as seen from this country. It steers the search; it does not filter the channels",
"examples": [
"US"
],
"pattern": "^[A-Za-z]{2}$",
"title": "Country"
},
"filters": {
"default": null,
"description": "optional bounds, every one optional: min_multiple and max_multiple (views over the channel's median, 1 to 1000), min_views, max_views, min_channel_median, max_channel_median, min_duration_s, max_duration_s; on the Library (and a library preset) also min_comments, max_comments, posted_within_days (7, 30, 90, 365, 730) and language. No delivered find falls outside one; a min_multiple above the bar raises it",
"examples": [
{
"max_views": 2000000,
"min_multiple": 5
}
],
"title": "Filters",
"type": [
"object",
"null"
]
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key within 24 hours returns the first run instead of paying for a second",
"title": "Idempotency Key"
},
"intro_seconds": {
"default": null,
"description": "optional, 20 to 120 (default 60): how many seconds of each video's opening to read and return",
"examples": [
60
],
"maximum": 120,
"minimum": 20,
"title": "Intro Seconds",
"type": [
"integer",
"null"
]
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional, up to 60 characters: the language the videos should be spoken in, in words or as a tag (\"Spanish\", \"pt-BR\"). Left out, it is read from the topic's own language",
"examples": [
"Spanish"
],
"maxLength": 60,
"title": "Language"
},
"min_outlier": {
"default": null,
"description": "optional, 1.5 to 100 (default 2): how many times its own channel's usual views a video must have to count as an outlier. Only outliers are ever delivered",
"examples": [
3
],
"maximum": 100,
"minimum": 1.5,
"title": "Min Outlier",
"type": [
"number",
"null"
]
},
"openers": {
"default": null,
"description": "optional, 0 to 6 (default 3): how many openings to write for the subject from the structure of the real ones; 0 for none",
"examples": [
3
],
"maximum": 6,
"minimum": 0,
"title": "Openers",
"type": [
"integer",
"null"
]
},
"posted_within_days": {
"default": null,
"description": "optional, how recent the videos must be, as days: 30, 90, 365, 730. Null or left out means everything since 2023-01-01; nothing older is ever delivered",
"enum": [
30,
90,
365,
730,
null
],
"examples": [
365
],
"title": "Posted Within Days",
"type": [
"integer",
"null"
]
},
"preset_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional: start from a saved preset of this tab (save_preset); filters sent with it win over the preset's",
"title": "Preset Id"
},
"reuse": {
"default": true,
"description": "start from the videos your last long or packaging run on this topic already bought (within a week), so the second tab on a topic costs little",
"title": "Reuse",
"type": "boolean"
},
"topic": {
"description": "the subject to research, 3 to 500 characters, in any language. Or a YouTube address instead of a subject: a channel's (https://www.youtube.com/@name, or just @name) returns that channel's own outliers, its recent long-form uploads that beat its usual; a long-form video's (https://www.youtube.com/watch?v=...) returns that one video, whatever its multiple. A Short's address is refused (422)",
"examples": [
"home espresso",
"https://www.youtube.com/@name"
],
"maxLength": 500,
"minLength": 3,
"title": "Topic",
"type": "string"
},
"wait_seconds": {
"default": 0,
"description": "0 to 50: seconds to wait for the run to finish; 0 returns at once",
"maximum": 50,
"minimum": 0,
"title": "Wait Seconds",
"type": "integer"
}
},
"required": [
"topic"
],
"title": "find_long_hooksArguments",
"type": "object"
},
"name": "find_long_hooks"
},
{
"description": "Find packaging: the titles and thumbnails that earned the click on a topic, from\n long-form YouTube videos that beat their own channel.\n\n What it does: runs the same outlier search as find_long_hooks (long-form YouTube,\n 2023 or later, views at least min_outlier times the channel's usual), then looks at\n each video's thumbnail beside its title and says what the pair is doing.\n\n What comes back: the run's `finds`, ranked. Each is a real package, as YouTube shows\n it: title (verbatim) and thumbnail_url (the size YouTube really served, the picture\n the analysis looked at; thumbnail_checked says so), channel, watch_url, views,\n channel_median_views, outlier, outlier_score (0 to 100 on one fixed scale, so finds\n from different runs rank together), outlier_tier, channel_size and posted_at, plus the analysis: title_device (curiosity_gap, contrarian_claim,\n specific_number, how_to, listicle, challenge, story, question, warning, comparison,\n authority, timeliness, identity_callout, other), title_template (the title as a\n fill-in structure), thumbnail_text (the words printed on the thumbnail, read by a vision\n model; null when none), thumbnail_text_role (repeats_title, adds_to_title,\n contrasts_title, no_text; counted from title_overlap, the share of the thumbnail's words\n that are also in the title, where that can be), thumbnail_subject, thumbnail_faces,\n thumbnail_emotion,\n thumbnail_colors, thumbnail_composition, thumbnail_devices, angle, gap (what the picture shows that the title does not say, and the\n question that leaves), promise, steal_it and audience, visible_action (the single thing\n happening in the picture), title_carries and picture_adds (what only the title says,\n what only the picture adds), text_box, and thumb_metrics (measured in code from the\n pixels: palette, brightness, contrast, saturation, busyness, the biggest words' height\n at 210 px wide and whether the length corner is clear), plus cut_on_phone (the title is\n longer than 60 characters, where a phone roughly cuts it; approximate) and on_subject\n (yes or partly: whether the look judged the package to be about your topic; a package\n judged not to be is dropped and the next one takes its slot; null on a link run). analysed\n is false when a package could not be looked at (its look is asked twice, and the next\n candidate takes the slot if it fails twice); it is still a real package.\n\n The run's report then holds title_patterns and thumbnail_patterns (what at least two\n of the packages share, each naming their video_ids) and ideas: up to `ideas` (6 by\n default, 0 for none) packages WRITTEN for your topic from those patterns, each a title\n a thumbnail concept and thumbnail_text (the words to print on it), naming the real\n packages it is based_on. report.ideas_label is always \"Written by Hook Detector from\n the patterns in these real packages\": show it with them, never present an idea as a\n real video's title; an idea over 70 characters, with more than 5 words for its\n thumbnail or repeating a real title is dropped. report.numbers counts the packages:\n title_chars and title_words\n (medians), titles_with_number, titles_with_question, titles_cut_on_phone (with\n phone_title_chars, the approximate length a phone cuts a title at), thumbnails_with_text\n and thumbnail_words (over the analysed ones), and the title_devices, thumbnail_devices and\n emotions that repeat (name, count); age_cohorts repeats the counts for packages posted in\n the last split_days days (recent) and for older ones, with the undated apart.\n report.landscape is the subject at a glance, as on find_long_hooks.\n\n Arguments: topic 3 to 500 characters, or a channel's or a long-form video's YouTube\n address exactly as on find_long_hooks (a channel's own outliers, or that one video; no\n ideas are written for a link, use remix_find); count 1 to 30 (default 12); language,\n country, min_outlier, posted_within_days, channel_size and reuse as on\n find_long_hooks; idempotency_key and wait_seconds as on find_hooks; content_type\n \"short\" finds the packages of YouTube Shorts instead of long-form videos (\"long\", the\n default), each Short measured against its own channel's Shorts. Every find carries\n multiple (views over the channel's median, the number 1of10 and vidIQ show),\n multiple_band (10x, 5x, 2x, under 2x) and content_type.\n\n Cost: reserves up to 70 credits for 24 packages or fewer and 3 more for each package\n above that (88 at 30; down to 25) and charges only the provider calls it\n made: the searches, one call per channel measured, and one for each video whose date\n had to be read exactly. Looking at a thumbnail costs no credit. After a find_long_hooks run on the same topic it is close\n to free. A failed run costs nothing, and so does a run that finds nothing, inside the\n allowance.\n\n Timing and next step: how long a run takes has not been measured yet, so never assume\n a time. Call get_run with wait_seconds=50 until status is done or failed;\n progress.items holds the packages looked at so far as cards and progress.scan the videos\n it is looking at while it runs. Same as POST /v1/packaging. Needs the research\n permission.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"channel_size": {
"default": null,
"description": "optional: only videos from channels of this size, by what the channel's uploads usually get (its median views, the figure the outlier is measured against): small (under 20,000), medium (up to 200,000) or large. Null or left out: any size",
"enum": [
"small",
"medium",
"large",
null
],
"examples": [
"small"
],
"title": "Channel Size",
"type": [
"string",
"null"
]
},
"content_type": {
"default": null,
"description": "optional: \"long\" (long-form videos, the default) or \"short\" (YouTube Shorts): the kind of video whose packages to find. A Short is measured against its own channel's Shorts",
"enum": [
"long",
"short",
null
],
"examples": [
"short"
],
"title": "Content Type",
"type": [
"string",
"null"
]
},
"count": {
"default": 12,
"description": "how many packages to deliver, 1 to 30",
"maximum": 30,
"minimum": 1,
"title": "Count",
"type": "integer"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional, an assigned ISO 3166-1 alpha-2 code (US, GB, MA): searches YouTube as seen from this country. It steers the search; it does not filter the channels",
"examples": [
"US"
],
"pattern": "^[A-Za-z]{2}$",
"title": "Country"
},
"filters": {
"default": null,
"description": "optional bounds, every one optional: min_multiple and max_multiple (views over the channel's median, 1 to 1000), min_views, max_views, min_channel_median, max_channel_median, min_duration_s, max_duration_s; on the Library (and a library preset) also min_comments, max_comments, posted_within_days (7, 30, 90, 365, 730) and language. No delivered find falls outside one; a min_multiple above the bar raises it",
"examples": [
{
"max_views": 2000000,
"min_multiple": 5
}
],
"title": "Filters",
"type": [
"object",
"null"
]
},
"ideas": {
"default": null,
"description": "optional, 0 to 10 (default 6): how many written packages (a title and a thumbnail concept) to add for the subject; 0 for none",
"examples": [
6
],
"maximum": 10,
"minimum": 0,
"title": "Ideas",
"type": [
"integer",
"null"
]
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key within 24 hours returns the first run instead of paying for a second",
"title": "Idempotency Key"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional, up to 60 characters: the language the videos should be spoken in, in words or as a tag (\"Spanish\", \"pt-BR\"). Left out, it is read from the topic's own language",
"examples": [
"Spanish"
],
"maxLength": 60,
"title": "Language"
},
"min_outlier": {
"default": null,
"description": "optional, 1.5 to 100 (default 2): how many times its own channel's usual views a video must have to count as an outlier. Only outliers are ever delivered",
"examples": [
3
],
"maximum": 100,
"minimum": 1.5,
"title": "Min Outlier",
"type": [
"number",
"null"
]
},
"posted_within_days": {
"default": null,
"description": "optional, how recent the videos must be, as days: 30, 90, 365, 730. Null or left out means everything since 2023-01-01; nothing older is ever delivered",
"enum": [
30,
90,
365,
730,
null
],
"examples": [
365
],
"title": "Posted Within Days",
"type": [
"integer",
"null"
]
},
"preset_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional: start from a saved preset of this tab (save_preset); filters sent with it win over the preset's",
"title": "Preset Id"
},
"reuse": {
"default": true,
"description": "start from the videos your last long or packaging run on this topic already bought (within a week), so the second tab on a topic costs little",
"title": "Reuse",
"type": "boolean"
},
"topic": {
"description": "the subject to research, 3 to 500 characters, in any language. Or a YouTube address instead of a subject: a channel's (https://www.youtube.com/@name, or just @name) returns that channel's own outliers, its recent long-form uploads that beat its usual; a long-form video's (https://www.youtube.com/watch?v=...) returns that one video, whatever its multiple. A Short's address is refused (422)",
"examples": [
"home espresso",
"https://www.youtube.com/@name"
],
"maxLength": 500,
"minLength": 3,
"title": "Topic",
"type": "string"
},
"wait_seconds": {
"default": 0,
"description": "0 to 50: seconds to wait for the run to finish; 0 returns at once",
"maximum": 50,
"minimum": 0,
"title": "Wait Seconds",
"type": "integer"
}
},
"required": [
"topic"
],
"title": "find_packagingArguments",
"type": "object"
},
"name": "find_packaging"
},
{
"description": "The videos in the shared index nearest one of your finds (find_id from a Packaging or\n Long form run), nearest first, never the find's own video. Each has distance (0 is the\n same; measures says how it is computed), its numbers and its multiple over its\n channel's median. A find not indexed yet is matched by its own words (matched_from).\n Free. Same as GET /v1/finds/{find_id}/similar. Errors: 404 find_not_found.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"content_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "long or short",
"title": "Content Type"
},
"find_id": {
"title": "Find Id",
"type": "string"
},
"limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 50 (default 12)",
"title": "Limit"
},
"min_multiple": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Multiple"
},
"posted_within_days": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "30, 90, 365 or 730",
"title": "Posted Within Days"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "video (default): by the title's meaning on any channel; title: on other channels; thumbnail: by our read of the picture on other channels",
"title": "Type"
}
},
"required": [
"find_id"
],
"title": "find_similarArguments",
"type": "object"
},
"name": "find_similar"
},
{
"description": "Who sponsors the channels on a subject: in the descriptions of its outliers, sponsor\n lines, promo codes and offer links found in code, plus Scrape Creators' sponsor read of\n videos YouTube marks as paid promotion, each named by one model read and kept only when\n the brand's name is in its own line. sponsors: brand, kind (sponsor, affiliate, other),\n channel_count and video_count (counted in code), channels, and videos with the evidence\n line as written, the code and the link. Costs 1 credit, refunded when the read fails.\n Same as POST /v1/sponsors. Read it back with get_call.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "3 to 120 characters",
"title": "Subject"
}
},
"title": "find_sponsorsArguments",
"type": "object"
},
"name": "find_sponsors"
},
{
"description": "One title format's videos, strongest first. Free. Same as GET /v1/formats/{format_id}.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"format_id": {
"title": "Format Id",
"type": "string"
},
"limit": {
"default": 50,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
"required": [
"format_id"
],
"title": "format_videosArguments",
"type": "object"
},
"name": "format_videos"
},
{
"description": "One agent and its reviews (done, skipped or failed, and why). Same as\n GET /v1/agents/{agent_id}.",
"inputSchema": {
"properties": {
"agent_id": {
"title": "Agent Id",
"type": "string"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"required": [
"agent_id"
],
"title": "get_agentArguments",
"type": "object"
},
"name": "get_agent"
},
{
"description": "One saved search and its hits. Same as GET /v1/alerts/{alert_id}.",
"inputSchema": {
"properties": {
"alert_id": {
"title": "Alert Id",
"type": "string"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"required": [
"alert_id"
],
"title": "get_alertArguments",
"type": "object"
},
"name": "get_alert"
},
{
"description": "One call of a priced tool (titles and the tools after it): tool, credits, charged,\n status (pending, done, failed), request and result. Same as GET /v1/calls/{call_id}.\n Free. Errors: 404 call_not_found.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"call_id": {
"title": "Call Id",
"type": "string"
}
},
"required": [
"call_id"
],
"title": "get_callArguments",
"type": "object"
},
"name": "get_call"
},
{
"description": "A channel page: subscribers and totals, every recent long upload scored against the\n channel itself (outliers at 2x its median and over), and its momentum. Free. Same as\n GET /v1/channels/{ref}.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"fresh": {
"default": false,
"title": "Fresh",
"type": "boolean"
},
"ref": {
"description": "a UC id, @handle or channel address",
"title": "Ref",
"type": "string"
}
},
"required": [
"ref"
],
"title": "get_channelArguments",
"type": "object"
},
"name": "get_channel"
},
{
"description": "One chat conversation: its newest messages in order (role, content, run_id,\n created_at), a page of `limit`, with earlier_cursor for the older ones (null when the\n page reaches the first message), and the runs those messages hold, with their hooks,\n plus nullable language and country search picker settings. Same shape as GET\n /v1/conversations/{conversation_id}. Free. Errors: 404 conversation_not_found, 422 for\n an id that is not a UUID or a cursor this API did not issue.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"before": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "earlier_cursor from the previous page; leave out for the newest messages",
"title": "Before"
},
"conversation_id": {
"title": "Conversation Id",
"type": "string"
},
"limit": {
"default": 100,
"description": "messages per page, newest page first",
"maximum": 500,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
"required": [
"conversation_id"
],
"title": "get_conversationArguments",
"type": "object"
},
"name": "get_conversation"
},
{
"description": "One result of a long or packaging run with every field: the video, its numbers and\n the opening or the package analysis. find_id comes from a run's finds (get_run) or from\n list_kept_finds. Same shape as GET /v1/finds/{find_id}. Free. Errors: 404\n find_not_found, 422 for an id that is not a UUID.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"find_id": {
"title": "Find Id",
"type": "string"
}
},
"required": [
"find_id"
],
"title": "get_findArguments",
"type": "object"
},
"name": "get_find"
},
{
"description": "One of your folders and its items, newest filed first, limit 1 to 100 a page (page\n with next_cursor). Each item has item_id, note, thumbnail_url, title and the full hook\n or find object. Same as GET /v1/folders/{folder_id}. Free. Errors: 404\n folder_not_found.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cursor"
},
"folder_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "one of your folders (from list_folders or create_folder)",
"title": "Folder Id"
},
"limit": {
"default": 100,
"description": "page size, 1 to 100",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
"title": "get_folderArguments",
"type": "object"
},
"name": "get_folder"
},
{
"description": "One hook with every field: its opening line, transcript, watch_url and the\n vertical player_url (null only for an unusable id or a photo post found before\n 2026-09-26; runs deliver single videos only). hook_id comes from get_run. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"hook_id": {
"title": "Hook Id",
"type": "string"
}
},
"required": [
"hook_id"
],
"title": "get_hookArguments",
"type": "object"
},
"name": "get_hook"
},
{
"description": "One background job of this account. Same as GET /v1/jobs/{job_id}. Errors: 404\n job_not_found for another account's job or an unknown id.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"job_id": {
"title": "Job Id",
"type": "string"
}
},
"required": [
"job_id"
],
"title": "get_jobArguments",
"type": "object"
},
"name": "get_job"
},
{
"description": "An Optimize call: the original's score and every new package so far. Same as GET\n /v1/optimize/{call_id}. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"call_id": {
"title": "Call Id",
"type": "string"
}
},
"required": [
"call_id"
],
"title": "get_optimizeArguments",
"type": "object"
},
"name": "get_optimize"
},
{
"description": "One poll: yours with votes, shares, 95% intervals, the leader once the votes separate, the\n slots and the reasons; or one you voted on with its shares. Free. Same as GET\n /v1/polls/{poll_id}.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"poll_id": {
"description": "the poll's id",
"title": "Poll Id",
"type": "string"
}
},
"required": [
"poll_id"
],
"title": "get_pollArguments",
"type": "object"
},
"name": "get_poll"
},
{
"description": "One remix you paid for (from remix_hook, remix_find or a chat turn), as its answer\n held it. Free. 404 remix_not_found for one that is not yours. Same as GET\n /v1/remixes/{remix_id}.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"remix_id": {
"title": "Remix Id",
"type": "string"
}
},
"required": [
"remix_id"
],
"title": "get_remixArguments",
"type": "object"
},
"name": "get_remix"
},
{
"description": "One research page: every claim with the first run's and the second run's numbers (each run a\n sample of different channels), n per run and per cell, shown_a and shown_b (over the sample\n bar), reproduced (true, false, or null for too few) and direction, plus measures naming what\n each number is computed from. 404 page_not_found for an unknown slug, 422 for a malformed one.\n No key needed; limited per address. Free. Same as GET /v1/findings/{slug}.",
"inputSchema": {
"properties": {
"slug": {
"description": "openings, title-devices or title-thumbnail-overlap",
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "get_researchArguments",
"type": "object"
},
"name": "get_research"
},
{
"description": "A research run: its status, progress, charge and every hook it produced.\n\n wait_seconds 0 to 50: wait up to that long for the run to finish, returning the\n moment it is done or failed. Use wait_seconds=50 and call again while status is\n \"queued\" or \"running\"; a fresh run needs about 3 or 4 such calls. progress has\n stage, message and updated_at, plus counts once the research reports them, preview\n (hooks written so far) while a running run holds one, and feed (the live research\n wall: up to 24 clips the run is working on, newest first, each key, platform, creator,\n views, state found|reading|talking|passed, thumb_url, a JPEG any <img> can load\n with no key, and line, the banner or opening words once the judges passed the clip)\n while it shows one, and on a Long form or Packaging run scan (the videos it is looking\n at: up to 60 tiles {v: YouTube video id, s: found|on_topic|off_topic|measured|beat|\n reading|ready|passed, x: multiple of the channel's usual or null}, oldest first, and\n lanes with found, on_topic, measured, beat, reading, ready; draw a tile from\n https://i.ytimg.com/vi/{v}/mqdefault.jpg; counts.measured and counts.beat are the\n numbers report.landscape ends on). Pass since with the last\n progress.updated_at to return on change or completion. It must be an ISO timestamp\n with a timezone (422 invalid_request otherwise). `hooks` is the deck (a person\n talking); `bonus` is always [] (removed 2026-10-08). Every hook has format and\n section (always \"main\"), and\n creator_country (TikTok only), place and place_country (null when unknown), banner\n (the title placed on the video, null when none) and match (\"exact\" or \"close\", a\n close match being a neighbouring subject delivered after the exact ones; null on runs\n with no language or country and on older hooks). Since 2026-10-04 the run carries\n understood (what the request was read to ask: subject, language, country, core,\n audience, neighbours, styles, style_other, wants; null until read) and, on a run that\n asked for a kind of opening (\"controversial hooks\", \"storytime\"), every hook carries\n style_match (true when it opens that way; null otherwise). Since 2026-10-01 every hook carries\n the virality v2 fields: virality (0 to 1 on one fixed scale since 2026-10-02),\n virality_why, outlier, outlier_basis, creator_median_views, posted_at, age_days,\n views_per_day, duration_s, paid, sound_reuse, own_sound, hashtags (null on older\n hooks), and since 2026-10-02 the analysis: hook_type, hook_type_other, mechanism,\n visual_hook, audience, template, steal_it; the run echoes posted_within_days and\n seed_hook_ids, and once done carries\n patterns: up to 3 hook structures winning in this deck, each name, template, why,\n hook_ids and count, grouped by hook_type and computed before the run is done, in the\n deck's language (null on older runs and when nothing is shared). Hooks include\n transcript_kind:\n speech, music, none, other, or null when unknown; and heard: false when our speech\n service could not hear the clip right now (no spoken words shown, transcript null; the\n done message then counts them), true otherwise. conversation_id names the chat conversation the run\n belongs to (null outside one). A done run with fewer hooks than asked for, or none,\n has outcome: why in one plain paragraph, what to try next, and whether it was free\n (stats.rejections holds the counts); a full run's outcome is null, or one sentence\n when some hooks are under the view floor because the country filter set clips aside.\n Free: reading a run costs no credits.\n ",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"run_id": {
"title": "Run Id",
"type": "string"
},
"since": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Since"
},
"wait_seconds": {
"default": 0,
"description": "0 to 50: seconds to wait for the run to finish; 0 returns at once",
"maximum": 50,
"minimum": 0,
"title": "Wait Seconds",
"type": "integer"
}
},
"required": [
"run_id"
],
"title": "get_runArguments",
"type": "object"
},
"name": "get_run"
},
{
"description": "A shared folder as anyone with its link sees it: name, description, kind,\n item_count and items (public fields and the owner's note), newest first, paged. No key\n needed; limited per address (429). A link never made or turned off is 404\n shared_folder_not_found. Same as GET /v1/shared/folders/{token}. Free.",
"inputSchema": {
"properties": {
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cursor"
},
"limit": {
"default": 100,
"description": "page size, 1 to 100",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "the token of a share link (hookdetector.com/f/<token>)",
"title": "Token"
}
},
"title": "get_shared_folderArguments",
"type": "object"
},
"name": "get_shared_folder"
},
{
"description": "The skeleton of a long find's whole video, heard by Scribe v2: sections, re-hooks, open loops, payoffs, sponsor and call-to-action spans, the outro, the timed lines. Builds it once for 5 credits as a paid call (status pending; read it with get_call); after that answers the stored one free. Same as POST and GET /v1/finds/{find_id}/skeleton.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"find_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "one of your long finds",
"title": "Find Id"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
}
},
"title": "get_skeletonArguments",
"type": "object"
},
"name": "get_skeleton"
},
{
"description": "Your team, or team null: its name, pool (credits), seats, each member's name and role.\n The owner also sees every member's email, monthly cap and spend, open invites (never\n their links) and the newest 50 charges to the pool (who, what kind, credits, when; never\n what it was about). your_credits is your own balance, untouched while you are a member.\n Free. Same as GET /v1/team.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"title": "get_teamArguments",
"type": "object"
},
"name": "get_team"
},
{
"description": "A thumbnails call: status, concepts and every image so far (url signed for 7 days,\n width, height, words, words_checked, cost_usd). Same as GET /v1/thumbnails/{call_id}. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"call_id": {
"title": "Call Id",
"type": "string"
}
},
"required": [
"call_id"
],
"title": "get_thumbnailsArguments",
"type": "object"
},
"name": "get_thumbnails"
},
{
"description": "One tracker and its channels. Same as GET /v1/trackers/{tracker_id}.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Token"
},
"tracker_id": {
"title": "Tracker Id",
"type": "string"
}
},
"required": [
"tracker_id"
],
"title": "get_trackerArguments",
"type": "object"
},
"name": "get_tracker"
},
{
"description": "Invite someone: returns link (and its token), a single-use page valid 7 days, shown\n here only, and emailed to that address (emailed true; when false, give the link to the\n person yourself). Someone signed in with\n Google must hold that email to accept. Owner only. Needs admin. Free. Same as POST\n /v1/team/invites.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"email": {
"description": "the email of the person invited",
"title": "Email",
"type": "string"
}
},
"required": [
"email"
],
"title": "invite_to_teamArguments",
"type": "object"
},
"name": "invite_to_team"
},
{
"description": "Keep or reject a find (a long-form hook or a package): verdict is \"keep\" (default)\n or \"reject\", and the last verdict wins. The verdict is the video's on that tab: every\n find of the same video you have there carries it, so a later run that finds the video\n again shows it already kept. Kept videos come back from list_kept_finds, across all\n runs. Returns {\"find_id\", \"verdict\"}. Same as POST\n /v1/finds/{find_id}/decision. Free. Errors: 404 find_not_found.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"find_id": {
"title": "Find Id",
"type": "string"
},
"verdict": {
"default": "keep",
"title": "Verdict",
"type": "string"
}
},
"required": [
"find_id"
],
"title": "keep_findArguments",
"type": "object"
},
"name": "keep_find"
},
{
"description": "Keep or reject a hook: verdict is \"keep\" (default) or \"reject\", and the last\n verdict wins. A reject may say why: reason is off_subject, weak_opening, wrong_language,\n low_quality, already_have or other, and note (up to 280 characters) your own words.\n Kept hooks come back from list_keeps, across all runs. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"hook_id": {
"title": "Hook Id",
"type": "string"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Note"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reason"
},
"verdict": {
"default": "keep",
"title": "Verdict",
"type": "string"
}
},
"required": [
"hook_id"
],
"title": "keep_hookArguments",
"type": "object"
},
"name": "keep_hook"
},
{
"description": "Owner only: every access code, newest first, with code_id, code_prefix, email,\n note, source, max_uses, uses, expires_at, revoked_at, created_at and usable. Never the\n code itself. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"title": "list_access_codesArguments",
"type": "object"
},
"name": "list_access_codes"
},
{
"description": "Owner only: every access request, newest first, optionally only one status\n (pending, approved, rejected). Each has request_id, email, note, status, code_id,\n code_prefix, created_at and decided_at. Never a code. Needs the admin scope and an\n admin account (403 admin_required otherwise). Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"title": "list_access_requestsArguments",
"type": "object"
},
"name": "list_access_requests"
},
{
"description": "Your agents with their budgets and this month's spend. Free. Same as GET /v1/agents.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"title": "list_agentsArguments",
"type": "object"
},
"name": "list_agents"
},
{
"description": "Your saved searches and their newest hits. Free. Same as GET /v1/alerts.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"title": "list_alertsArguments",
"type": "object"
},
"name": "list_alerts"
},
{
"description": "Your calls of priced tools, newest first; tool (\"titles\", ...) narrows. Same as GET\n /v1/calls. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"limit": {
"default": 50,
"title": "Limit",
"type": "integer"
},
"tool": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Tool"
}
},
"title": "list_callsArguments",
"type": "object"
},
"name": "list_calls"
},
{
"description": "Your chat conversations, most recently active first, limit 1 to 100 (default 30)\n per page: conversation_id, title, created_at, updated_at, language, country and\n messages (the count). Nullable language/country are the saved search picker settings.\n Returns {\"conversations\": [...], \"next_cursor\"}; pass next_cursor back as cursor for\n more. Same shape as GET /v1/conversations. Next step: get_conversation. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cursor"
},
"limit": {
"default": 30,
"description": "page size, 1 to 100",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
"title": "list_conversationsArguments",
"type": "object"
},
"name": "list_conversations"
},
{
"description": "The index: every video your long and packaging runs found, across all runs, one\n entry a video on each tab (its newest read, with the keep or reject made on the\n video). Each is a full find object: the title and thumbnail_url as YouTube shows them,\n views, channel_median_views, outlier (views over the channel's usual) and\n outlier_score (0 to 100 on one fixed scale, so entries from different runs rank\n together), plus the analysis its run wrote. q (at most 120 characters) looks in the\n title, the channel, the hook as it was said, and what the thumbnail prints and shows,\n so a package can be found by its thumbnail (\"red arrow\", \"before and after\"). Returns\n {\"finds\", \"count\", \"total\" (every match, on any page), \"next_cursor\"}; pass\n next_cursor as cursor for the next page. Use it to search what you already paid for\n before starting a new run. Same as GET /v1/finds. Free. Errors: 422 for a kind, sort,\n tier, min_score, device or q that is not allowed. The bounds min_multiple to language\n (T3-FL) narrow the index on the server, as on GET /v1/finds; an entry that does not\n carry a bounded field is left out.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cursor"
},
"device": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "only entries filed under this device: a hook_type, a title_device or one of the thumbnail_devices",
"title": "Device"
},
"kind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "only \"long\" or only \"packaging\"; leave out for both",
"title": "Kind"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Language"
},
"limit": {
"default": 100,
"description": "page size, 1 to 100",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"max_channel_median": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Channel Median"
},
"max_comments": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Comments"
},
"max_duration_s": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Duration S"
},
"max_multiple": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Multiple"
},
"max_views": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Views"
},
"min_channel_median": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Channel Median"
},
"min_comments": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Comments"
},
"min_duration_s": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Duration S"
},
"min_multiple": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Multiple"
},
"min_score": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "only entries with an outlier_score of at least this, 0 to 100",
"title": "Min Score"
},
"min_views": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Views"
},
"posted_within_days": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Posted Within Days"
},
"q": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "words a title, channel, hook or thumbnail must hold",
"title": "Q"
},
"sort": {
"default": "score",
"description": "\"score\" (default: the highest outlier score first), \"outlier\" (views over the channel's usual), \"views\" or \"newest\"",
"title": "Sort",
"type": "string"
},
"tier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "only \"breakout\" (10 times the channel's usual or more), \"strong\" (5 to 10) or \"outlier\" (under 5)",
"title": "Tier"
}
},
"title": "list_findsArguments",
"type": "object"
},
"name": "list_finds"
},
{
"description": "Your folders, the most recently changed first, each with item_count, up to 4 cover\n thumbnails and its share link when shared. With hook_id or find_id, each folder also\n has contains: the item id when it holds that video (any run's copy), else null.\n Returns {\"folders\": [...], \"count\"}. Same as GET /v1/folders. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"find_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "say which folders already hold this find's video",
"title": "Find Id"
},
"hook_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "say which folders already hold this hook",
"title": "Hook Id"
},
"kind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "only \"short\", \"long\" or \"packaging\"; leave out for every tab",
"title": "Kind"
}
},
"title": "list_foldersArguments",
"type": "object"
},
"name": "list_folders"
},
{
"description": "Title formats of the last 90 days with their median multiple, share over 1.5x, adoption\n and examples, ordered by the Wilson lower bound of that share (computed_from). Formats with at\n least 8 measured videos from 3 channels (each shows measured beside videos); include_small lists\n down to 3 from 2. Free. Same as GET /v1/formats.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"include_small": {
"default": false,
"title": "Include Small",
"type": "boolean"
}
},
"title": "list_formatsArguments",
"type": "object"
},
"name": "list_formats"
},
{
"description": "This account's background jobs, newest first (tracker refreshes, alerts, reviews,\n echo): status, attempts, credits, result or error. Free. Same as GET /v1/jobs.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"limit": {
"default": 50,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
"title": "list_jobsArguments",
"type": "object"
},
"name": "list_jobs"
},
{
"description": "The hooks you kept with keep_hook, newest decision first, across all runs or within\n one run_id, limit 1 to 100 (default 100) per page. Returns {\"kept\": [...], \"count\": n\n on this page, \"next_cursor\"} with full hook objects; pass next_cursor back as cursor\n for more. Same shape as GET /v1/keeps. Free. Errors: 422 for a bad run_id or cursor.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cursor"
},
"limit": {
"default": 100,
"description": "page size, 1 to 100",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
}
},
"title": "list_keepsArguments",
"type": "object"
},
"name": "list_keeps"
},
{
"description": "The videos you kept with keep_find (long-form hooks and packages), newest decision\n first: one entry a video on each tab across all runs, or the kept finds of one run_id,\n limit 1 to 100 (default 100) per page.\n Returns {\"kept\": [...], \"count\": n on this page, \"next_cursor\"} with full find objects.\n Same shape as GET /v1/finds/keeps. Free. Errors: 422 for a bad kind, run_id or cursor.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cursor"
},
"kind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "only \"long\" or only \"packaging\"; leave out for both",
"title": "Kind"
},
"limit": {
"default": 100,
"description": "page size, 1 to 100",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
}
},
"title": "list_kept_findsArguments",
"type": "object"
},
"name": "list_kept_finds"
},
{
"description": "Your API keys and what each may do. keys: key_id, name, prefix, created_at,\n last_used_at and current (true for the key making this call). access, per key_id:\n scopes, credit_limit, credits_used, expires_at and expired. scopes: the calling key's.\n The original signup key has key_id \"original\". The keys themselves are never shown\n again. Needs admin. Same shape as GET /v1/keys. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"title": "list_keysArguments",
"type": "object"
},
"name": "list_keys"
},
{
"description": "The niche explorer: every niche reported, with its headline numbers. Free. Same as\n GET /v1/niches.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"limit": {
"default": 50,
"maximum": 200,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
"title": "list_nichesArguments",
"type": "object"
},
"name": "list_niches"
},
{
"description": "Your package votes, newest first, with their results so far. Free. Same as GET /v1/polls.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"title": "list_pollsArguments",
"type": "object"
},
"name": "list_polls"
},
{
"description": "Your saved filter presets, the newest change first; tab (\"long\", \"packaging\",\n \"library\") narrows. Same as GET /v1/presets. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"tab": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Tab"
}
},
"title": "list_presetsArguments",
"type": "object"
},
"name": "list_presets"
},
{
"description": "The remixes you paid for from one hook (hook_id) or one find (find_id), newest\n first, each as its answer held it, with remix_id and created_at. Returns {\"remixes\":\n [...]}. Free. 404 hook_not_found or find_not_found for one that is not yours. Same as\n GET /v1/hooks/{hook_id}/remixes and GET /v1/finds/{find_id}/remixes.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"find_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "one of your finds; or give hook_id",
"title": "Find Id"
},
"hook_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "one of your hooks; or give find_id",
"title": "Hook Id"
}
},
"title": "list_remixesArguments",
"type": "object"
},
"name": "list_remixes"
},
{
"description": "The research findings counted from Hook Detector's shared index of public YouTube data:\n openings (which openings sit before a steeper or flatter first minute of YouTube's \"most\n replayed\" heatmap, replay intensity, not retention), title-devices (which title devices go with\n higher multiples, by niche) and title-thumbnail-overlap (title and thumbnail word overlap against\n the multiple). Each page with n per run and how many claims reproduced on a second sample of other\n channels, did not, or had too few videos. No key needed; limited per address (429). Free. Same as\n GET /v1/findings.",
"inputSchema": {
"properties": {},
"title": "list_researchArguments",
"type": "object"
},
"name": "list_research"
},
{
"description": "Your research runs, newest first, without their results, limit 1 to 100 (default 20)\n per page. Each run says its kind: \"short\" (find_hooks), \"long\" (find_long_hooks) or\n \"packaging\" (find_packaging); pass kind to list only one. Returns {\"runs\": [...],\n \"next_cursor\"}: pass next_cursor back as cursor for the next page; it is null on the\n last. Same shape as GET /v1/runs. Next step: open one with get_run, or download it with\n export_run. Free. Errors: 422 invalid_cursor for a cursor this API did not issue, 422\n for a kind that is not one of the three.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cursor"
},
"kind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "only runs of this kind: short, long or packaging; leave out for every kind",
"title": "Kind"
},
"limit": {
"default": 20,
"description": "page size, 1 to 100",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
"title": "list_runsArguments",
"type": "object"
},
"name": "list_runs"
},
{
"description": "The hook strategy library: every kind of long-form hook the shared index holds at least\n 3 openings of, with its plain name, count, the median multiple of those videos over their\n channels' usual views, the median hook length in seconds, the template most share, and up\n to 3 real examples (title, hook as said, video_id, channel, multiple). Counted from the\n index, never by a model; public data only. Free. Same as GET /v1/strategies.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"q": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a subject: only openings of videos whose title or channel match its words",
"title": "Q"
}
},
"title": "list_strategiesArguments",
"type": "object"
},
"name": "list_strategies"
},
{
"description": "Your trackers, or every public one. Free. Same as GET /v1/trackers.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"scope": {
"default": "mine",
"description": "mine or public",
"title": "Scope",
"type": "string"
}
},
"title": "list_trackersArguments",
"type": "object"
},
"name": "list_trackers"
},
{
"description": "Rising words and phrases in the shared index's titles, this window against the one\n before, with counts and growth. Free. Same as GET /v1/trends.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"window": {
"default": 7,
"description": "7, 30 or 90 days",
"title": "Window",
"type": "integer"
}
},
"title": "list_trendsArguments",
"type": "object"
},
"name": "list_trends"
},
{
"description": "Your webhooks with their events and state (never the secret). Same as GET /v1/webhooks.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"title": "list_webhooksArguments",
"type": "object"
},
"name": "list_webhooks"
},
{
"description": "Real title and thumbnail changes on other channels: both versions (the pictures as\n URLs), views per hour before and 24 to 72 hours after, the lift and when the spike came.\n Free. Same as GET /v1/winners.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cursor"
},
"limit": {
"default": 24,
"maximum": 50,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"min_lift": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Lift"
},
"min_views": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Views"
},
"min_vph_before": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Vph Before"
},
"sort": {
"default": "recent",
"description": "recent or lift",
"title": "Sort",
"type": "string"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "title or thumbnail",
"title": "Type"
}
},
"title": "list_winnersArguments",
"type": "object"
},
"name": "list_winners"
},
{
"description": "Make 2 to 12 thumbnails (default 4): 3 different concepts first, then images (Nano\n Banana 2.1, 1K or 4K), every printed word read back and checked letter by letter, a face\n only from your photos or your channel's own thumbnails. Answers at once with call_id and\n status pending; read it with get_thumbnails until done. 4 credits a delivered 1K image, 12\n a 4K one, charged only for what is delivered. Same as POST /v1/thumbnails.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Background"
},
"channel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Channel"
},
"concept": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Concept"
},
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"faces": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Faces"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"mode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mode"
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reference"
},
"run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
},
"size": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Size"
},
"sketch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sketch"
},
"title": {
"title": "Title",
"type": "string"
},
"topic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Topic"
},
"words": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Words"
}
},
"required": [
"title"
],
"title": "make_thumbnailsArguments",
"type": "object"
},
"name": "make_thumbnails"
},
{
"description": "Move credits between your balance and the team's pool; 402 when the side giving holds\n less, and nothing moves. Owner only. Needs admin. Free. Same as POST /v1/team/credits.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"credits": {
"description": "1 to 1,000,000",
"title": "Credits",
"type": "integer"
},
"direction": {
"description": "\"in\": your balance to the pool; \"out\": the pool back to you",
"enum": [
"in",
"out"
],
"title": "Direction",
"type": "string"
}
},
"required": [
"credits",
"direction"
],
"title": "move_team_creditsArguments",
"type": "object"
},
"name": "move_team_credits"
},
{
"description": "A poll of another Hook Detector user waiting for your vote (not one you passed in skip): its\n options in an order of your own, no counts; poll null when none is waiting. Free. Same as\n GET /v1/polls/next.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"skip": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "poll ids to pass over in this ask",
"title": "Skip"
}
},
"title": "next_pollArguments",
"type": "object"
},
"name": "next_poll"
},
{
"description": "A niche report counted from the shared index: videos, channels, median views, the share\n at 10x and over, the 75th percentile multiple, top outliers and channels, by month. Free.\n Same as GET /v1/niches/{slug}.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"slug": {
"description": "lowercase words joined by hyphens",
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "niche_reportArguments",
"type": "object"
},
"name": "niche_report"
},
{
"description": "New packages (4, 8 or 12) for your published video: the original scored first against\n the real outliers on its subject, then each new package (title, thumbnail with every word\n checked, what it tests) scored the same way, best first, with vs_original. 10 credits a\n delivered package. Answers at once; read it with get_optimize. Same as POST /v1/optimize.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
},
"size": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Size"
},
"video_url": {
"title": "Video Url",
"type": "string"
}
},
"required": [
"video_url"
],
"title": "optimize_videoArguments",
"type": "object"
},
"name": "optimize_video"
},
{
"description": "Your package in a mock YouTube feed among a run's winners: view home, search, sidebar,\n phone (marks where a phone cuts the title) or tv; theme dark or light; look normal, grey\n or blur. Returns png_base64 and mine_at. Free. Same as POST /v1/packaging/preview.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"look": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Look"
},
"run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
},
"seed": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Seed"
},
"theme": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Theme"
},
"thumbnail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Thumbnail"
},
"title": {
"title": "Title",
"type": "string"
},
"topic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Topic"
},
"view": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "View"
}
},
"required": [
"title"
],
"title": "preview_packageArguments",
"type": "object"
},
"name": "preview_package"
},
{
"description": "Outliers at random from the shared index (5x their channel's usual and over by\n default), a different set each call. Free. Same as GET /v1/index/random.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"channel_size": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Channel Size"
},
"content_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Content Type"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Language"
},
"limit": {
"default": 12,
"maximum": 50,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"max_multiple": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Multiple"
},
"max_views": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Views"
},
"min_multiple": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Multiple"
},
"min_views": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Views"
},
"posted_within_days": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Posted Within Days"
}
},
"title": "random_outliersArguments",
"type": "object"
},
"name": "random_outliers"
},
{
"description": "Read a YouTube Studio audience retention screenshot (base64 PNG or JPEG) into 100 points and the 21 marks it was read from (1 credit). Not the chart is 422 not_a_retention_chart, free. Same as POST /v1/review/graph.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "the screenshot as base64",
"title": "Image"
}
},
"title": "read_retention_graphArguments",
"type": "object"
},
"name": "read_retention_graph"
},
{
"description": "New thumbnails for your video with a YouTube video's own thumbnail as the layout\n reference (2 to 4 images, every printed word checked); priced as make_thumbnails. Same as\n POST /v1/thumbnails/recreate; read it with get_thumbnails.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"mode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mode"
},
"size": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Size"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"video_url": {
"title": "Video Url",
"type": "string"
},
"words": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Words"
}
},
"required": [
"video_url"
],
"title": "recreate_thumbnailArguments",
"type": "object"
},
"name": "recreate_thumbnail"
},
{
"description": "Owner only: reject a pending access request. Nothing is emailed. An approved or\n rejected request is 409 request_already_decided. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"request_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Request Id"
}
},
"title": "reject_access_requestArguments",
"type": "object"
},
"name": "reject_access_request"
},
{
"description": "Make it mine, for a long-form opening or a package: write up to n (1 to 5, default\n 3) new ones for your niche that keep one real find's structure. From a long find,\n `written` holds openings: hook (what the creator says first), then (what the next half\n minute has to deliver) and kept_structure, built on the find's template and its order\n of beats. From a packaging find it holds packages: title, thumbnail (what to show and\n how to frame it), thumbnail_text (the words to print, or null) and kept_structure,\n built on its title template and its thumbnail's composition.\n\n Write my intro: with mode \"intro\" and video_brief (your own video in a few sentences,\n 10 to 600 characters; a long find only, a packaging find is 422; niche and n are not\n used) it writes YOUR intro in the real opening's structure. `written` then holds one\n object with a beat for each beat of the real opening, in order: beat, does, from_s,\n to_s, seconds and words_budget (the real opening's own timing, never the model's), say\n (the words to say, with {placeholders} for what only you know), words, placeholders,\n suggested_on_screen and suggested_broll (suggestions, never part of what is said); and\n seconds, timing (measured or estimated), kept_structure, placeholders and\n numbers_to_placeholders. The answer carries mode \"intro\" and video_brief, and niche is\n null. A number you did not write in video_brief becomes {number}. One that copies the\n real opening or runs over a word budget is 422 remix_not_possible.\n\n Returns {\"find_id\", \"kind\", \"niche\", \"n\", \"written\", \"label\", \"credits_charged\": 1,\n \"credits\"}. label says they were written by Hook Detector from a real opening's (or\n package's) structure: show it with them, never present one as a real video's. One that\n is the real find's own words is dropped. They are never added to a run, a keep or an\n export. Costs 1 credit per call, taken before the model is asked and refunded when it\n does not answer (503 model_unavailable) or when nothing it wrote keeps the rules or it\n declines the content (422 remix_not_possible, the reason in the message; another try\n or another niche may work). 402 insufficient_credits at a balance of 0;\n 404 find_not_found; limited per account per hour (429 rate_limited). Needs the\n research permission. The answer carries remix_id: list_remixes and get_remix read it\n back, free. Same as POST /v1/finds/{find_id}/remix.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"find_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "one of your finds (from get_run, get_find, list_finds or list_kept_finds)",
"title": "Find Id"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"mode": {
"default": null,
"description": "optional: \"openings\" (the default) writes openings or packages for a niche; \"intro\" is Write my intro: your own timed intro for the video you describe in video_brief, in this long-form opening's structure. Only a long find has an intro (a packaging find is 422); niche and n are not used in intro mode",
"enum": [
"openings",
"intro",
null
],
"examples": [
"intro"
],
"title": "Mode",
"type": [
"string",
"null"
]
},
"n": {
"default": null,
"description": "how many to write, 1 to 5 (default 3)",
"maximum": 5,
"minimum": 1,
"title": "N",
"type": "integer"
},
"niche": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "your niche, product or audience, as you would say it (1 to 120 characters)",
"title": "Niche"
},
"video_brief": {
"default": null,
"description": "required for mode \"intro\", 10 to 600 characters: what your video is about, in a few sentences, in your own words and language. The intro uses only the facts and numbers you write here; anything else becomes a {placeholder}",
"examples": [
"A beginner video on why home espresso tastes sour, built around my 18 grams in, 36 grams out recipe."
],
"maxLength": 600,
"minLength": 10,
"title": "Video Brief",
"type": [
"string",
"null"
]
}
},
"title": "remix_findArguments",
"type": "object"
},
"name": "remix_find"
},
{
"description": "Make it mine: write up to n new opening lines (1 to 5, default 3) for your niche\n that keep a real hook's structure, the device that made it travel, with the subject\n swapped for yours. hook_id is one of your hooks (from get_run, get_hook or\n list_keeps); 404 hook_not_found otherwise. Leave mode out: \"intro\" (Write my intro) is\n remix_find on a long-form find, and is 422 here, before any charge.\n\n Returns {\"hook_id\", \"niche\", \"n\", \"written\": [{\"line\", \"kept_structure\"}], \"label\",\n \"credits_charged\": 1, \"credits\"}. label is always\n \"Written by Hook Detector from a real hook's structure\":\n these are written lines, never found hooks; show the label\n with them, never present one as a real clip's hook. They are never added to a deck, a\n keep or an export. Costs 1 credit per call, taken before the model is asked and\n refunded when it does not answer (503 model_unavailable) or when nothing it wrote\n keeps the rules or it declines the content (422 remix_not_possible, the reason in the\n message; another try or another niche may work). 402 insufficient_credits at\n a balance of 0; limited per account per hour (429 rate_limited). Needs the research\n permission. The answer carries remix_id: list_remixes and get_remix read it back,\n free. Same as POST /v1/hooks/{hook_id}/remix.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"hook_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "one of your hooks (from get_run, get_hook or list_keeps)",
"title": "Hook Id"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"mode": {
"default": null,
"description": "leave out (or \"openings\"). Write my intro works from a long-form find (POST /v1/finds/{find_id}/remix), so \"intro\" is refused here with 422",
"enum": [
"openings",
null
],
"title": "Mode",
"type": [
"string",
"null"
]
},
"n": {
"default": null,
"description": "how many lines to write, 1 to 5 (default 3)",
"maximum": 5,
"minimum": 1,
"title": "N",
"type": "integer"
},
"niche": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "your niche, product or audience, as you would say it (1 to 120 characters)",
"title": "Niche"
}
},
"title": "remix_hookArguments",
"type": "object"
},
"name": "remix_hook"
},
{
"description": "Take one video out of a folder; the hook or find and its keep stay. Returns\n {\"item_id\", \"removed\": true}. Same as DELETE /v1/folders/{folder_id}/items/{item_id}.\n Free. Errors: 404 item_not_found (also on a second remove).",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"folder_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "one of your folders (from list_folders or create_folder)",
"title": "Folder Id"
},
"item_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "an item of that folder (from get_folder or save_to_folder)",
"title": "Item Id"
}
},
"title": "remove_from_folderArguments",
"type": "object"
},
"name": "remove_from_folder"
},
{
"description": "Take a channel off one of your trackers. Same as DELETE\n /v1/trackers/{tracker_id}/channels/{ref}.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"ref": {
"title": "Ref",
"type": "string"
},
"tracker_id": {
"title": "Tracker Id",
"type": "string"
}
},
"required": [
"tracker_id",
"ref"
],
"title": "remove_from_trackerArguments",
"type": "object"
},
"name": "remove_from_tracker"
},
{
"description": "The owner removes a member; anyone leaves with member_id \"me\". A removed member's next\n spend comes from their own balance, never the pool. The owner leaving with members is 409\n team_has_members; alone it ends the team and returns the pool. Needs admin. Free. Same as\n DELETE /v1/team/members/{member_id}.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"member_id": {
"description": "a member_id from get_team, or \"me\" to leave",
"title": "Member Id",
"type": "string"
}
},
"required": [
"member_id"
],
"title": "remove_team_memberArguments",
"type": "object"
},
"name": "remove_team_member"
},
{
"description": "Rename a folder, change its description, or both. A name another folder on the tab\n already has is 409 folder_exists. Returns the folder. Same as PATCH\n /v1/folders/{folder_id}. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a new description; \"\" clears it, left out it stays",
"title": "Description"
},
"folder_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "one of your folders (from list_folders or create_folder)",
"title": "Folder Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a new name, 1 to 80 characters",
"title": "Name"
}
},
"title": "rename_folderArguments",
"type": "object"
},
"name": "rename_folder"
},
{
"description": "Ask for the beta access code a new account needs (create_account's access_code).\n email is where the code is sent; note is optional (who you are, up to 500\n characters). The owner approves the request and the code is emailed at once; it works\n once, in any agent or on the web. Returns status pending (waiting for approval) or\n emailed (sent now). No key needed. Limited to 5 per address per hour. Free.",
"inputSchema": {
"properties": {
"email": {
"title": "Email",
"type": "string"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Note"
}
},
"required": [
"email"
],
"title": "request_accessArguments",
"type": "object"
},
"name": "request_access"
},
{
"description": "Keyword research for YouTube. volume: always estimated (YouTube publishes no search\n counts): estimated_monthly_searches with a range, a 0 to 100 score and band, its source\n (Google Trends with the YouTube filter against fixed anchors; or, when Trends is busy,\n YouTube autocomplete and the top results' views) and basis. competition: 0 to 100 counted\n from the top 10 long-form results (big channels, posted in the last year, the keyword in\n the title, how many beat their own channel 2x). score: value 0 to 100 (60% volume, 40% the\n room competition leaves), band very_low, low, medium, high or very_high (vidIQ's brackets)\n and the basis naming its inputs. related, questions, rising: terms from autocomplete and the\n top results' titles, each with its source. Costs 2 credits, refunded when the read fails;\n a bad request is 422 and costs nothing. Takes about 10 to 30 seconds. Same as POST\n /v1/keywords. Read it back with get_call.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a two-letter country code, default US",
"title": "Country"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"keyword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "the words people would type into YouTube search, 2 to 100 characters",
"title": "Keyword"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a two-letter language code for the autocomplete, default en",
"title": "Language"
}
},
"title": "research_keywordsArguments",
"type": "object"
},
"name": "research_keywords"
},
{
"description": "Edit Review of a cut before upload (25 credits; an unlisted or public YouTube link up to 60 minutes): cuts a minute, long shots, dead air, sound changes, on-screen text, and the notes as Premiere CSV, Resolve EDL and FCPXML markers. Runs as a job. Same as POST /v1/review/edit; to review the file itself (when YouTube refuses our servers the link is refused free with upload_instead), send it to POST /v1/review/edit/upload.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a YouTube link: watch, youtu.be or shorts address",
"title": "Url"
}
},
"title": "review_editArguments",
"type": "object"
},
"name": "review_edit"
},
{
"description": "Hook Review of your own opening (3 credits): a YouTube link (its first minute heard by Scribe v2) or a pasted script, scored out of 10 from named counted parts, a verdict per beat, and the promise check against your title and thumbnail words. Same as POST /v1/review/hook.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"script": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "or your opening as pasted words",
"title": "Script"
},
"thumbnail_words": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Thumbnail Words"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a YouTube link: watch, youtu.be or shorts address",
"title": "Url"
}
},
"title": "review_hookArguments",
"type": "object"
},
"name": "review_hook"
},
{
"description": "Script Review (3 credits): your pasted script read like a Video Review on estimated times, plus machine-sounding lines and a fact-check list. Runs as a job. Same as POST /v1/scripts/review.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"script": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Script"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
}
},
"title": "review_scriptArguments",
"type": "object"
},
"name": "review_script"
},
{
"description": "Rate my Reel or Short: read one public short the way Hook Detector reads a clip (its\n first frames, its words heard by ElevenLabs Scribe v2) and rate it against the real\n finds on its subject (the Short form search over the last 30 days, ranked by their\n multiple over the creator's usual). Returns review_id, url, platform, video_id, subject,\n subject_from, clip (first_line, first_word_s, words_per_minute, longest_pause_s, words,\n heard_by, not_heard_why, onscreen_text, plays, multiple), reads (five, in order: stop,\n gap, momentum, feeling, reach; each with verdict strong, moderate or weak, says,\n computed_from counted against the finds, and finds: 1 to 3 ids from `finds`), finds\n (each a real video with its url, plays, multiple, first_line and pace), finds_from,\n label, credits_charged and credits. Never a guessed number. Costs 3 credits, taken\n first and given back on any failure: 422 invalid_link (before any charge), 404\n video_not_found (private or removed), 422 not_a_short, 422 review_not_possible (too few\n finds on the subject), 503 model_unavailable. 402 insufficient_credits under 3; limited\n per account per hour (429). Takes up to about 90 seconds. Needs research. Same as POST\n /v1/review/short.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "retry safely: the same key and arguments within 24 hours answer the saved review and charge nothing",
"title": "Idempotency Key"
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "what the clip is about, 2 to 120 characters; leave out to read it from the clip",
"title": "Subject"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a public Instagram Reel, TikTok video or YouTube Short link, starting with https://",
"title": "Url"
}
},
"title": "review_shortArguments",
"type": "object"
},
"name": "review_short"
},
{
"description": "Video Review of any public long video (15 credits): five ranked fixes with times and the counted fact behind each, six sub-scores each with what it is computed from, the hook scored and rewritten (labelled as written), the curve (YouTube's replay peaks, not retention; your Studio curve via graph_points; else predicted, not measured), the story with gap rules, pace and loudness per section, the next five uploads. Runs as a job: answers the paid call (pending); get_call reads it. Same as POST /v1/review.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"graph_points": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "your real curve from read_retention_graph",
"title": "Graph Points"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a YouTube link: watch, youtu.be or shorts address",
"title": "Url"
}
},
"title": "review_videoArguments",
"type": "object"
},
"name": "review_video"
},
{
"description": "Owner only: revoke an access code (code_id from list_access_codes). It admits\n nobody from now on; accounts it already made keep working. 404 access_code_not_found\n for an unknown id. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"code_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Code Id"
}
},
"title": "revoke_access_codeArguments",
"type": "object"
},
"name": "revoke_access_code"
},
{
"description": "Revoke one of your API keys at once: key_id from list_keys, or \"original\" for the\n signup key. Any key may revoke itself (the result says so, and that key stops working\n immediately); revoking another needs admin. Never the last active key on the account\n (409): create another with create_key first.\n\n If a key leaked, pass key_id \"others\": every key of the account except the one you\n are calling with is revoked at once, and the result says how many (revoked_count) and\n which key is kept. Needs admin. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"key_id": {
"title": "Key Id",
"type": "string"
}
},
"required": [
"key_id"
],
"title": "revoke_keyArguments",
"type": "object"
},
"name": "revoke_key"
},
{
"description": "Revoke an open invite: its link stops working at once. Owner only. Needs admin. Free.\n Same as DELETE /v1/team/invites/{invite_id}.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"invite_id": {
"description": "from get_team invites",
"title": "Invite Id",
"type": "string"
}
},
"required": [
"invite_id"
],
"title": "revoke_team_inviteArguments",
"type": "object"
},
"name": "revoke_team_invite"
},
{
"description": "Check a saved search now, as a job (read it with get_job). 1 credit. Same as\n POST /v1/alerts/{alert_id}/run.",
"inputSchema": {
"properties": {
"alert_id": {
"title": "Alert Id",
"type": "string"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"required": [
"alert_id"
],
"title": "run_alertArguments",
"type": "object"
},
"name": "run_alert"
},
{
"description": "Save filters under a name for one tab: \"long\", \"packaging\" or \"library\" (the bounds\n are those of find_packaging's filters; a library preset may also hold min_comments,\n max_comments, posted_within_days and language). The same name on the same tab replaces\n it. Start a run from it with preset_id on find_long_hooks or find_packaging. At most 50\n an account. Same as POST /v1/presets. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"filters": {
"default": null,
"description": "optional bounds, every one optional: min_multiple and max_multiple (views over the channel's median, 1 to 1000), min_views, max_views, min_channel_median, max_channel_median, min_duration_s, max_duration_s; on the Library (and a library preset) also min_comments, max_comments, posted_within_days (7, 30, 90, 365, 730) and language. No delivered find falls outside one; a min_multiple above the bar raises it",
"examples": [
{
"max_views": 2000000,
"min_multiple": 5
}
],
"title": "Filters",
"type": [
"object",
"null"
]
},
"name": {
"title": "Name",
"type": "string"
},
"tab": {
"title": "Tab",
"type": "string"
}
},
"required": [
"name",
"tab"
],
"title": "save_presetArguments",
"type": "object"
},
"name": "save_preset"
},
{
"description": "File one video in a folder of its tab: a find (find_id) or any public YouTube video\n (video_id) in a long or packaging folder, a hook (hook_id) in a short one, with an\n optional note. A video already in the\n folder (the same find, another run's find of it, the same hook) returns that item with\n created false; a note given then replaces its note. Filing does not keep it. Same as\n POST /v1/folders/{folder_id}/items. Free. Errors: 404 find_not_found or\n hook_not_found, 422 kind_mismatch, 409 folder_full (2000 items).",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"find_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a Long form or Packaging find of yours; or give hook_id",
"title": "Find Id"
},
"folder_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "one of your folders (from list_folders or create_folder)",
"title": "Folder Id"
},
"hook_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a Short form hook of yours; or give find_id",
"title": "Hook Id"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional, up to 1000 characters",
"title": "Note"
},
"video_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "any public YouTube video by its 11-character id, for a long or packaging folder",
"title": "Video Id"
}
},
"title": "save_to_folderArguments",
"type": "object"
},
"name": "save_to_folder"
},
{
"description": "Score a package against the real outliers on its subject, part by part (title device,\n length, words on the picture, faces, the words' role, contrast, brightness): each part\n says how many outliers it matches; pattern_match (0 to 100) is the mean share: how much\n the package resembles the subject's outliers, never a click-through rate or a prediction\n (in our test it scored outliers above their channels' usual videos on about 3 of 4 pairs). Also nearest (5 outliers) and fixes. 1 credit, refunded when the read\n fails. Same as POST /v1/packaging/score.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"content_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "for a topic: long or short",
"title": "Content Type"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a finished run of yours whose outliers to compare with; or topic",
"title": "Run Id"
},
"thumbnail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional: your thumbnail as base64 (JPEG, PNG, WebP, at most 4 MB) or an i.ytimg.com URL",
"title": "Thumbnail"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "your title, 1 to 150 characters (or video_url)",
"title": "Title"
},
"topic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "the subject (the shared index's outliers)",
"title": "Topic"
},
"video_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a published YouTube video to score instead",
"title": "Video Url"
}
},
"title": "score_packageArguments",
"type": "object"
},
"name": "score_package"
},
{
"description": "Channels by name or handle: the shared index first, then YouTube's own channel search.\n Free. Same as GET /v1/channels/search.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"limit": {
"default": 20,
"maximum": 50,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"q": {
"maxLength": 100,
"minLength": 2,
"title": "Q",
"type": "string"
}
},
"required": [
"q"
],
"title": "search_channelsArguments",
"type": "object"
},
"name": "search_channels"
},
{
"description": "Search the shared index of public YouTube videos Hook Detector's runs measured, with\n no run: words by text and meaning, or browse; filters for the multiple, views, long or\n short, recency, channel size and language. Free. Same as GET /v1/index/search.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"channel_size": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "small, medium or large",
"title": "Channel Size"
},
"content_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "long or short",
"title": "Content Type"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cursor"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Language"
},
"limit": {
"default": 24,
"maximum": 50,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"max_multiple": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Multiple"
},
"max_views": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Views"
},
"min_multiple": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Multiple"
},
"min_views": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Views"
},
"posted_within_days": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "30, 90, 365 or 730",
"title": "Posted Within Days"
},
"q": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q"
},
"sort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "multiple, views, recent or relevance (needs q)",
"title": "Sort"
}
},
"title": "search_indexArguments",
"type": "object"
},
"name": "search_index"
},
{
"description": "Thumbnails in the shared index by what the picture shows (q), or like a picture\n (image_url: read once by the model as subject, action, words and setting, then\n searched). Each result has matched_by (text or meaning). Free; image reads at most 60\n an hour. Same as GET /v1/index/thumbnails and POST /v1/index/thumbnails/by-image.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"content_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "long or short",
"title": "Content Type"
},
"image_url": {
"anyOf": [
{
"maxLength": 2000,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "instead of q: a public https picture or a YouTube video link; it is read once by the model, then searched",
"title": "Image Url"
},
"limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 50 (default 12)",
"title": "Limit"
},
"min_multiple": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Multiple"
},
"q": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "what the picture shows, e.g. person pointing at a chart",
"title": "Q"
}
},
"title": "search_thumbnailsArguments",
"type": "object"
},
"name": "search_thumbnails"
},
{
"description": "Set a member's monthly cap on the pool (null removes it). A run started near the cap\n holds only what is left, so the cap is never passed mid-run (403 team_cap_reached below a\n run's minimum or a tool's price). Owner only. Needs admin. Free. Same as PATCH\n /v1/team/members/{member_id}.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"member_id": {
"description": "a member_id from get_team",
"title": "Member Id",
"type": "string"
},
"monthly_cap": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "1 to 1,000,000 credits a UTC month, or null for no cap",
"title": "Monthly Cap"
}
},
"required": [
"member_id",
"monthly_cap"
],
"title": "set_team_member_capArguments",
"type": "object"
},
"name": "set_team_member_cap"
},
{
"description": "Turn on a folder's share link: share_url is a public read-only page anyone with it\n opens signed out (hookdetector.com/f/<token>); api_url is the same as JSON\n (get_shared_folder). It shows the folder's name, description and items with their\n notes, never anything about the account. A shared folder keeps its link. Same as\n POST /v1/folders/{folder_id}/share. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"folder_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "one of your folders (from list_folders or create_folder)",
"title": "Folder Id"
}
},
"title": "share_folderArguments",
"type": "object"
},
"name": "share_folder"
},
{
"description": "Share a finished Short form run as a public, read-only page anyone can open with the\n link, no sign-in: each hook's spoken line, on-screen words, idea, plays, creator and its\n video, in the Hook Detector skill page layout. Nothing about the account is on it.\n\n Returns {\"run_id\", \"token\", \"url\"}; give the person the url\n (https://hookdetector.com/p/<token>). Idempotent: a run keeps one link, so calling again\n returns the same url. The same body as POST /v1/runs/{run_id}/share; the page's data is\n GET /v1/shared/{token}, no key needed. Needs the write scope. Free.\n Errors: 404 run_not_found, 409 run_not_finished while the run works (call get_run with\n wait_seconds=50 first), 409 run_not_shareable for a failed run or a Long form or\n Packaging run, 422 invalid_request for a malformed run_id.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
}
},
"title": "share_runArguments",
"type": "object"
},
"name": "share_run"
},
{
"description": "Real hooks this service has delivered, for a wait screen: talking heads only, each\n hook_id, still_url (a JPEG, no key needed), platform, creator, views and line (the\n banner on the video, else its opening line). The most viewed first, one per creator,\n only what is already public on TikTok or Instagram: never a topic, an account or a run.\n No key needed. Cached 10 minutes. Free. REST: GET /v1/showcase?n=12.\n ",
"inputSchema": {
"properties": {
"n": {
"default": 12,
"description": "how many; clamped to 1 to 24",
"title": "N",
"type": "integer"
}
},
"title": "showcaseArguments",
"type": "object"
},
"name": "showcase"
},
{
"description": "Channels in the shared index closest to this one by the meaning of their titles, else\n by shared words, with a similarity 0 to 1. Free. Same as GET /v1/channels/{ref}/similar.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"limit": {
"default": 10,
"maximum": 20,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"ref": {
"title": "Ref",
"type": "string"
}
},
"required": [
"ref"
],
"title": "similar_channelsArguments",
"type": "object"
},
"name": "similar_channels"
},
{
"description": "Start a background job on Hook Detector's job runner. Only echo can be started by\n hand: it waits `seconds` and answers `message` back with how many attempts it took (a\n job survives a deploy). At most 3 an hour per account. Free. Same as POST /v1/jobs;\n read it back with get_job.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"kind": {
"default": "echo",
"description": "only echo today",
"title": "Kind",
"type": "string"
},
"message": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Message"
},
"seconds": {
"default": 5,
"description": "1 to 120",
"maximum": 120,
"minimum": 1,
"title": "Seconds",
"type": "integer"
}
},
"title": "start_jobArguments",
"type": "object"
},
"name": "start_job"
},
{
"description": "Your swipe file: the title structures of the Packaging finds you kept or filed, each\n title_template with its title_device, count (how many of those videos use it, one a\n video) and best (the example with the highest outlier_score, 0 to 100). The most used\n first; packages is how many videos were read, skipped how many had no structure. Same\n as GET /v1/swipe. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"title": "swipe_fileArguments",
"type": "object"
},
"name": "swipe_file"
},
{
"description": "Send one signed test delivery now and read what your URL answered. Same as\n POST /v1/webhooks/{webhook_id}/test.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"webhook_id": {
"title": "Webhook Id",
"type": "string"
}
},
"required": [
"webhook_id"
],
"title": "test_webhookArguments",
"type": "object"
},
"name": "test_webhook"
},
{
"description": "Where the eye is predicted to land on a thumbnail: the picture with a heatmap over it (PNG,\n base64), a 16 by 9 grid, the peak, the share in each third, the concentration and the share in\n YouTube's length corner. UNISAL (AUC 0.895 on MIT1003): faces draw it strongly, printed words\n less than people read them; a prediction, not a click-through rate. Free. Same as POST\n /v1/thumbnails/attention.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"thumbnail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a JPEG, PNG or WebP in base64 or an i.ytimg.com URL",
"title": "Thumbnail"
},
"video_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "or a YouTube video: its own thumbnail is read",
"title": "Video Url"
}
},
"title": "thumbnail_attentionArguments",
"type": "object"
},
"name": "thumbnail_attention"
},
{
"description": "Your tracker alerts, newest first, with the unread count. Free. Same as GET\n /v1/trackers/alerts.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"limit": {
"default": 50,
"maximum": 200,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"mark_read": {
"default": false,
"title": "Mark Read",
"type": "boolean"
},
"unread_only": {
"default": false,
"title": "Unread Only",
"type": "boolean"
}
},
"title": "tracker_alertsArguments",
"type": "object"
},
"name": "tracker_alerts"
},
{
"description": "A tracker's channels' uploads, strongest first. Free. Same as GET\n /v1/trackers/{tracker_id}/feed.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"days": {
"default": 30,
"maximum": 3650,
"minimum": 1,
"title": "Days",
"type": "integer"
},
"limit": {
"default": 50,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"sort": {
"default": "multiple",
"description": "multiple, vph or recent",
"title": "Sort",
"type": "string"
},
"token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Token"
},
"tracker_id": {
"title": "Tracker Id",
"type": "string"
}
},
"required": [
"tracker_id"
],
"title": "tracker_feedArguments",
"type": "object"
},
"name": "tracker_feed"
},
{
"description": "Trending Shorts: the short videos (TikToks, Instagram Reels, YouTube Shorts) rising\n now on a subject, fastest first. Each item has video_id, platform, url, cover_url,\n creator, caption, plays, posted_at, age_hours, plays_per_hour (plays over the hours\n since posting, at least one), multiple and multiple_basis (plays over the creator's\n usual: the median of their latest videos, or TikTok likes per video; null when it could\n not be measured), creator_usual, duration_s, and spoken_hook with spoken_hook_from (the\n opening line when one of your own Short form runs delivered the video, or Scribe v2\n heard it). At most 20 items, 2 per creator; a video with no post date is never listed.\n unavailable names a platform whose search did not answer. Free (credits_charged 0); the\n same subject, platform and window within 30 minutes is served from the cache, and fresh\n fetches are limited per account per hour (429 rate_limited). 503 search_unavailable\n when no platform answered. Needs read. Same as GET /v1/shorts/trending.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"platform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "tiktok, instagram or youtube; leave out for all three",
"title": "Platform"
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "what the videos are about, 2 to 120 characters",
"title": "Subject"
},
"window": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "24h, 7d (default) or 30d: how recently they were posted",
"title": "Window"
}
},
"title": "trending_shortsArguments",
"type": "object"
},
"name": "trending_shorts"
},
{
"description": "Turn a folder's share link off: the old link stops working at once; share_folder\n again makes a new one. Same as DELETE /v1/folders/{folder_id}/share. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"folder_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "one of your folders (from list_folders or create_folder)",
"title": "Folder Id"
}
},
"title": "unshare_folderArguments",
"type": "object"
},
"name": "unshare_folder"
},
{
"description": "Change an agent's name or monthly budget, or pause it. Same as PATCH /v1/agents/{agent_id}.",
"inputSchema": {
"properties": {
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Active"
},
"agent_id": {
"title": "Agent Id",
"type": "string"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"monthly_budget": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Monthly Budget"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"required": [
"agent_id"
],
"title": "update_agentArguments",
"type": "object"
},
"name": "update_agent"
},
{
"description": "Change a saved search: its words, line, frequency or email. Same as PATCH\n /v1/alerts/{alert_id}.",
"inputSchema": {
"properties": {
"alert_id": {
"title": "Alert Id",
"type": "string"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"daily_ideas": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Daily Ideas"
},
"email": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"frequency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Frequency"
},
"min_multiple": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Multiple"
},
"min_vph": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Min Vph"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Query"
}
},
"required": [
"alert_id"
],
"title": "update_alertArguments",
"type": "object"
},
"name": "update_alert"
},
{
"description": "Rename a tracker, share it, change its alert lines, or turn its daily ideas on. Same as\n PATCH /v1/trackers/{tracker_id}.",
"inputSchema": {
"properties": {
"alert_email": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Alert Email"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"daily_ideas": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Daily Ideas"
},
"multiple_threshold": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Multiple Threshold"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"tracker_id": {
"title": "Tracker Id",
"type": "string"
},
"visibility": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Visibility"
},
"vph_threshold": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Vph Threshold"
}
},
"required": [
"tracker_id"
],
"title": "update_trackerArguments",
"type": "object"
},
"name": "update_tracker"
},
{
"description": "Your credits and what you have spent: credits (balance now), spent_total,\n reserved_now (credits held by runs still in flight, refunded in part when they\n finish), runs_total, last_30_days (one entry per UTC day: date, runs, charged) and\n recent (your 20 newest runs). Same shape as GET /v1/usage. Free.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
}
},
"title": "usageArguments",
"type": "object"
},
"name": "usage"
},
{
"description": "Badges for up to 50 YouTube videos at once, as the Chrome extension shows them on every\n card: views, the multiple over the channel's usual views (long against long uploads, Shorts\n against Shorts) with its band, and views per hour with its basis. Ids with no badge are in\n unread with why. Free. Same as GET /v1/videos/badges.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"ids": {
"description": "1 to 50 YouTube video ids",
"items": {
"type": "string"
},
"title": "Ids",
"type": "array"
}
},
"required": [
"ids"
],
"title": "video_badgesArguments",
"type": "object"
},
"name": "video_badges"
},
{
"description": "Everything the index knows about one video: the multiple, views per hour and its\n history, real tags, title and thumbnail changes, our reads, similar videos. Free. Same as\n GET /v1/videos/{video_id}/scorecard.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"video_id": {
"description": "an 11-character YouTube id",
"title": "Video Id",
"type": "string"
}
},
"required": [
"video_id"
],
"title": "video_scorecardArguments",
"type": "object"
},
"name": "video_scorecard"
},
{
"description": "A video's views per hour and its history from the shared index (new, rising and\n tracked videos read hourly, the rest daily); a video the index lacks is read now. Free.\n Same as GET /v1/videos/{video_id}/stats.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"video_id": {
"description": "an 11-character YouTube id",
"title": "Video Id",
"type": "string"
}
},
"required": [
"video_id"
],
"title": "video_statsArguments",
"type": "object"
},
"name": "video_stats"
},
{
"description": "What an invite joins, before accepting: the team's name, who invited you, its seats,\n when the link expires, and whether you are signed in with the invited email (null for an\n account with no email). Free. Same as GET /v1/team/invites/{token}.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"token": {
"description": "the hdt_... token, the part of the link after #",
"title": "Token",
"type": "string"
}
},
"required": [
"token"
],
"title": "view_team_inviteArguments",
"type": "object"
},
"name": "view_team_invite"
},
{
"description": "Vote on a poll with the slot you picked, and an optional reason. One vote an account, never\n on your own or your team's poll. Answers the shares so far. Free. Same as POST\n /v1/polls/{poll_id}/vote.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"poll_id": {
"description": "the poll's id",
"title": "Poll Id",
"type": "string"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional: why, at most 140 characters",
"title": "Reason"
},
"slot": {
"description": "the slot you picked in next_poll's answer",
"title": "Slot",
"type": "integer"
}
},
"required": [
"poll_id",
"slot"
],
"title": "vote_pollArguments",
"type": "object"
},
"name": "vote_poll"
},
{
"description": "A webhook's deliveries, newest first, with status and your URL's answers. Same as\n GET /v1/webhooks/{webhook_id}/deliveries.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"limit": {
"default": 50,
"maximum": 200,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"webhook_id": {
"title": "Webhook Id",
"type": "string"
}
},
"required": [
"webhook_id"
],
"title": "webhook_deliveriesArguments",
"type": "object"
},
"name": "webhook_deliveries"
},
{
"description": "Hook Creator (1 credit): an opening for your subject as beats with seconds counted from their words and a shot plan per line (said, shown, on screen, sound, delivery), labelled as written. Same as POST /v1/openings.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"hook_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Hook Type"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Subject"
}
},
"title": "write_hookArguments",
"type": "object"
},
"name": "write_hook"
},
{
"description": "Write ideas for new videos: each a title, a thumbnail concept (one visible action)\n and the words to print, built on one to three real outliers (based_on, each with its\n video_id, title, multiple, find_id and bend niche when it came from another niche).\n constraints are rules every idea keeps (said in fits). band (10x, 5x, 2x) is the median\n multiple of the finds behind the idea, never a predicted view count. label: written by\n Hook Detector. 1 credit, refunded when the writing fails; fewer than 5 outliers known is\n 422 too_few_outliers and costs nothing. Same as POST /v1/ideas; remix_find makes one\n find yours.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"constraints": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "rules every idea keeps, up to 200 characters (\"low budget\")",
"title": "Constraints"
},
"content_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "for a topic: long (default) or short",
"title": "Content Type"
},
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "3 to 12 ideas (default 6)",
"title": "Count"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a finished Packaging or Long form run of yours: its finds, direct and bent, are the sources",
"title": "Run Id"
},
"topic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "the subject, 3 to 300 characters (the outliers come from the shared index); send this or run_id",
"title": "Topic"
}
},
"title": "write_ideasArguments",
"type": "object"
},
"name": "write_ideas"
},
{
"description": "Script Writer (10 credits): hooks, the plan's sections with re-hooks and payoffs, the script, its runtime counted from its words, machine-sounding lines flagged, a fact-check list, Markdown. Runs as a job (get_call reads it). Same as POST /v1/scripts.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"audience": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Audience"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"minutes": {
"default": 8,
"title": "Minutes",
"type": "integer"
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Subject"
}
},
"title": "write_scriptArguments",
"type": "object"
},
"name": "write_script"
},
{
"description": "Write 20 to 40 titles for your video, each borrowing the device and structure of one\n real outlier (a video that beat its own channel): the finds of one of your runs, or the\n shared index's videos nearest your topic by meaning. Each title: title, chars, first_40\n (what a phone feed surely shows), device, borrows, and from (the real outlier: video_id,\n title, channel, multiple, find_id). best: the five whose outlier beat its channel the\n most among the devices the outliers share (best_basis says so; never a predicted\n click-through rate). label: written by Hook Detector, never a real video's title.\n Costs 1 credit, refunded when the writing fails; fewer than 5 outliers known is 422\n too_few_outliers and costs nothing (run find_packaging on the topic first). Same as POST\n /v1/titles. Read it back with get_call.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"channel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "optional @handle whose style to write in",
"title": "Channel"
},
"content_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "for a topic: long (default) or short",
"title": "Content Type"
},
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "20 to 40 titles (default 20)",
"title": "Count"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a finished Packaging or Long form run of yours: its finds are the sources",
"title": "Run Id"
},
"topic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "the subject of your video, 3 to 300 characters (the outliers come from the shared index); send this or run_id",
"title": "Topic"
}
},
"title": "write_titlesArguments",
"type": "object"
},
"name": "write_titles"
},
{
"description": "The upload pack (1 credit) for a long find or your video: a description with chapters that pass YouTube's rules, tags and hashtags. Runs as a job. Same as POST /v1/seo.",
"inputSchema": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"find_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Find Id"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "1 to 255 visible ASCII characters; the same key and request within 24 hours answer the saved remix and charge nothing; the same key with another request is 422 idempotency_key_reused",
"title": "Idempotency Key"
},
"links": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Links"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "a YouTube link: watch, youtu.be or shorts address",
"title": "Url"
}
},
"title": "write_upload_packArguments",
"type": "object"
},
"name": "write_upload_pack"
}
]
}What the leaf hashes
{"body":"8275b1125533bf9ae6be3352090ece6d96028c10729a8e6a76905447415404d1","id":528315,"kind":"mcp.tools","method":"probe.mcp/1","observed_us":1793125082538222,"prev":null,"subject":"2ad83249-f134-4b1a-963d-962bbb191644","subject_kind":"endpoint"}Proof
Fold these into the leaf in order, hashing each sorted pair with keccak256, to reach the root of (273461 rows).
- 0x7be8f81fc217c4f1482537e8c36815822798946fc56b362c0dedb0bd06ae71e1
- 0x766dce4188b06a1290b9aaecf3a9ac156903710580e731b7f08eea21600e3e18
- 0xf1971a42adb814d3dd13046538a1237785a4af7866a28f3d9328b65512a672d9
- 0x8d15b9f8e656d348bbecd77b9c8ce6be617b17d1b846e05542329c157a4f684c
- 0xc0dfe4c2f606487f0569f0c9c22f5e4324740ece7dece218d0173ae06a493de8
- 0x49cef7ff0824ecd50c5a1d097c8ec1aa35cba9cc76fd46f811cca125b00c2ac2
- 0x274d8c971c6474b0c2caf6f58708c34ac08ff71618a2e09e90e4eb6c4cd523a8
- 0x528fcc25cb3c098a2d42da2f95a24ae5e6930f885da403b48798a74fe4d4f76b
- 0xcaa3cd39e172d947864f060f26eb0093c07628b5cca770771517ecf1c2501034
- 0x095618cc841c9a61c0e81672714f71ed9d27ed4faae85c5db68bd50c0e7e1fff
- 0x5fc4b0a456927c5c4428f8a799b89307f1fd731fdb306738036ae0bbf1f21fd8
- 0x98815e62072eb9319b52d9744169ae17850c056887ffbb325e7f2f9ed317a6a0
- 0xbc7cf10ae301dcdbc5db5be8c29e1b3618ffaf1c196a74cb6a9e6c4fae0bbeed
- 0xfa0c8e8f1a1710ff197533b0a28208f2e168afe71abb7bb3416e09d1ac371d60
- 0x3c500ec3d3edf0c74b87a6ca8fcd77656bfbe03db3d478bd0c184d0c88839c6b
- 0xfecf3d4646dd4984a13dd715499e842c3fde63692336d97394c2bfd8e877ca5d
- 0xf30fddbf4811226c58e8f0daf36fddd79fc5f1356b592bb1d99a8061ddbabe66
- 0x2bf8151e5f157dd183b9de6fa00469551932a7a6e3f33a694895000ac9061197
- 0x9fc354c0ea3efc3f1b6548bb77ea902a50f2c9647647ea61592efce2bd795699
- Day root
- 0xdd77e5e99da32c3f154180d63e3c3e6fe11e896a2c6896412ef6b5c4bcf7e795
- Chained
- 0x23bb4dfd09f55c15ac3962f53578e02c6114d5bfd9bb451cf8794fb6e2817ef4
- Published
- On Arc Testnet, block 69414147: 0xb2ebd83aafeb765a0ce66e76aefb133ed06606c98038fd56191e2bcd1dcb77b4