SMOC REST v2 API-reference

REST v2 er den offentlige HTTP API til virksomhedsdata. Alle domæneværktøjer bruger samme JSON-body som det tilsvarende MCP-værktøj. Kundetaster er skrivebeskyttede som standard og afgrænset til din virksomhed. Skrivetilladte nøgler kan kalde de begrænsede skriveværktøjer nedenfor. GET /api/company/mongocontact er uændret for Zapier.

Basis-URL

https://api.smoc.ai

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

Godkendelse

Send en nøgle fra Indstillinger → Integrationer → API (eller MCP) som Authorization: Bearer <key> eller den gamle token-header.

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

Brug ikke Clerk sk_… eller pk_… nøgler.

Struktur

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

Succes er HTTP 200 med et JSON-objekt. Fejl er 4xx med { "code", "error", "details?" }. Almindelige koder: MISSING_BEARER_TOKEN, INVALID_INPUT, TOOL_DENIED, FLOWCHART_NOT_FOUND.

Kundetaster sender ikke companyId. Nøglen vælger allerede virksomheden.

GET|POST /api/v2/whoami er på REST. Discovery-værktøjer mcp_capabilities, skills_search og skills_get forbliver kun på MCP (https://api.smoc.ai/mcp).

Identitet

GET|POST /api/v2/whoami

Returnerer rolle, virksomhedsomfang, tilladelser, token-type og miljø. Body er valgfri.

Virksomhed

Kald	Body	Returnerer
POST /api/v2/companies_get	{}	Virksomhedsprofil (titel, nøgle, URL, sprog, indstillinger)
POST /api/v2/company_assets_get	{}	Produkter, positionering, weblink, filer
POST /api/v2/settings_notifications_get	{}	Notifikationspræferencesammendrag (ingen e-mailadresser)

Ekstrahering af virksomhedsaktiver

Tilladelse: company:read eller cpcs:read.

Kald	Body	Returnerer
POST /api/v2/company_asset_extraction_results_list	limit? (1–100), includeData?, statuses?, templateNameKey?, tag?	Ekstraheringsresultat-sammendrag
POST /api/v2/company_asset_extraction_results_get	resultId (påkrævet), includeData?	Ét resultat
POST /api/v2/company_asset_extraction_templates_list	limit?, templateNameKey?, tag?	Skabelon / tag / friskhedssammendrag

Kontakter

Tilladelse: contacts:read.

Kald	Body	Returnerer
POST /api/v2/contacts_search	Filtre nedenfor, plus page?, pageSize? (1–100), sortBy?, sortDirection? (asc | desc)	Paginering af kontakter
POST /api/v2/contacts_get	contactId (påkrævet)	Én renset kontakt
POST /api/v2/contacts_get_stats	Samme filtre som søgning (ingen side)	Optællinger og engagement-sammendrag
POST /api/v2/contacts_get_filter_options	Samme filtre, plus optionLimit? (1–200)	Gyldige filterværdier
POST /api/v2/contact_tags_list	{}	Kontakt-tags
POST /api/v2/prospect_lists_list	{}	Prospektlister
POST /api/v2/prospect_lists_get	listId (påkrævet)	Én prospektliste

Kontaktfiltre (alle valgfrie): dateFrom, dateTo (YYYY-MM-DD), search (maks 200), location, flow, surveyQuestionAnswer, promosRedeemed, profileInfo, device, os, browser, utmSource, utmMedium, utmCampaign (streng eller array op til 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 / kompatible kontakter forbliver GET /api/company/mongocontact med token-headeren. Felt-niveau mongocontact-strukturer: Offentlig Kontakter API.

Indbakke og samtaler

Tilladelse: inbox:read til læsning. Skrivetilladte nøgler kræver også inbox:write til triage og tekstafsendelse.

Kald	Body	Returnerer
POST /api/v2/inbox_threads_list	q?, sender?, flowId?, contactId?, companyUserId?, conversationId?, inboxFolder? (inbox | archived | all), unreadOnly?, unansweredOnly?, page?, limit? (1–50)	Tråde
POST /api/v2/inbox_threads_get	threadId (påkrævet), includeMessages?	Én tråd
POST /api/v2/inbox_messages_list	threadId (påkrævet), limit? (1–200)	Beskeder, inkl. flettede peer-tråde
POST /api/v2/conversations_list	flowId?, contactId?, conversationId?, q?, page?, limit? (1–50)	Beskedflow-kørsler
POST /api/v2/conversations_get	conversationId (påkrævet)	Én kørsel, inkl. milepæle
POST /api/v2/inbox_threads_archive	threadId	Arkiverer en tråd
POST /api/v2/inbox_threads_unread	threadId	Marker en tråd som ulæst
POST /api/v2/inbox_threads_mark_handled	threadId	Marker ubesvarede som håndteret
POST /api/v2/inbox_threads_send	threadId, body, idempotencyKey	Sender et svar kun med tekst

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

Kald	Tilladelse	Body	Returnerer
POST /api/v2/outreach_accounts_list	inbox:read	{}	LinkedIn / outreach-konto status
POST /api/v2/outreach_contacts_import_get	contacts:read	importJobId (påkrævet)	Kontaktimport / berigelsesjob status

Flowcharts og Studio

Tilladelse: flowcharts:read. Brug uniqueFlowchartId fra flowcharts_list som flowchartId når et katalog numerisk id mangler.

Kald	Body	Returnerer
POST /api/v2/flowcharts_list	name?, operatorKey?, conversationTemplateKey?, status? (draft | published), page?, limit? (1–100)	Flowchart-sammendrag
POST /api/v2/flowcharts_get	flowchartId (påkrævet), detail? (summary | full)	Ét flowchart (full inkluderer grafen)
POST /api/v2/flowchart_recommendations_list	flowchartId (påkrævet)	Anbefalingsdokumenter
POST /api/v2/flowcharts_versions_list	flowchartId (påkrævet)	Versions-id'er, datoer, status
POST /api/v2/themes_get	operatorKey?	Tema for virksomheden (eller operatørnøgle)
POST /api/v2/message_flow_settings_get	flowchartId (påkrævet)	Beskedflow- / samtaleskabelon-indstillinger
POST /api/v2/message_flow_settings_summary	flowchartId (påkrævet)	Kanal-id, sprog, aktiv-flag
POST /api/v2/message_flow_contacts_list	flowchartId (påkrævet)	Seneste samtale- / kontakt-rækker
POST /api/v2/message_flow_kpis_get	flowchartId (påkrævet)	Samtaletotaler
POST /api/v2/targeting_portfolios_list	flowchartId (påkrævet)	Målretningsporteføljer
POST /api/v2/targeting_portfolios_get	portfolioId (påkrævet)	Én portefølje
POST /api/v2/studio_generations_get	jobId (påkrævet; generationId også accepteret)	Genereringsjob
POST /api/v2/studio_translations_get	jobId (påkrævet; translationId også accepteret)	Oversættelsesjob
POST /api/v2/studio_generation_categories_list	executionFlowType? (web | message)	Genereringskategorier for den flowtype

Superbruger-nøgler med flowchart-skrivetilladelse kan også redigere Mongo-kladder. Disse kald udgiver ikke, aktiverer ikke live eller tilmelder ikke første batch. Udgivelse forbliver en knap i Studio eller Console.

Kald	Body	Returnerer
POST /api/v2/flowcharts_create	name, flowType? (web | message), webFormat? (chat | card)	Ny kladdeidentitet
POST /api/v2/flowcharts_duplicate	flowchartId, name?	Kopier som ny kladde
POST /api/v2/flowcharts_save	flowchartId, flowchart, expectedRevision?	Gemt kladdeversion
POST /api/v2/flowcharts_restore_version	flowchartId, versionId	Gendannet kladde
POST /api/v2/themes_save	operatorKey, operatorChannelKey, theme	Tema-kladdeversion
POST /api/v2/flowchart_recommendation_item_update	docId, index, status (applied | rejected)	Opdateret element
POST /api/v2/targeting_portfolio_update	portfolioId, patch (status?, provider?, dimensions?)	Opdateret portefølje

flowcharts_save accepterer flowType web eller message, channel og webFormat chat eller card på graf-metadata. Webforløb bruger kanal chat. Beskedflow bruger linkedin, email eller whatsapp. Gemningen bevarer det lagrede aktiv-flag.

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"}'

Analyse

Tilladelse: analytics:read. Datoer er YYYY-MM-DD. Fælles valgfrie filtre: startDate, endDate, flowId, flowVersionId, deviceType, os, country, languageCode, utmSource, utmMedium, utmCampaign.

Kald	Ekstra body	Returnerer
POST /api/v2/analytics_flow_list_flows	Fælles filtre	Flows rangeret efter trafik
POST /api/v2/analytics_flow_kpis	Fælles filtre	Totaler og ændringer fra tidligere periode
POST /api/v2/analytics_flow_timeseries	Fælles filtre, granularity? (day | month)	Daglig eller månedlig serie
POST /api/v2/analytics_flow_dimension_metrics	Fælles filtre, dimension (påkrævet), limit? (1–200)	Opdeling
POST /api/v2/analytics_flow_filter_values	Fælles filtre	Gyldige filterværdier
POST /api/v2/edge_visit_counts_get	conversationTemplateId (påkrævet), startDate?, endDate?	Edge-besøgsoptællinger

dimension skal være en af: 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"}'

Website-scan (CPCS)

Tilladelse: cpcs:read.

Kald	Body	Returnerer
POST /api/v2/cpcs_overview	{}	Projekt-, crawl-, ekstraherings- og tidsplanoversigt
POST /api/v2/cpcs_urls_list	{}	Webside- / link-URL'er brugt til crawls
POST /api/v2/cpcs_crawls_get	crawlId (påkrævet), projectId?	Ét crawl-job
POST /api/v2/cpcs_extractions_get	extractionId (påkrævet), projectId?	Ét ekstraheringsjob
POST /api/v2/cpcs_list_templates	{}	Ekstraheringsskabeloner
POST /api/v2/cpcs_schedule_get	{}	Crawl-tidsplan

Skrivninger (tilvalg)

Standardnøgler forbliver skrivebeskyttede. Når du markerer Tillad begrænsede skrivninger i Console, kan nøglen kalde kontakter/tags/lister opret-opdater, virksomhedsprofil / aktiver basis, cpcs_urls_add, flowchart omdøbning / anbefalingsstatus, indbakke-triage og inbox_threads_send.

Hvad kundetaster ikke kan

Skrivetilladte kundetaster kan stadig ikke slette data, redigere flowgrafer, udgive flows, slå live til/fra, ændre målretning, starte kreditforbrugende jobs eller sende LinkedIn outreach-kampagner. Superbruger-nøgler kan gemme flow- og temakladder og rette målretningsdimensioner på MCP og REST v2; de kan stadig ikke udgive. GET /api/company/mongocontact forbliver Zapier/kompatible kontakter-kontrakten.

MCP

De samme værktøjer er tilgængelige for Claude, Cursor og VS Code på https://api.smoc.ai/mcp. Opsætning: MCP eGuide. Forbindelsesvejledning: REST forbindelsesguide.

Se også

• Forbind SMOC med REST API'et
• Offentlig Kontakter API
• MCP til Claude, Cursor og VS Code
• Integration af indsamlede kundedata