Product operations
The exact operations served by this product and its model tools.
Create a project with POST /api/v1/projects. Include setup: true to run setup in the same call; the response includes setup.task with durable run and stream handles. Omit the flag for manual configuration.
The OpenAPI document and operation catalog come from the same declaration as these routes and tools.
Contract hash: 67f091a05d00007752358b3fca04aca40728a4ec47046633e90f502a0ef98e0c.
| HTTP | Action | Model tool |
| --- | --- | --- |
| GET /api/v1/analytics/{id} | get Analytics. Measured outcomes per period — what the loop earned. | analytics_get |
| GET /api/v1/analytics | list Analytics. Measured outcomes per period — what the loop earned. | analytics_list |
| GET /api/v1/blockers/{id} | get Blockers. Active upstream blockers — server-stamped, cleared by the event that unblocks. | blockers_get |
| GET /api/v1/blockers | list Blockers. Active upstream blockers — server-stamped, cleared by the event that unblocks. | blockers_list |
| POST /api/v1/campaign-agent-runs | create Agent Runs. One batch of work by a campaign agent — a run is the unit drafts group by. | campaign_agent_runs_create |
| GET /api/v1/campaign-agent-runs/{id} | get Agent Runs. One batch of work by a campaign agent — a run is the unit drafts group by. | campaign_agent_runs_get |
| GET /api/v1/campaign-agent-runs | list Agent Runs. One batch of work by a campaign agent — a run is the unit drafts group by. | campaign_agent_runs_list |
| PATCH /api/v1/campaign-agent-runs/{id} | update Agent Runs. One batch of work by a campaign agent — a run is the unit drafts group by. | campaign_agent_runs_update |
| POST /api/v1/campaign-agents/{id}/events | Append an event to Agents | campaign_agents_append_event |
| POST /api/v1/campaign-agents/{agent_id}/approve | Activate a campaign agent for ongoing work | HTTP only |
| POST /api/v1/campaign-agents | create Agents. The actors: each campaign agent is one ICP cell × content × provider, and whether it is on. | campaign_agents_create |
| GET /api/v1/campaign-agents/{id}/events | Read events for Agents | campaign_agents_events |
| GET /api/v1/campaign-agents/{id} | get Agents. The actors: each campaign agent is one ICP cell × content × provider, and whether it is on. | campaign_agents_get |
| GET /api/v1/campaign-agents | list Agents. The actors: each campaign agent is one ICP cell × content × provider, and whether it is on. | campaign_agents_list |
| GET /api/v1/campaign-agents/{agent_id}/performance | Query one campaign agent's performance and costs | campaign_agents_performance |
| POST /api/v1/campaign-agents/{agent_id}/runs | Run a campaign agent to research leads and prepare drafts | campaign_agents_run |
| POST /api/v1/campaign-agents/runs | Run the campaign planner across active agents | campaign_agents_run_all |
| PATCH /api/v1/campaign-agents/{id} | update Agents. The actors: each campaign agent is one ICP cell × content × provider, and whether it is on. | campaign_agents_update |
| POST /api/v1/companies/{id}/events | Append an event to Companies | companies_append_event |
| POST /api/v1/companies | create Companies. Target accounts your campaign agents research and work. | companies_create |
| GET /api/v1/companies/{id}/events | Read events for Companies | companies_events |
| GET /api/v1/companies/{id} | get Companies. Target accounts your campaign agents research and work. | companies_get |
| GET /api/v1/companies | list Companies. Target accounts your campaign agents research and work. | companies_list |
| PATCH /api/v1/companies/{id} | update Companies. Target accounts your campaign agents research and work. | companies_update |
| POST /api/v1/content/{id}/events | Append an event to Content | content_append_event |
| POST /api/v1/content | create Content. Reusable message and image templates campaign agents draft from. | content_create |
| GET /api/v1/content/{id}/events | Read events for Content | content_events |
| POST /api/v1/content/generations | Generate reusable content | content_generate |
| GET /api/v1/content/{id} | get Content. Reusable message and image templates campaign agents draft from. | content_get |
| GET /api/v1/content | list Content. Reusable message and image templates campaign agents draft from. | content_list |
| PATCH /api/v1/content/{id} | update Content. Reusable message and image templates campaign agents draft from. | content_update |
| POST /api/v1/daily-reports | create Reports. One row per operating day — the plan (which agents send how much under which tag, who is archived, who is born) and one entry per planner run. | daily_reports_create |
| GET /api/v1/daily-reports/{id} | get Reports. One row per operating day — the plan (which agents send how much under which tag, who is archived, who is born) and one entry per planner run. | daily_reports_get |
| GET /api/v1/daily-reports | list Reports. One row per operating day — the plan (which agents send how much under which tag, who is archived, who is born) and one entry per planner run. | daily_reports_list |
| PATCH /api/v1/daily-reports/{id} | update Reports. One row per operating day — the plan (which agents send how much under which tag, who is archived, who is born) and one entry per planner run. | daily_reports_update |
| GET /api/v1/dashboards/{id} | get Dashboards. Metric boards built from your CRM data. | dashboards_get |
| GET /api/v1/dashboards | list Dashboards. Metric boards built from your CRM data. | dashboards_list |
| POST /api/v1/employees | create Employees. The sender personas outreach is written as. | employees_create |
| GET /api/v1/employees/{id} | get Employees. The sender personas outreach is written as. | employees_get |
| GET /api/v1/employees | list Employees. The sender personas outreach is written as. | employees_list |
| PATCH /api/v1/employees/{id} | update Employees. The sender personas outreach is written as. | employees_update |
| POST /api/v1/goals/{id}/events | Append an event to Goals | goals_append_event |
| POST /api/v1/goals | create Goals. What the outreach is for — the number a campaign is trying to move. | goals_create |
| GET /api/v1/goals/{id}/events | Read events for Goals | goals_events |
| GET /api/v1/goals/{id} | get Goals. What the outreach is for — the number a campaign is trying to move. | goals_get |
| GET /api/v1/goals | list Goals. What the outreach is for — the number a campaign is trying to move. | goals_list |
| PATCH /api/v1/goals/{id} | update Goals. What the outreach is for — the number a campaign is trying to move. | goals_update |
| POST /api/v1/integrations | Connect a provider to this project | HTTP only |
| GET /api/v1/integrations | List this project's connected providers | HTTP only |
| GET /api/v1/learnings/{id} | get Learnings. What the agent learned, kept as create/remove facts rather than a decaying score. | learnings_get |
| GET /api/v1/learnings | list Learnings. What the agent learned, kept as create/remove facts rather than a decaying score. | learnings_list |
| POST /api/v1/link-codes/{id}/events | Append an event to Link Codes | link_codes_append_event |
| GET /api/v1/link-codes/{id}/events | Read events for Link Codes | link_codes_events |
| GET /api/v1/link-codes/{id} | get Link Codes. One row per minted outbound link code — who it was minted for, where it redirects, and the click/visit/convert truth the dash-links worker stamps. | link_codes_get |
| GET /api/v1/link-codes | list Link Codes. One row per minted outbound link code — who it was minted for, where it redirects, and the click/visit/convert truth the dash-links worker stamps. | link_codes_list |
| POST /api/v1/link-domains/{id}/events | Append an event to Tracking Domains | link_domains_append_event |
| GET /api/v1/link-domains/{id}/events | Read events for Tracking Domains | link_domains_events |
| GET /api/v1/link-domains/{id} | get Tracking Domains. Tracking hosts for outbound links — pending until the dash-links worker answers on the host, verified after, retired instead of deleted. | link_domains_get |
| GET /api/v1/link-domains | list Tracking Domains. Tracking hosts for outbound links — pending until the dash-links worker answers on the host, verified after, retired instead of deleted. | link_domains_list |
| POST /api/v1/lists | create Lists. Saved groups of people and companies one campaign run works. | lists_create |
| GET /api/v1/lists/{id} | get Lists. Saved groups of people and companies one campaign run works. | lists_get |
| GET /api/v1/lists | list Lists. Saved groups of people and companies one campaign run works. | lists_list |
| PATCH /api/v1/lists/{id} | update Lists. Saved groups of people and companies one campaign run works. | lists_update |
| GET /api/v1/metric-records/{id} | get Metrics. Stored metric values — one row per (owner, key), newest write wins. | metric_records_get |
| GET /api/v1/metric-records | list Metrics. Stored metric values — one row per (owner, key), newest write wins. | metric_records_list |
| POST /api/v1/outbox/{id}/events | Append an event to Outbox | outbox_append_event |
| POST /api/v1/outbox/{draft_id}/approve | Approve and send a draft through its connected provider | HTTP only |
| POST /api/v1/outbox | create Outbox. The one outbound record — every message from creation to engagement, on two states: draft → sent (opened/clicked/replied/bounced refine it) | failed (+ declined). You always create rows at status draft; Approve or a live agent's mint SENDS right then, and each row ends sent or failed with the reason on it. Writing declined/sent yourself is refused at the boundary (outbox_status_requires_dash_action). | outbox_create |
| GET /api/v1/outbox/{id}/events | Read events for Outbox | outbox_events |
| GET /api/v1/outbox/{id} | get Outbox. The one outbound record — every message from creation to engagement, on two states: draft → sent (opened/clicked/replied/bounced refine it) | failed (+ declined). You always create rows at status draft; Approve or a live agent's mint SENDS right then, and each row ends sent or failed with the reason on it. Writing declined/sent yourself is refused at the boundary (outbox_status_requires_dash_action). | outbox_get |
| GET /api/v1/outbox | list Outbox. The one outbound record — every message from creation to engagement, on two states: draft → sent (opened/clicked/replied/bounced refine it) | failed (+ declined). You always create rows at status draft; Approve or a live agent's mint SENDS right then, and each row ends sent or failed with the reason on it. Writing declined/sent yourself is refused at the boundary (outbox_status_requires_dash_action). | outbox_list |
| PATCH /api/v1/outbox/{id} | update Outbox. The one outbound record — every message from creation to engagement, on two states: draft → sent (opened/clicked/replied/bounced refine it) | failed (+ declined). You always create rows at status draft; Approve or a live agent's mint SENDS right then, and each row ends sent or failed with the reason on it. Writing declined/sent yourself is refused at the boundary (outbox_status_requires_dash_action). | outbox_update |
| POST /api/v1/pages/{id}/events | Append an event to Pages | pages_append_event |
| POST /api/v1/pages | create Pages. Landing pages — indexed from the customer's site, or built from typed blocks, scored by the same engagement stamp as content. | pages_create |
| GET /api/v1/pages/{id}/events | Read events for Pages | pages_events |
| GET /api/v1/pages/{id} | get Pages. Landing pages — indexed from the customer's site, or built from typed blocks, scored by the same engagement stamp as content. | pages_get |
| GET /api/v1/pages | list Pages. Landing pages — indexed from the customer's site, or built from typed blocks, scored by the same engagement stamp as content. | pages_list |
| PATCH /api/v1/pages/{id} | update Pages. Landing pages — indexed from the customer's site, or built from typed blocks, scored by the same engagement stamp as content. | pages_update |
| POST /api/v1/people/{id}/events | Append an event to People | people_append_event |
| POST /api/v1/people | create People. The individuals Moab may draft outreach for. | people_create |
| GET /api/v1/people/{id}/events | Read events for People | people_events |
| GET /api/v1/people/{id} | get People. The individuals Moab may draft outreach for. | people_get |
| GET /api/v1/people | list People. The individuals Moab may draft outreach for. | people_list |
| PATCH /api/v1/people/{id} | update People. The individuals Moab may draft outreach for. | people_update |
| GET /api/v1/performance | Query project performance and costs | performance_query |
| GET /api/v1/preferences/{id} | get Preferences. Per-project dashboard state (notification read/cleared markers). | preferences_get |
| GET /api/v1/preferences | list Preferences. Per-project dashboard state (notification read/cleared markers). | preferences_list |
| POST /api/v1/products/{id}/events | Append an event to Products | products_append_event |
| POST /api/v1/products | create Products. What you sell — the context every draft is written from. | products_create |
| GET /api/v1/products/{id}/events | Read events for Products | products_events |
| GET /api/v1/products/{id} | get Products. What you sell — the context every draft is written from. | products_get |
| GET /api/v1/products | list Products. What you sell — the context every draft is written from. | products_list |
| PATCH /api/v1/products/{id} | update Products. What you sell — the context every draft is written from. | products_update |
| POST /api/v1/projects/{project_id}/setup | Set up the project with AI | projects_setup |
| GET /api/v1/projects/{project_id}/setup | Read setup evidence and missing requirements | projects_setup_status |
| POST /api/v1/sequences | create Sequences. Multi-touch cadences: the steps a campaign agent walks a person through. | sequences_create |
| GET /api/v1/sequences/{id} | get Sequences. Multi-touch cadences: the steps a campaign agent walks a person through. | sequences_get |
| GET /api/v1/sequences | list Sequences. Multi-touch cadences: the steps a campaign agent walks a person through. | sequences_list |
| PATCH /api/v1/sequences/{id} | update Sequences. Multi-touch cadences: the steps a campaign agent walks a person through. | sequences_update |
| POST /api/v1/skill-imports | Import an immutable skill revision | skills_import |
| GET /api/v1/skill-revisions/{revision_id} | Read and verify an immutable skill revision | skills_revision |
| POST /api/v1/tasks/{task_id}/cancel | Cancel a task's active run | tasks_cancel |
| GET /api/v1/tasks/{task_id} | Read a task with its latest run receipt | tasks_get |
| GET /api/v1/tasks/{task_id}/runs | List a task's run receipts | tasks_runs |
| GET /api/v1/timeline-events/{id} | get Timeline Events. The append-only record of what happened to an object. | timeline_events_get |
| GET /api/v1/timeline-events | list Timeline Events. The append-only record of what happened to an object. | timeline_events_list |
Write retries use Idempotency-Key. Changing input under the same key returns 409. An unfinished acknowledgement remains a named operation_in_progress conflict; never retry it under a new key without inspecting the resource.
Review configuration edits require If-Match with the current quoted revision. A run executes its saved revision; subsequent edits change the next attempt.