Skip to content

Start building

Jump toConnections
All endpoints

Connections

Connected accounts: create, sign in with OAuth, test and run their actions.

get/v1/connections

List connections

Needs connection.view

Newest first. Sorts by created_at, updated_at, name and connector; q searches names, tools (by id or name) and account IDs, or finds a pasted connection ID. Filters, each repeatable: connector, method (how it connects: none, api_key, basic, webhook_url, custom, oauth2 for a sign-in and client_credentials for app credentials), health as people see it (healthy, degraded, unhealthy, revoked, disabled, pending while a secret is tested, sign_in_pending for a sign-in left unfinished), status, data_class, created_by and updated_by (usr_… or sa_…), oauth_app (oap_…, the organization's own sign-in app a connection signed in through), category and category_not (the tools' catalog category, kept or left out: the console's Databases tab and the tools beside it), plus the created and updated time ranges; facets count each of them but oauth_app and the categories.

Query parameters

  • workspace_idstring
  • connectorstring[]
  • methodstring[]
  • healthstring[]
  • statusstring[]
  • data_classstring[]
  • created_bystring[]
  • updated_bystring[]
  • oauth_appstring[]
  • categorystring[]
  • category_notstring[]
  • limitinteger

    Rows per page, 1 to 200.

    Default50at least 1at most 200
  • cursorstring
  • qstring

    Search: rows whose name (or the list's other searchable text) contains this, any case.

    at most 200 characters
  • orderstring

    Sort field; a leading - sorts down. Each list names the fields it sorts by.

    at most 64 charactersmatches ^-?[a-z_]+$
  • includestring[]

    total_count (counted up to 10,000) and facets (a count per filter value).

    One oftotal_countfacets
  • created_afterstring

    Only rows created at or after this time (RFC 3339).

    date-time
  • created_beforestring

    Only rows created at or before this time (RFC 3339).

    date-time
  • updated_afterstring

    Only rows last changed at or after this time (RFC 3339).

    date-time
  • updated_beforestring

    Only rows last changed at or before this time (RFC 3339).

    date-time

Response200

  • objectstring
    list
  • dataConnection[]
    18 fields
    • idstring
    • objectstring
      connection
    • auth_typestring
    • configobject

      Any JSON object.

    • connectorstring
    • connector_versionstring
    • created_atstring
    • data_classstring
    • healthstring
      One ofhealthydegradedunhealthyrevokeddisabled
    • health_reasonstring or null
    • namestring
    • owner_user_idstring
    • row_versioninteger
    • statusstring
      One ofpendingactive
    • updated_atstring
    • workspace_idstring
    • created_byActorRef or null

      Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

      5 fields
      • idstring or null
      • kindstring
        One ofuserapi_keyservice_accountworkloadend_usersystem
      • namestring or null
      • avatar_versionstring or null
      • emailstring or null
    • updated_byActorRef or null

      Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

      5 fields
      • idstring or null
      • kindstring
        One ofuserapi_keyservice_accountworkloadend_usersystem
      • namestring or null
      • avatar_versionstring or null
      • emailstring or null
  • 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
  • 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/connections?limit=20" \
  -H "Authorization: Bearer $MDA_API_KEY"
Response · 200
JSON
{
  "object": "list",
  "data": [
    {
      "id": "con_01jc9ekd74h6eg79ggg89yx7py",
      "object": "connection",
      "auth_type": "auth type",
      "config": {},
      "connector": "slack",
      "connector_version": "connector version",
      "created_at": "2026-11-10T09:30:00.000Z",
      "created_by": {
        "kind": "user",
        "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
        "name": "Ada Lovelace",
        "email": "ada@example.com"
      },
      "data_class": "data class",
      "health": "healthy",
      "health_reason": null,
      "name": "Support triage",
      "owner_user_id": "owner user id",
      "row_version": 4,
      "status": "pending",
      "updated_at": "2026-11-10T09:30:00.000Z",
      "updated_by": {
        "kind": "user",
        "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
        "name": "Ada Lovelace",
        "email": "ada@example.com"
      },
      "workspace_id": "ws_01jccj30nr8ad7mx1yc5v9zx3h"
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "total_count": 1
}
post/v1/connections

Create connection

Needs connection.manage

Request bodyConnectionCreate

  • connectorstringRequired
    at least 1 charactersat most 80 characters
  • namestringRequired
    at least 1 charactersat most 200 characters
  • workspace_idstringRequired
  • configobject

    Any JSON object.

  • secretobject or null

    Any JSON object.

Response201

  • idstring
  • objectstring
    connection
  • auth_typestring
  • configobject

    Any JSON object.

  • connectorstring
  • connector_versionstring
  • created_atstring
  • data_classstring
  • healthstring
    One ofhealthydegradedunhealthyrevokeddisabled
  • health_reasonstring or null
  • namestring
  • owner_user_idstring
  • row_versioninteger
  • statusstring
    One ofpendingactive
  • updated_atstring
  • workspace_idstring
  • created_byActorRef or null

    Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

    5 fields
    • idstring or null
    • kindstring
      One ofuserapi_keyservice_accountworkloadend_usersystem
    • namestring or null
    • avatar_versionstring or null
    • emailstring or null
  • updated_byActorRef or null

    Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

    5 fields
    • idstring or null
    • kindstring
      One ofuserapi_keyservice_accountworkloadend_usersystem
    • namestring or null
    • avatar_versionstring or null
    • emailstring or null

Status codes

  • 201Successful 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 -X POST "https://api.mydeepagents.com/v1/connections" \
  -H "Authorization: Bearer $MDA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "config": {},
    "connector": "slack",
    "name": "Support triage",
    "secret": {},
    "workspace_id": "ws_01jccj30nr8ad7mx1yc5v9zx3h"
  }'
Response · 201
JSON
{
  "id": "con_01jc9ekd74h6eg79ggg89yx7py",
  "object": "connection",
  "auth_type": "auth type",
  "config": {},
  "connector": "slack",
  "connector_version": "connector version",
  "created_at": "2026-11-10T09:30:00.000Z",
  "created_by": {
    "kind": "user",
    "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
    "name": "Ada Lovelace",
    "email": "ada@example.com"
  },
  "data_class": "data class",
  "health": "healthy",
  "health_reason": null,
  "name": "Support triage",
  "owner_user_id": "owner user id",
  "row_version": 4,
  "status": "pending",
  "updated_at": "2026-11-10T09:30:00.000Z",
  "updated_by": {
    "kind": "user",
    "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
    "name": "Ada Lovelace",
    "email": "ada@example.com"
  },
  "workspace_id": "ws_01jccj30nr8ad7mx1yc5v9zx3h"
}
post/v1/connections/oauth/start

Start OAuth

Needs connection.manage

Step 1 to 3 of section 8.2: a pending connection and the vendor's consent URL. The console binds the returned state to the browser in a sealed cookie.

Request bodyOAuthStartRequest

  • connectorstringRequired
    at least 1 charactersat most 80 characters
  • namestringRequired
    at least 1 charactersat most 200 characters
  • workspace_idstringRequired
  • configobject

    Any JSON object.

  • oauth_appstring
    Default"platform"at least 1 charactersat most 40 characters

Response201

  • objectstring
    oauth_start
  • authorization_urlstring
  • connectionConnection
    18 fields
    • idstring
    • objectstring
      connection
    • auth_typestring
    • configobject

      Any JSON object.

    • connectorstring
    • connector_versionstring
    • created_atstring
    • data_classstring
    • healthstring
      One ofhealthydegradedunhealthyrevokeddisabled
    • health_reasonstring or null
    • namestring
    • owner_user_idstring
    • row_versioninteger
    • statusstring
      One ofpendingactive
    • updated_atstring
    • workspace_idstring
    • created_byActorRef or null

      Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

      5 fields
      • idstring or null
      • kindstring
        One ofuserapi_keyservice_accountworkloadend_usersystem
      • namestring or null
      • avatar_versionstring or null
      • emailstring or null
    • updated_byActorRef or null

      Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

      5 fields
      • idstring or null
      • kindstring
        One ofuserapi_keyservice_accountworkloadend_usersystem
      • namestring or null
      • avatar_versionstring or null
      • emailstring or null
  • statestring

Status codes

  • 201Successful 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 -X POST "https://api.mydeepagents.com/v1/connections/oauth/start" \
  -H "Authorization: Bearer $MDA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "config": {},
    "connector": "slack",
    "name": "Support triage",
    "oauth_app": "platform",
    "workspace_id": "ws_01jccj30nr8ad7mx1yc5v9zx3h"
  }'
Response · 201
JSON
{
  "object": "oauth_start",
  "authorization_url": "https://example.com",
  "connection": {
    "id": "con_01jc9ekd74h6eg79ggg89yx7py",
    "object": "connection",
    "auth_type": "auth type",
    "config": {},
    "connector": "slack",
    "connector_version": "connector version",
    "created_at": "2026-11-10T09:30:00.000Z",
    "created_by": {
      "kind": "user",
      "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
      "name": "Ada Lovelace",
      "email": "ada@example.com"
    },
    "data_class": "data class",
    "health": "healthy",
    "health_reason": null,
    "name": "Support triage",
    "owner_user_id": "owner user id",
    "row_version": 4,
    "status": "pending",
    "updated_at": "2026-11-10T09:30:00.000Z",
    "updated_by": {
      "kind": "user",
      "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
      "name": "Ada Lovelace",
      "email": "ada@example.com"
    },
    "workspace_id": "ws_01jccj30nr8ad7mx1yc5v9zx3h"
  },
  "state": "state"
}
get/v1/connections/{connection_id}

Get connection

Needs connection.view

Path parameters

  • connection_idstringRequired

Response200

  • idstring
  • objectstring
    connection
  • auth_typestring
  • configobject

    Any JSON object.

  • connectorstring
  • connector_versionstring
  • created_atstring
  • data_classstring
  • healthstring
    One ofhealthydegradedunhealthyrevokeddisabled
  • health_reasonstring or null
  • namestring
  • owner_user_idstring
  • row_versioninteger
  • statusstring
    One ofpendingactive
  • updated_atstring
  • workspace_idstring
  • created_byActorRef or null

    Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

    5 fields
    • idstring or null
    • kindstring
      One ofuserapi_keyservice_accountworkloadend_usersystem
    • namestring or null
    • avatar_versionstring or null
    • emailstring or null
  • updated_byActorRef or null

    Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

    5 fields
    • idstring or null
    • kindstring
      One ofuserapi_keyservice_accountworkloadend_usersystem
    • namestring or null
    • avatar_versionstring or null
    • emailstring or null

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/connections/con_01jc9ekd74h6eg79ggg89yx7py" \
  -H "Authorization: Bearer $MDA_API_KEY"
Response · 200
JSON
{
  "id": "con_01jc9ekd74h6eg79ggg89yx7py",
  "object": "connection",
  "auth_type": "auth type",
  "config": {},
  "connector": "slack",
  "connector_version": "connector version",
  "created_at": "2026-11-10T09:30:00.000Z",
  "created_by": {
    "kind": "user",
    "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
    "name": "Ada Lovelace",
    "email": "ada@example.com"
  },
  "data_class": "data class",
  "health": "healthy",
  "health_reason": null,
  "name": "Support triage",
  "owner_user_id": "owner user id",
  "row_version": 4,
  "status": "pending",
  "updated_at": "2026-11-10T09:30:00.000Z",
  "updated_by": {
    "kind": "user",
    "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
    "name": "Ada Lovelace",
    "email": "ada@example.com"
  },
  "workspace_id": "ws_01jccj30nr8ad7mx1yc5v9zx3h"
}
patch/v1/connections/{connection_id}

Update connection

Needs connection.manage

Any connection's name (2026-10-26). A database connection's two switches: writes, and schema changes on top of writes. Turning writes off turns schema changes off too. Also its SSH bastion's pinned host key (register section 12, 2026-10-25, later). None of these needs a new test.

Path parameters

  • connection_idstringRequired

Request bodyConnectionAccess

  • allow_schema_changesboolean or null
  • allow_writesboolean or null
  • namestring or null
    at least 1 charactersat most 200 characters
  • ssh_host_keystring or null
    at most 200 charactersmatches ^(SHA256:[A-Za-z0-9+/=]{20,})?$

Response200

  • idstring
  • objectstring
    connection
  • auth_typestring
  • configobject

    Any JSON object.

  • connectorstring
  • connector_versionstring
  • created_atstring
  • data_classstring
  • healthstring
    One ofhealthydegradedunhealthyrevokeddisabled
  • health_reasonstring or null
  • namestring
  • owner_user_idstring
  • row_versioninteger
  • statusstring
    One ofpendingactive
  • updated_atstring
  • workspace_idstring
  • created_byActorRef or null

    Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

    5 fields
    • idstring or null
    • kindstring
      One ofuserapi_keyservice_accountworkloadend_usersystem
    • namestring or null
    • avatar_versionstring or null
    • emailstring or null
  • updated_byActorRef or null

    Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

    5 fields
    • idstring or null
    • kindstring
      One ofuserapi_keyservice_accountworkloadend_usersystem
    • namestring or null
    • avatar_versionstring or null
    • emailstring or null

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 -X PATCH "https://api.mydeepagents.com/v1/connections/con_01jc9ekd74h6eg79ggg89yx7py" \
  -H "Authorization: Bearer $MDA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "allow_schema_changes": true,
    "allow_writes": true,
    "name": "Support triage",
    "ssh_host_key": "ssh host key"
  }'
Response · 200
JSON
{
  "id": "con_01jc9ekd74h6eg79ggg89yx7py",
  "object": "connection",
  "auth_type": "auth type",
  "config": {},
  "connector": "slack",
  "connector_version": "connector version",
  "created_at": "2026-11-10T09:30:00.000Z",
  "created_by": {
    "kind": "user",
    "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
    "name": "Ada Lovelace",
    "email": "ada@example.com"
  },
  "data_class": "data class",
  "health": "healthy",
  "health_reason": null,
  "name": "Support triage",
  "owner_user_id": "owner user id",
  "row_version": 4,
  "status": "pending",
  "updated_at": "2026-11-10T09:30:00.000Z",
  "updated_by": {
    "kind": "user",
    "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
    "name": "Ada Lovelace",
    "email": "ada@example.com"
  },
  "workspace_id": "ws_01jccj30nr8ad7mx1yc5v9zx3h"
}
delete/v1/connections/{connection_id}

Delete connection

Needs connection.manage

Path parameters

  • connection_idstringRequired

Response204

Answers 204 with no body.

Status codes

  • 204Successful 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 -X DELETE "https://api.mydeepagents.com/v1/connections/con_01jc9ekd74h6eg79ggg89yx7py" \
  -H "Authorization: Bearer $MDA_API_KEY"
post/v1/connections/{connection_id}/oauth/complete

Complete OAuth

Needs connection.manage

Steps 5 to 7 of section 8.2. The code and state go to the connector worker in an intake envelope; the answer is the active connection, or 422 with a code from a fixed list (never the vendor's own text).

Path parameters

  • connection_idstringRequired

Request bodyOAuthComplete

  • codestringRequired
    at least 1 charactersat most 4096 characters
  • statestringRequired
    at least 1 charactersat most 200 characters
  • paramsmap<string, string>

Response200

  • idstring
  • objectstring
    connection
  • auth_typestring
  • configobject

    Any JSON object.

  • connectorstring
  • connector_versionstring
  • created_atstring
  • data_classstring
  • healthstring
    One ofhealthydegradedunhealthyrevokeddisabled
  • health_reasonstring or null
  • namestring
  • owner_user_idstring
  • row_versioninteger
  • statusstring
    One ofpendingactive
  • updated_atstring
  • workspace_idstring
  • created_byActorRef or null

    Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

    5 fields
    • idstring or null
    • kindstring
      One ofuserapi_keyservice_accountworkloadend_usersystem
    • namestring or null
    • avatar_versionstring or null
    • emailstring or null
  • updated_byActorRef or null

    Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

    5 fields
    • idstring or null
    • kindstring
      One ofuserapi_keyservice_accountworkloadend_usersystem
    • namestring or null
    • avatar_versionstring or null
    • emailstring or null

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 -X POST "https://api.mydeepagents.com/v1/connections/con_01jc9ekd74h6eg79ggg89yx7py/oauth/complete" \
  -H "Authorization: Bearer $MDA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "code",
    "params": {
      "key": "key"
    },
    "state": "state"
  }'
Response · 200
JSON
{
  "id": "con_01jc9ekd74h6eg79ggg89yx7py",
  "object": "connection",
  "auth_type": "auth type",
  "config": {},
  "connector": "slack",
  "connector_version": "connector version",
  "created_at": "2026-11-10T09:30:00.000Z",
  "created_by": {
    "kind": "user",
    "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
    "name": "Ada Lovelace",
    "email": "ada@example.com"
  },
  "data_class": "data class",
  "health": "healthy",
  "health_reason": null,
  "name": "Support triage",
  "owner_user_id": "owner user id",
  "row_version": 4,
  "status": "pending",
  "updated_at": "2026-11-10T09:30:00.000Z",
  "updated_by": {
    "kind": "user",
    "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
    "name": "Ada Lovelace",
    "email": "ada@example.com"
  },
  "workspace_id": "ws_01jccj30nr8ad7mx1yc5v9zx3h"
}
post/v1/connections/{connection_id}/test

Test connection

Needs connection.manage

Path parameters

  • connection_idstringRequired

Response200

  • objectstring
    connection_test
  • connection_idstring
  • healthstring
  • messagestring or null
  • okboolean

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 -X POST "https://api.mydeepagents.com/v1/connections/con_01jc9ekd74h6eg79ggg89yx7py/test" \
  -H "Authorization: Bearer $MDA_API_KEY"
Response · 200
JSON
{
  "object": "connection_test",
  "connection_id": "con_01jc9ekd74h6eg79ggg89yx7py",
  "health": "health",
  "message": "Summarise today's open tickets.",
  "ok": true
}
post/v1/connections/{connection_id}/actions/{action}/run

Run connection action

Needs connection.use

Runs one action of a database connection, or a cloud connection's read action, now, as the person asking (their data-class ceiling applies, and the organization's policy as for any run), never retried: the console's database browser. A failure is an answer (ok false, a code and the database's own words), not an error.

Path parameters

  • connection_idstringRequired
  • actionstringRequired

Request bodyActionRun

  • inputobject

    Any JSON object.

Response200

  • objectstring
    connection_action_run
  • codestring or null
  • duration_msinteger or null
  • messagestring or null
  • okboolean
  • outputobject or null

    Any JSON object.

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 -X POST "https://api.mydeepagents.com/v1/connections/con_01jc9ekd74h6eg79ggg89yx7py/actions/send_message/run" \
  -H "Authorization: Bearer $MDA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": {}
  }'
Response · 200
JSON
{
  "object": "connection_action_run",
  "code": "code",
  "duration_ms": 840,
  "message": "Summarise today's open tickets.",
  "ok": true,
  "output": {}
}

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.