SMOC REST v2 API-referens

REST v2 är det publika HTTP-API:et för företagsdata. Alla domänverktyg använder samma JSON-body som motsvarande MCP-verktyg. Kundnycklar är endast läsbara som standard och är begränsade till ditt företag. Nycklar med skrivbehörighet kan använda de begränsade skrivverktygen nedan. GET /api/company/mongocontact är oförändrad för Zapier.

Bas-URL

https://api.smoc.ai

Maskinläsbar katalog: GET /api/v2 eller GET /api/v2/openapi.json.

Autentisering

Skicka en nyckel från Inställningar → Integrationer → API (eller MCP) som Authorization: Bearer <key> eller den äldre token-headern.

curl -s -X POST https://api.smoc.ai/api/v2/whoami \
  -H "Authorization: Bearer YOUR_SMOC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Använd inte Clerk sk_… eller pk_…-nycklar.

Struktur

POST /api/v2/{toolName} med Content-Type: application/json.

Lyckad förfrågan ger HTTP 200 med ett JSON-objekt. Fel ger 4xx med { "code", "error", "details?" }. Vanliga koder: MISSING_BEARER_TOKEN, INVALID_INPUT, TOOL_DENIED, FLOWCHART_NOT_FOUND.

Kundnycklar skickar inte companyId. Nyckeln väljer redan företaget.

