SMOC REST v2 API-referanse

REST v2 er det offentlige HTTP-API-et for selskapsdata. Alle domeneverktøy bruker samme JSON-body som det tilsvarende MCP-verktøyet. Kundernøkler er skrivebeskyttet som standard og avgrenset til ditt selskap. Nøkler med skrivetilgang kan bruke de begrensede skriveverktøyene nedenfor. GET /api/company/mongocontact er uendret for Zapier.

Grunnleggende URL

https://api.smoc.ai

Maskinlesbar katalog: GET /api/v2 eller GET /api/v2/openapi.json.

Autentisering

Send en nøkkel fra Innstillinger → Integrasjoner → API (eller MCP) som Authorization: Bearer <key> eller den gamle token-headeren.

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

Ikke bruk Clerk sk_… eller pk_…-nøkler.

Struktur

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

Suksess gir HTTP 200 med et JSON-objekt. Feil gir 4xx med { "code", "error", "details?" }. Vanlige koder: MISSING_BEARER_TOKEN, INVALID_INPUT, TOOL_DENIED, FLOWCHART_NOT_FOUND.

Kundernøkler sender ikke companyId. Nøkkelen velger allerede selskapet.

GET|POST /api/v2/whoami er på REST. Oppdagelsesverktøyene mcp_capabilities, skills_search og skills_get forblir kun på MCP (https://api.smoc.ai/mcp).

Identitet

GET|POST /api/v2/whoami

Returnerer rolle, selskapsomfang, tillatelser, token-type og miljø. Body er valgfritt.

Selskap

Kall	Body	Returnerer
POST /api/v2/companies_get	{}	Selskapsprofil (tittel, nøkkel, URL, språk, innstillinger)
POST /api/v2/company_assets_get	{}	Produkter, posisjonering, nettsidelinker, filer
POST /api/v2/settings_notifications_get	{}	Sammendrag av varslingspreferanser (ingen e-postadresser)

Ekstrahering av selskapsressurser

Tillatelse: company:read eller cpcs:read.

Kall	Body	Returnerer
POST /api/v2/company_asset_extraction_results_list	limit? (1–100), includeData?, statuses?, templateNameKey?, tag?	Sammendrag av ekstraksjonsresultater
POST /api/v2/company_asset_extraction_results_get	resultId (påkrevd), includeData?	Ett resultat
POST /api/v2/company_asset_extraction_templates_list	limit?, templateNameKey?, tag?	Sammendrag av mal / tag / ferskhet

Kontakter

Tillatelse: contacts:read.

Kall	Body	Returnerer
POST /api/v2/contacts_search	Filtre nedenfor, pluss page?, pageSize? (1–100), sortBy?, sortDirection? (asc | desc)	Paginert kontaktliste
POST /api/v2/contacts_get	contactId (påkrevd)	Én anonymisert kontakt
POST /api/v2/contacts_get_stats	Samme filtre som søk (ingen side)	Antall og engasjementssammendrag
POST /api/v2/contacts_get_filter_options	Samme filtre, pluss optionLimit? (1–200)	Gyldige filterverdier
POST /api/v2/contact_tags_list	{}	Kontakt-tagger
POST /api/v2/prospect_lists_list	{}	Prospektlister
POST /api/v2/prospect_lists_get	listId (påkrevd)	É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 opptil 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 forblir GET /api/company/mongocontact med token-headeren. Felt-nivå mongokontakt-formater: Offentlig Kontakter-API.

Innboks og samtaler

Tillatelse: inbox:read for lesing. Nøkler med skrivetilgang trenger også inbox:write for triage og tekstsending.

Kall	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åder
POST /api/v2/inbox_threads_get	threadId (påkrevd), includeMessages?	Én tråd
POST /api/v2/inbox_messages_list	threadId (påkrevd), limit? (1–200)	Meldinger, inkludert sammenslåtte peer-tråder
POST /api/v2/conversations_list	flowId?, contactId?, conversationId?, q?, page?, limit? (1–50)	Meldingsflyt-kjøringer
POST /api/v2/conversations_get	conversationId (påkrevd)	Én kjøring, inkludert milepæler
POST /api/v2/inbox_threads_archive	threadId	Arkiverer en tråd
POST /api/v2/inbox_threads_unread	threadId	Marker en tråd som ulest
POST /api/v2/inbox_threads_mark_handled	threadId	Marker ubesvarte som håndtert
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

Kall	Tillatelse	Body	Returnerer
POST /api/v2/outreach_accounts_list	inbox:read	{}	LinkedIn / outreach-kontostatus
POST /api/v2/outreach_contacts_import_get	contacts:read	importJobId (påkrevd)	Kontaktimport / berikelsesjobb-status

Flytskjema og Studio

Tillatelse: flowcharts:read. Bruk uniqueFlowchartId fra flowcharts_list som flowchartId når et katalognummer mangler.

Kall	Body	Returnerer
POST /api/v2/flowcharts_list	name?, operatorKey?, conversationTemplateKey?, status? (draft | published), page?, limit? (1–100)	Flytskjema-sammendrag
POST /api/v2/flowcharts_get	flowchartId (påkrevd), detail? (summary | full)	Ett flytskjema (full inkluderer grafen)
POST /api/v2/flowchart_recommendations_list	flowchartId (påkrevd)	Anbefalingsdokumenter
POST /api/v2/flowcharts_versions_list	flowchartId (påkrevd)	Versjons-IDer, datoer, status
POST /api/v2/themes_get	operatorKey?	Tema for selskapet (eller operatørnøkkel)
POST /api/v2/message_flow_settings_get	flowchartId (påkrevd)	Meldingsflyt- / samtalemal-innstillinger
POST /api/v2/message_flow_settings_summary	flowchartId (påkrevd)	Kanal-ID, språk, aktiv-flagg
POST /api/v2/message_flow_contacts_list	flowchartId (påkrevd)	Siste samtale- / kontakt-rader
POST /api/v2/message_flow_kpis_get	flowchartId (påkrevd)	Samtaletotaler
POST /api/v2/targeting_portfolios_list	flowchartId (påkrevd)	Målrettingsporteføljer
POST /api/v2/targeting_portfolios_get	portfolioId (påkrevd)	Én portefølje
POST /api/v2/studio_generations_get	jobId (påkrevd; generationId også akseptert)	Genereringsjobb
POST /api/v2/studio_translations_get	jobId (påkrevd; translationId også akseptert)	Oversettelsesjobb
POST /api/v2/studio_generation_categories_list	executionFlowType? (web | message)	Genereringskategorier for den flyttypen

Superbrukernøkler med flytskjema-skrivetilgang kan også redigere Mongo-utkast. Disse kallene publiserer ikke, aktiverer ikke live eller melder inn første batch. Publisering forblir en knapp i Studio eller Console.

Kall	Body	Returnerer
POST /api/v2/flowcharts_create	name, flowType? (web | message), webFormat? (chat | card)	Ny utkastidentitet
POST /api/v2/flowcharts_duplicate	flowchartId, name?	Kopier som nytt utkast
POST /api/v2/flowcharts_save	flowchartId, flowchart, expectedRevision?	Lagret utkastrevisjon
POST /api/v2/flowcharts_restore_version	flowchartId, versionId	Gjenopprettet utkast
POST /api/v2/themes_save	operatorKey, operatorChannelKey, theme	Tema-utkastrevisjon
POST /api/v2/flowchart_recommendation_item_update	docId, index, status (applied | rejected)	Oppdatert element
POST /api/v2/targeting_portfolio_update	portfolioId, patch (status?, provider?, dimensions?)	Oppdatert portefølje

flowcharts_save aksepterer flowType web eller message, channel, og webFormat chat eller card på graf-metadata. Nettflyter bruker kanal chat. Meldingsflyter bruker linkedin, email eller whatsapp. Lagre beholder lagret aktiv-flagg.

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

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

Kall	Ekstra body	Returnerer
POST /api/v2/analytics_flow_list_flows	Delte filtre	Flyter rangert etter trafikk
POST /api/v2/analytics_flow_kpis	Delte filtre	Totaler og endringer fra forrige periode
POST /api/v2/analytics_flow_timeseries	Delte filtre, granularity? (day | month)	Daglig eller månedlig serie
POST /api/v2/analytics_flow_dimension_metrics	Delte filtre, dimension (påkrevd), limit? (1–200)	Oppdeling
POST /api/v2/analytics_flow_filter_values	Delte filtre	Gyldige filterverdier
POST /api/v2/edge_visit_counts_get	conversationTemplateId (påkrevd), startDate?, endDate?	Edge-besøksantall

dimension må være én 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"}'

Nettsideskanning (CPCS)

Tillatelse: cpcs:read.

Kall	Body	Returnerer
POST /api/v2/cpcs_overview	{}	Prosjekt-, crawl-, ekstraksjons- og tidsplanoversikt
POST /api/v2/cpcs_urls_list	{}	Nettside- / link-URL-er brukt for crawl
POST /api/v2/cpcs_crawls_get	crawlId (påkrevd), projectId?	Én crawl-jobb
POST /api/v2/cpcs_extractions_get	extractionId (påkrevd), projectId?	Én ekstraksjonsjobb
POST /api/v2/cpcs_list_templates	{}	Ekstraksjonsmaler
POST /api/v2/cpcs_schedule_get	{}	Crawl-tidsplan

Skriving (valgfritt)

Standardnøkler forblir skrivebeskyttet. Når du huker av for Tillat begrenset skriving i Console, kan nøkkelen bruke kontakter/tagger/lister opprett-oppdater, selskapsprofil / ressursbasics, cpcs_urls_add, flytskjema-omdøping / anbefalingsstatus, innboks-triage og inbox_threads_send.

Hva kundernøkler ikke kan gjøre

Nøkler med skrivetilgang kan fortsatt ikke slette data, redigere flytgraf, publisere flyter, aktivere live, endre målretting, starte kredittbelastende jobber eller sende LinkedIn outreach-kampanjer. Superbrukernøkler kan lagre flyt- og temautkast og oppdatere målrettingsdimensjoner på MCP og REST v2; de kan fortsatt ikke publisere. GET /api/company/mongocontact forblir Zapier/kompatible kontakter-kontrakten.

MCP

De samme verktøyene er tilgjengelige for Claude, Cursor og VS Code på https://api.smoc.ai/mcp. Oppsett: MCP eGuide. Tilkoblingsveiledning: REST tilkoblingsguide.

Se også

• Koble SMOC med REST API
• Offentlig Kontakter-API
• MCP for Claude, Cursor og VS Code
• Integrere innsamlede kundedata