Digital Ocean

Digital Ocean Signals API

The DigitalOcean Signals API provides observability for environment conversations, such as Harness Runtime conversations and Serverless Inference chat completions, detecting behavioral signals such as user disengagement, execution failures, and satisfaction indicators. Use the consent endpoints to manage whether signals collection is enabled — per environment for Harness Runtime (`source=agent`) and per team for Serverless Inference chat completions (`source=inference`) — the session endpoints to browse conversations and their detected signals, the export endpoints to create downloadable archives of signals data for offline analysis, and the deletion endpoints to permanently delete Signals conversations for an environment or Serverless Inference conversations for a whole team (aggregated Insights or metrics summaries may still remain).

GitHub OpenAPI

Operations 10

GET /v1/signals/agents/{agent_id}/sessions Get signals agents by agent id sessions #
GET /v1/signals/sessions/{session_id}/dialogues Get signals sessions by session id dialogues #
GET /v1/signals/exports Get signals exports #
POST /v1/signals/exports Create signals exports #
GET /v1/signals/exports/options Get signals exports options #
GET /v1/signals/exports/{export_id} Get signals exports by export id #
GET /v1/signals/exports/{export_id}/download Get signals exports by export id download #
GET /v1/signals/deletions Get signals deletions #
POST /v1/signals/deletions Create signals deletions #
GET /v1/signals/deletions/{deletion_id} Get signals deletions by deletion id #

Documentation

📖
Documentation
https://docs.digitalocean.com/reference/api/api-reference/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/digital-ocean/openapi/digital-ocean-signals-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/digitalocean/openapi

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/digital-ocean:digital-ocean-signals-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

digital-ocean-signals-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: DigitalOcean Signals API
  version: '2.0'
  description: 'The DigitalOcean Signals API provides observability for environment

    conversations, such as Harness Runtime conversations and Serverless

    Inference chat completions, detecting behavioral signals such as

    user disengagement, execution failures, and satisfaction indicators.


    Use the consent endpoints to manage whether signals collection is

    enabled — per environment for Harness Runtime (`source=agent`) and per team

    for Serverless Inference chat completions (`source=inference`) — the

    session endpoints to browse conversations and their detected signals,

    the export endpoints to create downloadable archives of signals data

    for offline analysis, and the deletion endpoints to permanently delete

    Signals conversations for an environment or Serverless Inference

    conversations for a whole team (aggregated Insights or metrics

    summaries may still remain).'
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  contact:
    name: DigitalOcean API Team
    email: api-engineering@digitalocean.com
  termsOfService: https://www.digitalocean.com/legal/terms-of-service-agreement/
servers:
- url: https://api.digitalocean.com
  description: production
security:
- bearer_auth: []
tags:
- name: Signals
  description: 'The DigitalOcean Signals API provides observability for environment

    conversations, such as Harness Runtime conversations and Serverless

    Inference chat completions, detecting behavioral signals such as

    user disengagement, execution failures, and satisfaction indicators.


    Use the consent endpoints to manage whether signals collection is

    enabled — per environment for Harness Runtime (`source=agent`) and per team

    for Serverless Inference chat completions (`source=inference`) — the

    session endpoints to browse conversations and their detected signals,

    the export endpoints to create downloadable archives of signals data

    for offline analysis, and the deletion endpoints to permanently delete

    Signals conversations for an environment or Serverless Inference

    conversations for a whole team (aggregated Insights or metrics

    summaries may still remain).'
