List available sidekicks

curl --request GET \
  --url https://mm-midmarket-integrations-api-preview.azurewebsites.net/api/integrations/sidekicks \
  --header 'X-API-Key: <api-key>'

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "longDescription": "<string>",
    "icon": "<string>",
    "tags": [],
    "supportedAssetTypes": []
  }
]

API Endpoints

List available sidekicks

List the sidekicks you can select on a submission.

Returns each sidekick’s id, name, description, and the asset types it processes. Use the id values in the sidekickIds of POST /submissions; the supportedAssetTypes tell you which file types each one accepts — an asset whose type no selected sidekick supports is rejected at submit time.

Sidekicks your workspace has deactivated are omitted. Ordered by name.

Authentication: Requires X-API-Key header with valid API key.

GET

api

integrations

sidekicks

List available sidekicks

curl --request GET \
  --url https://mm-midmarket-integrations-api-preview.azurewebsites.net/api/integrations/sidekicks \
  --header 'X-API-Key: <api-key>'

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "longDescription": "<string>",
    "icon": "<string>",
    "tags": [],
    "supportedAssetTypes": []
  }
]

Authorizations

X-API-Key

string

header

default:sk_live_your_api_key_here

required

Workspace-scoped API key. Format: sk_live_{64 hex chars}

Response

200 - application/json

Successful Response

string<uuid>

required

Pass this in the submission's sidekickIds.

name

string

required

Human-readable sidekick name.

description

string

required

Short one-line summary.

longDescription

string

required

Full description of what the sidekick checks.

icon

string

required

Lucide icon name, e.g. 'FileText'.