Generate a Cloud Cost Management tag description

GET https://api.ap1.datadoghq.com/api/v2/cost/tag_descriptions/{tag_key}/generatehttps://api.ap2.datadoghq.com/api/v2/cost/tag_descriptions/{tag_key}/generatehttps://api.datadoghq.eu/api/v2/cost/tag_descriptions/{tag_key}/generatehttps://api.ddog-gov.com/api/v2/cost/tag_descriptions/{tag_key}/generatehttps://api.us2.ddog-gov.com/api/v2/cost/tag_descriptions/{tag_key}/generatehttps://api.datadoghq.com/api/v2/cost/tag_descriptions/{tag_key}/generatehttps://api.us3.datadoghq.com/api/v2/cost/tag_descriptions/{tag_key}/generatehttps://api.us5.datadoghq.com/api/v2/cost/tag_descriptions/{tag_key}/generate

Overview

Use AI to draft a Cloud Cost Management tag key description based on associated cost data. The generated description is returned in the response and is not persisted by this endpoint; follow up with UpsertCostTagDescriptionByKey to save it. This endpoint requires the cloud_cost_management_read permission.

OAuth apps require the cloud_cost_management_read authorization scope to access this endpoint.

Arguments

Path Parameters

Name

Type

Description

tag_key [required]

string

The tag key to generate an AI description for.

Response

OK

Response wrapping an AI-generated Cloud Cost Management tag key description.

Expand All

Field

Type

Description

data [required]

object

AI-generated Cloud Cost Management tag key description returned by the generate endpoint. The result is returned to the client but is not persisted by this endpoint.

attributes [required]

object

Attributes of an AI-generated Cloud Cost Management tag key description.

description [required]

string

The AI-generated description for the tag key.

id [required]

string

The tag key the AI description was generated for.

type [required]

enum

Type of the AI-generated Cloud Cost Management tag description resource. Allowed enum values: cost_generated_tag_description

default: cost_generated_tag_description

{
  "data": {
    "attributes": {
      "description": "AWS account that owns this cost."
    },
    "id": "account_id",
    "type": "cost_generated_tag_description"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export tag_key="CHANGE_ME"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cost/tag_descriptions/${tag_key}/generate" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"