paths:
  /v1/signals/agents/{agent_id}/sessions:
    get:
      $ref: resources/signals/signals_list_sessions.yml
      tags:
      - Signals
      summary: Get signals agents by agent id sessions
      x-summary-source: derived
      operationId: getV1SignalsAgentsByAgentIdSessions
      x-operation-id-source: derived
  /v1/signals/sessions/{session_id}/dialogues:
    get:
      $ref: resources/signals/signals_list_dialogues.yml
      tags:
      - Signals
      summary: Get signals sessions by session id dialogues
      x-summary-source: derived
      operationId: getV1SignalsSessionsBySessionIdDialogues
      x-operation-id-source: derived
  /v1/signals/exports:
    get:
      $ref: resources/signals/signals_list_exports.yml
      tags:
      - Signals
      summary: Get signals exports
      x-summary-source: derived
      operationId: getV1SignalsExports
      x-operation-id-source: derived
    post:
      $ref: resources/signals/signals_create_export.yml
      tags:
      - Signals
      summary: Create signals exports
      x-summary-source: derived
      operationId: postV1SignalsExports
      x-operation-id-source: derived
  /v1/signals/exports/options:
    get:
      $ref: resources/signals/signals_get_export_options.yml
      tags:
      - Signals
      summary: Get signals exports options
      x-summary-source: derived
      operationId: getV1SignalsExportsOptions
      x-operation-id-source: derived
  /v1/signals/exports/{export_id}:
    get:
      $ref: resources/signals/signals_get_export.yml
      tags:
      - Signals
      summary: Get signals exports by export id
      x-summary-source: derived
      operationId: getV1SignalsExportsByExportId
      x-operation-id-source: derived
  /v1/signals/exports/{export_id}/download:
    get:
      $ref: resources/signals/signals_get_export_download.yml
      tags:
      - Signals
      summary: Get signals exports by export id download
      x-summary-source: derived
      operationId: getV1SignalsExportsByExportIdDownload
      x-operation-id-source: derived
  /v1/signals/deletions:
    get:
      $ref: resources/signals/signals_list_deletions.yml
      tags:
      - Signals
      summary: Get signals deletions
      x-summary-source: derived
      operationId: getV1SignalsDeletions
      x-operation-id-source: derived
    post:
      $ref: resources/signals/signals_create_deletion.yml
      tags:
      - Signals
      summary: Create signals deletions
      x-summary-source: derived
      operationId: postV1SignalsDeletions
      x-operation-id-source: derived
  /v1/signals/deletions/{deletion_id}:
    get:
      $ref: resources/signals/signals_get_deletion.yml
      tags:
      - Signals
      summary: Get signals deletions by deletion id
      x-summary-source: derived
      operationId: getV1SignalsDeletionsByDeletionId
      x-operation-id-source: derived
