Skip to content

Start building

MyDeepAgentsMyDeepAgents
Jump toConnectors
All endpoints

Connectors

The catalogue of tools you can connect, with their actions and how they sign in.

get/v1/connectors

List connectors

Needs connection.view

Response200

  • objectstring
    list
  • dataConnector[]
    18 fields
    • idstring
    • objectstring
      connector
    • actionsConnectorAction[]
      8 fields
      • data_classesstring[]
      • descriptionstring
      • idempotencystring
        One ofnativeupsertchecknone
      • input_schemaobject

        Any JSON object.

      • namestring
      • output_schemaobject

        Any JSON object.

      • side_effectsstring
        One ofreadwritedestructive
      • titlestring
    • authstring
      One ofnoneapi_keybasicwebhook_urloauth2custom
    • categorystring
      One ofcrmhelpdeskchatmessagingemailmarketingprojectdocsdeveloperpaymentscommerceformsautomationstorageanalyticshrsearcherplegalfield_servicedatabasecloudsecurityadvertising+4
    • config_schemaobject

      Any JSON object.

    • data_classstring
    • descriptionstring
    • egress_hostsstring[]
    • hipaa_eligibleboolean
    • iconstring
    • namestring
    • oauthConnectorOAuth or null

      How an oauth2 connector signs in: the grant, the OAuth app family it uses, the scopes it asks, and whether the platform has an app for it.

      4 fields
      • appstring
      • grantstring
        One ofauthorization_codeclient_credentials
      • platform_appboolean
      • scopesstring[]
    • secret_schemaobject or null

      Any JSON object.

    • triggersConnectorTrigger[]
      3 fields
      • kindstring
        One ofwebhookpoll
      • namestring
      • output_schemaobject

        Any JSON object.

    • versionstring
    • enginestring or null
      One ofpostgresqlmysqlmariadbsql_servermongodb
    • kindstring
      One ofhttpdatabaseDefault"http"
  • has_moreboolean
  • next_cursorstring or null
  • facetsmap<string, map<string, integer>> or null
  • peoplemap<string, ActorRef> or null
    5 fields
    • idstring or null
    • kindstring
      One ofuserapi_keyservice_accountworkloadend_usersystem
    • namestring or null
    • avatar_versionstring or null
    • emailstring or null
  • total_countinteger or null
  • total_count_exactboolean or null

Status codes

  • 200Successful Response
  • 4XXThe request was refused: the problem says why.
  • 5XXThe API could not answer: the problem says why.
Request
curl "https://api.mydeepagents.com/v1/connectors" \
  -H "Authorization: Bearer $MDA_API_KEY"
Response · 200
JSON
{
  "object": "list",
  "data": [
    {
      "id": "id",
      "object": "connector",
      "actions": [
        {
          "data_classes": [],
          "description": "Reads new support email and drafts a reply.",
          "idempotency": "native",
          "input_schema": {},
          "name": "Support triage",
          "output_schema": {},
          "side_effects": "read",
          "title": "Support triage"
        }
      ],
      "auth": "none",
      "category": "crm",
      "config_schema": {},
      "data_class": "data class",
      "description": "Reads new support email and drafts a reply.",
      "egress_hosts": [
        "egress host"
      ],
      "engine": "postgresql",
      "hipaa_eligible": true,
      "icon": "icon",
      "kind": "http",
      "name": "Support triage",
      "oauth": {
        "app": "app",
        "grant": "authorization_code",
        "platform_app": true,
        "scopes": [
          "agent.view",
          "agent.run",
          "run.view"
        ]
      },
      "secret_schema": {},
      "triggers": [
        {
          "kind": "webhook",
          "name": "Support triage",
          "output_schema": {}
        }
      ],
      "version": "version"
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "total_count": 1
}
get/v1/connectors/{connector_id}

Get connector

Needs connection.view

Path parameters

  • connector_idstringRequired

Response200

  • idstring
  • objectstring
    connector
  • actionsConnectorAction[]
    8 fields
    • data_classesstring[]
    • descriptionstring
    • idempotencystring
      One ofnativeupsertchecknone
    • input_schemaobject

      Any JSON object.

    • namestring
    • output_schemaobject

      Any JSON object.

    • side_effectsstring
      One ofreadwritedestructive
    • titlestring
  • authstring
    One ofnoneapi_keybasicwebhook_urloauth2custom
  • categorystring
    One ofcrmhelpdeskchatmessagingemailmarketingprojectdocsdeveloperpaymentscommerceformsautomationstorageanalyticshrsearcherplegalfield_servicedatabasecloudsecurityadvertising+4
  • config_schemaobject

    Any JSON object.

  • data_classstring
  • descriptionstring
  • egress_hostsstring[]
  • hipaa_eligibleboolean
  • iconstring
  • namestring
  • oauthConnectorOAuth or null

    How an oauth2 connector signs in: the grant, the OAuth app family it uses, the scopes it asks, and whether the platform has an app for it.

    4 fields
    • appstring
    • grantstring
      One ofauthorization_codeclient_credentials
    • platform_appboolean
    • scopesstring[]
  • secret_schemaobject or null

    Any JSON object.

  • triggersConnectorTrigger[]
    3 fields
    • kindstring
      One ofwebhookpoll
    • namestring
    • output_schemaobject

      Any JSON object.

  • versionstring
  • enginestring or null
    One ofpostgresqlmysqlmariadbsql_servermongodb
  • kindstring
    One ofhttpdatabaseDefault"http"

Status codes

  • 200Successful Response
  • 422The request is not valid: errors[] names each field.
  • 4XXThe request was refused: the problem says why.
  • 5XXThe API could not answer: the problem says why.
Request
curl "https://api.mydeepagents.com/v1/connectors/slack" \
  -H "Authorization: Bearer $MDA_API_KEY"
Response · 200
JSON
{
  "id": "id",
  "object": "connector",
  "actions": [
    {
      "data_classes": [
        "data classe"
      ],
      "description": "Reads new support email and drafts a reply.",
      "idempotency": "native",
      "input_schema": {},
      "name": "Support triage",
      "output_schema": {},
      "side_effects": "read",
      "title": "Support triage"
    }
  ],
  "auth": "none",
  "category": "crm",
  "config_schema": {},
  "data_class": "data class",
  "description": "Reads new support email and drafts a reply.",
  "egress_hosts": [
    "egress host"
  ],
  "engine": "postgresql",
  "hipaa_eligible": true,
  "icon": "icon",
  "kind": "http",
  "name": "Support triage",
  "oauth": {
    "app": "app",
    "grant": "authorization_code",
    "platform_app": true,
    "scopes": [
      "agent.view",
      "agent.run",
      "run.view"
    ]
  },
  "secret_schema": {},
  "triggers": [
    {
      "kind": "webhook",
      "name": "Support triage",
      "output_schema": {}
    }
  ],
  "version": "version"
}

Build with us

Ready for your first call?

Early access is open. Tell us what you want your agents to do, and we will help you get your first key.

Talk to usRead the API guide