GET|POST /api/v2/whoami finns på REST. Upptäcktsverktygen mcp_capabilities, skills_search och skills_get finns endast på MCP (https://api.smoc.ai/mcp).

Identitet

GET|POST /api/v2/whoami

Returnerar roll, företagsscope, behörigheter, token-typ och miljö. Body är valfri.

Företag

Anrop	Body	Returnerar
POST /api/v2/companies_get	{}	Företagsprofil (titel, nyckel, URL, språk, inställningar)
POST /api/v2/company_assets_get	{}	Produkter, positionering, webbplatslänkar, filer
POST /api/v2/settings_notifications_get	{}	Sammanfattning av notifikationsinställningar (inga e-postadresser)

Företagstillgångsextraktioner

Behörighet: company:read eller cpcs:read.

Anrop	Body	Returnerar
POST /api/v2/company_asset_extraction_results_list	limit? (1–100), includeData?, statuses?, templateNameKey?, tag?	Sammanfattningar av extraktionsresultat
POST /api/v2/company_asset_extraction_results_get	resultId (obligatorisk), includeData?	Ett resultat
POST /api/v2/company_asset_extraction_templates_list	limit?, templateNameKey?, tag?	Sammanfattningar av mall / tagg / färskhet

Kontakter

Behörighet: contacts:read.

Anrop	Body	Returnerar
POST /api/v2/contacts_search	Filtren nedan, plus page?, pageSize? (1–100), sortBy?, sortDirection? (asc | desc)	Paginering av kontakter
POST /api/v2/contacts_get	contactId (obligatorisk)	En sanerad kontakt
POST /api/v2/contacts_get_stats	Samma filter som sökning (ingen sida)	Antal och engagemangssammanfattning
POST /api/v2/contacts_get_filter_options	Samma filter, plus optionLimit? (1–200)	Giltiga filtervärden
POST /api/v2/contact_tags_list	{}	Kontakt-taggar
POST /api/v2/prospect_lists_list	{}	Prospektlistor
POST /api/v2/prospect_lists_get	listId (obligatorisk)	En prospektlista

Kontaktfilter (alla valfria): dateFrom, dateTo (YYYY-MM-DD), search (max 200), location, flow, surveyQuestionAnswer, promosRedeemed, profileInfo, device, os, browser, utmSource, utmMedium, utmCampaign (sträng eller array upp till 50), surveyLanguage, firstName, lastName, msisdn, company, city, street, zip, brandId, status.

sortBy: createdAt, updatedAt, lastConversationDate, email, firstName, lastName, company, city, status.

curl -s -X POST https://api.smoc.ai/api/v2/contacts_search \
  -H "Authorization: Bearer YOUR_SMOC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"search":"ada","pageSize":20,"sortBy":"updatedAt","sortDirection":"desc"}'

Zapier / kompatibla kontakter förblir GET /api/company/mongocontact med token-headern. Fältnivåer för mongokontakter: Publikt Kontakts-API.

Inkorg och konversationer

Behörighet: inbox:read för läsning. Nycklar med skrivbehörighet behöver även inbox:write för triagering och textsändning.

Anrop	Body	Returnerar
POST /api/v2/inbox_threads_list	q?, sender?, flowId?, contactId?, companyUserId?, conversationId?, inboxFolder? (inbox | archived | all), unreadOnly?, unansweredOnly?, page?, limit? (1–50)	Trådar
POST /api/v2/inbox_threads_get	threadId (obligatorisk), includeMessages?	En tråd
POST /api/v2/inbox_messages_list	threadId (obligatorisk), limit? (1–200)	Meddelanden, inklusive sammanslagna peer-trådar
POST /api/v2/conversations_list	flowId?, contactId?, conversationId?, q?, page?, limit? (1–50)	Meddelandeflödes-körningar
POST /api/v2/conversations_get	conversationId (obligatorisk)	En körning, inklusive milstolpar
POST /api/v2/inbox_threads_archive	threadId	Arkiverar en tråd
POST /api/v2/inbox_threads_unread	threadId	Markerar en tråd som oläst
POST /api/v2/inbox_threads_mark_handled	threadId	Markerar obesvarade som hanterade
POST /api/v2/inbox_threads_send	threadId, body, idempotencyKey	Skickar ett svar med endast text

curl -s -X POST https://api.smoc.ai/api/v2/inbox_threads_list \
  -H "Authorization: Bearer YOUR_SMOC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"unansweredOnly":true,"limit":25}'

Outreach

Anrop	Behörighet	Body	Returnerar
POST /api/v2/outreach_accounts_list	inbox:read	{}	LinkedIn / outreach-kontostatus
POST /api/v2/outreach_contacts_import_get	contacts:read	importJobId (obligatorisk)	Kontaktimport / enrichment-jobbstatus

Flödesscheman och Studio

Behörighet: flowcharts:read. Använd uniqueFlowchartId från flowcharts_list som flowchartId när ett katalognummer saknas.

Anrop	Body	Returnerar
POST /api/v2/flowcharts_list	name?, operatorKey?, conversationTemplateKey?, status? (draft | published), page?, limit? (1–100)	Flödesschemasammanfattningar
POST /api/v2/flowcharts_get	flowchartId (obligatorisk), detail? (summary | full)	Ett flödesschema (full inkluderar grafen)
POST /api/v2/flowchart_recommendations_list	flowchartId (obligatorisk)	Rekommendationsdokument
POST /api/v2/flowcharts_versions_list	flowchartId (obligatorisk)	Versions-id, datum, status
POST /api/v2/themes_get	operatorKey?	Tema för företaget (eller operatörsnyckel)
POST /api/v2/message_flow_settings_get	flowchartId (obligatorisk)	Meddelandeflöde- / konversationstemplatens inställningar
POST /api/v2/message_flow_settings_summary	flowchartId (obligatorisk)	Kanal-id, språk, aktiv-flagga
POST /api/v2/message_flow_contacts_list	flowchartId (obligatorisk)	Senaste konversationer / kontakt-rader
POST /api/v2/message_flow_kpis_get	flowchartId (obligatorisk)	Totalt antal konversationer
POST /api/v2/targeting_portfolios_list	flowchartId (obligatorisk)	Inriktningsportföljer
POST /api/v2/targeting_portfolios_get	portfolioId (obligatorisk)	En portfölj
POST /api/v2/studio_generations_get	jobId (obligatorisk; generationId accepteras också)	Genereringsjobb
POST /api/v2/studio_translations_get	jobId (obligatorisk; translationId accepteras också)	Översättningsjobb
POST /api/v2/studio_generation_categories_list	executionFlowType? (web | message)	Genereringskategorier för den flödestypen

Superanvändarnycklar med flödesschemaredigering kan även redigera Mongo-utkast. Dessa anrop publicerar inte, växlar inte live eller registrerar första batchen. Publicering sker fortfarande via knapp i Studio eller Console.

Anrop	Body	Returnerar
POST /api/v2/flowcharts_create	name, flowType? (web | message), webFormat? (chat | card)	Ny utkastidentitet
POST /api/v2/flowcharts_duplicate	flowchartId, name?	Kopiera som nytt utkast
POST /api/v2/flowcharts_save	flowchartId, flowchart, expectedRevision?	Sparad utkastrevision
POST /api/v2/flowcharts_restore_version	flowchartId, versionId	Återställt utkast
POST /api/v2/themes_save	operatorKey, operatorChannelKey, theme	Temautkastrevision
POST /api/v2/flowchart_recommendation_item_update	docId, index, status (applied | rejected)	Uppdaterad post
POST /api/v2/targeting_portfolio_update	portfolioId, patch (status?, provider?, dimensions?)	Uppdaterad portfölj

flowcharts_save accepterar flowType web eller message, channel och webFormat chat eller card på grafmetadata. Webbflöden använder kanal chat. Meddelandeflöden använder linkedin, email eller whatsapp. Spara behåller den lagrade aktiv-flaggan.

curl -s -X POST https://api.smoc.ai/api/v2/flowchart_recommendations_list \
  -H "Authorization: Bearer YOUR_SMOC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"flowchartId":"YOUR_UNIQUE_FLOWCHART_ID"}'

Analys

Behörighet: analytics:read. Datum är YYYY-MM-DD. Delade valfria filter: startDate, endDate, flowId, flowVersionId, deviceType, os, country, languageCode, utmSource, utmMedium, utmCampaign.

Anrop	Extra body	Returnerar
POST /api/v2/analytics_flow_list_flows	Delade filter	Flöden rankade efter trafik
POST /api/v2/analytics_flow_kpis	Delade filter	Totalt och förändring från föregående period
POST /api/v2/analytics_flow_timeseries	Delade filter, granularity? (day | month)	Daglig eller månatlig serie
POST /api/v2/analytics_flow_dimension_metrics	Delade filter, dimension (obligatorisk), limit? (1–200)	Uppdelning
POST /api/v2/analytics_flow_filter_values	Delade filter	Giltiga filtervärden
POST /api/v2/edge_visit_counts_get	conversationTemplateId (obligatorisk), startDate?, endDate?	Edge-besöksräkningar

dimension måste vara en av: deviceType, os, country, languageCode, utmSource, utmMedium, utmCampaign, dayOfWeek.

curl -s -X POST https://api.smoc.ai/api/v2/analytics_flow_kpis \
  -H "Authorization: Bearer YOUR_SMOC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"startDate":"2026-08-01","endDate":"2026-08-31"}'

Webbplatsskanning (CPCS)

Behörighet: cpcs:read.

Anrop	Body	Returnerar
POST /api/v2/cpcs_overview	{}	Projekt-, crawl-, extraktions- och schemaöversikt
POST /api/v2/cpcs_urls_list	{}	Webbsida- / länk-URL:er som används för crawls
POST /api/v2/cpcs_crawls_get	crawlId (obligatorisk), projectId?	Ett crawl-jobb
POST /api/v2/cpcs_extractions_get	extractionId (obligatorisk), projectId?	Ett extraktionsjobb
POST /api/v2/cpcs_list_templates	{}	Extraktionsmallar
POST /api/v2/cpcs_schedule_get	{}	Crawl-schema

Skrivningar (opt-in)

Standardnycklar är fortsatt endast läsbara. När du markerar Tillåt begränsade skrivningar i Console kan nyckeln använda create-update för kontakter/taggar/listor, företagsprofil / tillgångsbasics, cpcs_urls_add, flödesschemanamnbyte / rekommendationsstatus, inkorgstriage och inbox_threads_send.

Vad kundnycklar inte kan göra

Kundnycklar med skrivbehörighet kan fortfarande inte radera data, redigera flödesgrafer, publicera flöden, växla live, ändra inriktning, starta kreditkrävande jobb eller skicka LinkedIn-outreachkampanjer. Superanvändarnycklar kan spara flödes- och temautkast samt patcha inriktningsdimensioner på MCP och REST v2; de kan fortfarande inte publicera. GET /api/company/mongocontact är fortsatt Zapier/kompatibelt kontaktkontrakt.

MCP

Samma verktyg är tillgängliga för Claude, Cursor och VS Code på https://api.smoc.ai/mcp. Setup: MCP eGuide. Anslutningsguide: REST-anslutningsguide.

Se även

• Koppla SMOC till REST API
• Publikt Kontakts-API
• MCP för Claude, Cursor och VS Code
• Integrera insamlad kunddata