components:
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      description: '## OAuth Authentication


        In order to interact with the DigitalOcean API, you or your application must

        authenticate.


        The DigitalOcean API handles this through OAuth, an open standard for

        authorization. OAuth allows you to delegate access to your account.

        Scopes can be used to grant full access, read-only access, or access to

        a specific set of endpoints.


        You can generate an OAuth token by visiting the [Apps & API](https://cloud.digitalocean.com/account/api/tokens)

        section of the DigitalOcean control panel for your account.


        An OAuth token functions as a complete authentication request. In effect, it

        acts as a substitute for a username and password pair.


        Because of this, it is absolutely **essential** that you keep your OAuth

        tokens secure. In fact, upon generation, the web interface will only display

        each token a single time in order to prevent the token from being compromised.


        DigitalOcean access tokens begin with an identifiable prefix in order to

        distinguish them from other similar tokens.


        - `dop_v1_` for personal access tokens generated in the control panel

        - `doo_v1_` for tokens generated by applications using [the OAuth flow](https://docs.digitalocean.com/reference/api/oauth-api/)

        - `dor_v1_` for OAuth refresh tokens


        ### Scopes


        Scopes act like permissions assigned to an API token. These permissions

        determine what actions the token can perform. You can create API

        tokens that grant read-only access, full access, or limited access to

        specific endpoints by using custom scopes.


        Generally, scopes are designed to match HTTP verbs and common CRUD

        operations (Create, Read, Update, Delete).


        | HTTP Verb | CRUD Operation | Scope |

        |---|---|---|

        | GET | Read | `<resource>:read` |

        | POST | Create | `<resource>:create` |

        | PUT/PATCH | Update | `<resource>:update` |

        | DELETE | Delete | `<resource>:delete` |


        For example, creating a new Droplet by making a `POST` request to the

        `/v2/droplets` endpoint requires the `droplet:create` scope while

        listing Droplets by making a `GET` request to the `/v2/droplets`

        endpoint requires the `droplet:read` scope.


        Each endpoint below specifies which scope is required to access it when

        using custom scopes.


        ### How to Authenticate with OAuth


        In order to make an authenticated request, include a bearer-type

        `Authorization` header containing your OAuth token. All requests must be

        made over HTTPS.


        ### Authenticate with a Bearer Authorization Header


        ```

        curl -X $HTTP_METHOD -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" "https://api.digitalocean.com/v2/$OBJECT"

        ```

        '
    inference_bearer_auth:
      type: http
      scheme: bearer
      description: '## OAuth Authentication


        In order to interact with the DigitalOcean API, you or your application must

        authenticate.


        The DigitalOcean API handles this through OAuth, an open standard for

        authorization. OAuth allows you to delegate access to your account.

        Scopes can be used to grant full access, read-only access, or access to

        a specific set of endpoints.


        You can generate an OAuth token by visiting the [Apps & API](https://cloud.digitalocean.com/account/api/tokens)

        section of the DigitalOcean control panel for your account.


        An OAuth token functions as a complete authentication request. In effect, it

        acts as a substitute for a username and password pair.


        Because of this, it is absolutely **essential** that you keep your OAuth

        tokens secure. In fact, upon generation, the web interface will only display

        each token a single time in order to prevent the token from being compromised.


        DigitalOcean access tokens begin with an identifiable prefix in order to

        distinguish them from other similar tokens.


        - `dop_v1_` for personal access tokens generated in the control panel

        - `doo_v1_` for tokens generated by applications using [the OAuth flow](https://docs.digitalocean.com/reference/api/oauth-api/)

        - `dor_v1_` for OAuth refresh tokens


        ### Authenticate with a Bearer Authorization Header


        **Serverless Inference:**


        ```

        curl -X POST -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" "https://inference.do-ai.run/v1/chat/completions"

        ```


        **Agent Inference:**


        ```

        curl -X POST -H "Authorization: Bearer $AGENT_ACCESS_KEY" "https://{your-agent-url}.agents.do-ai.run/v1/chat/completions?agent=true"

        ```


        **Note:** Agent Inference APIs use an `agent_access_key` (endpoint access

        key) instead of a DigitalOcean OAuth token. The `agent_access_key` is

        provided when you provision an agent endpoint and is scoped to that

        specific agent. It is not interchangeable with DigitalOcean OAuth tokens

        (`dop_v1_*`, `doo_v1_*`, `dor_v1_*`), which are used with Serverless

        Inference and the control-plane API at `https://api.digitalocean.com`.

        '
x-tagGroups:
- name: Public APIs
  tags:
  - Public APIs Introduction
  - 1-Click Applications
  - Account
  - Actions
  - Add-Ons
  - Action Gateway
  - Action Gateway Data Plane
  - Agent Platform API
  - Apps
  - Billing
  - Block Storage
  - Block Storage Actions
  - BYOIP Prefixes
  - CDN Endpoints
  - Certificates
  - Container Registry
  - Container Registries
  - Databases
  - Dedicated Inference
  - Domain Records
  - Domains
  - Droplet Actions
  - Droplets
  - Droplet Autoscale Pools
  - Firewalls
  - Floating IP Actions
  - Floating IPs
  - Functions
  - Harness Runtime
  - Image Actions
  - Images
  - Insights
  - Kubernetes
  - Load Balancers
  - MicroVMs [Public Preview]
  - Monitoring
  - NFS
  - NFS Actions
  - Organizations
  - Partner Network Connect
  - Project Resources
  - Projects
  - Regions
  - Reserved IP Actions
  - Reserved IPs
  - Reserved IPv6
  - Reserved IPv6 Actions
  - Security
  - Signals
  - Sizes
  - Snapshots
  - Spaces Keys
  - SSH Keys
  - Tags
  - Uptime
  - Vector Databases
  - VPC NAT Gateways
  - VPC Peerings
  - VPC Routes [Public Preview]
  - VPC Subnets [Public Preview]
  - VPCs
- name: Inference APIs
  tags:
  - Inference Introduction
  - Agent Inference
  - Batch Inference
  - Embeddings
  - Serverless Inference