Language

Español English Français 日本語 한국어

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED US2-FED
Esta página aún no está disponible en español. Estamos trabajando en su traducción.
Si tienes alguna pregunta o comentario sobre nuestro actual proyecto de traducción, no dudes en ponerte en contacto con nosotros.

Model Lab API

Manage Model Lab projects, runs, artifacts, and facets for ML experiment tracking.

List Model Lab projects

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/projectshttps://api.ap2.datadoghq.com/api/v2/model-lab-api/projectshttps://api.datadoghq.eu/api/v2/model-lab-api/projectshttps://api.ddog-gov.com/api/v2/model-lab-api/projectshttps://api.us2.ddog-gov.com/api/v2/model-lab-api/projectshttps://api.datadoghq.com/api/v2/model-lab-api/projectshttps://api.us3.datadoghq.com/api/v2/model-lab-api/projectshttps://api.us5.datadoghq.com/api/v2/model-lab-api/projects

Información general

List all Model Lab projects for the current organization.

Argumentos

Cadenas de consulta

Nombre

Tipo

Descripción

filter

string

Text search filter for project name or description.

filter[owner_id]

string

Filter by owner UUID.

filter[tags]

string

Filter by tags. Format: key:value,key2:value2.

sort

string

Sort field. Valid values: name, created_at, updated_at. Prefix with ‘-’ for descending order (e.g., -updated_at).

page[size]

integer

Number of items per page. Maximum is 100.

page[number]

integer

Page number (1-indexed).

Respuesta

OK

Response containing a list of Model Lab projects with pagination metadata.

Expand All

Campo

Tipo

Descripción

data [required]

[object]

The list of projects.

attributes [required]

object

Attributes of a Model Lab project.

artifact_storage_location [required]

string

The storage location for project artifacts.

created_at [required]

date-time

The date and time the project was created.

deleted_at

date-time

The date and time the project was soft-deleted.

description [required]

string

A description of the project.

external_url

string

An optional external URL associated with the project.

is_starred [required]

boolean

Whether the project is starred by the current user.

name [required]

string

The name of the project.

owner_id

string

The UUID of the project owner.

tags [required]

[object]

The list of tags associated with the project.

key [required]

string

The tag key.

value [required]

string

The tag value.

updated_at [required]

date-time

The date and time the project was last updated.

id [required]

string

The unique identifier of the project.

type [required]

enum

The JSON:API type for a Model Lab project resource. Allowed enum values: projects

links

object

Pagination links for navigating list responses.

first

string

Link to the first page.

last

string

Link to the last page.

next

string

Link to the next page.

prev

string

Link to the previous page.

self

string

Link to the current page.

meta [required]

object

Pagination metadata for a list response.

page [required]

object

Pagination details for a list response.

first_number

int64

The first page number.

last_number

int64

The last page number.

next_number

int64

The next page number.

number [required]

int64

The current page number.

prev_number

int64

The previous page number.

size [required]

int64

The number of items per page.

total [required]

int64

The total number of items.

type

string

The pagination type.

{
  "data": [
    {
      "attributes": {
        "artifact_storage_location": "s3://bucket/active-project",
        "created_at": "2024-01-20T10:00:00Z",
        "deleted_at": "2019-09-19T10:00:00.000Z",
        "description": "A machine learning training project.",
        "external_url": "string",
        "is_starred": false,
        "name": "active-project",
        "owner_id": "string",
        "tags": [
          {
            "key": "model",
            "value": "opus"
          }
        ],
        "updated_at": "2024-01-20T11:00:00Z"
      },
      "id": "2",
      "type": "projects"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string",
    "self": "string"
  },
  "meta": {
    "page": {
      "first_number": "integer",
      "last_number": "integer",
      "next_number": "integer",
      "number": 1,
      "prev_number": "integer",
      "size": 25,
      "total": 100,
      "type": "string"
    }
  }
}

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # 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/model-lab-api/projects" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Get a Model Lab project

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/projects/{project_id}https://api.ap2.datadoghq.com/api/v2/model-lab-api/projects/{project_id}https://api.datadoghq.eu/api/v2/model-lab-api/projects/{project_id}https://api.ddog-gov.com/api/v2/model-lab-api/projects/{project_id}https://api.us2.ddog-gov.com/api/v2/model-lab-api/projects/{project_id}https://api.datadoghq.com/api/v2/model-lab-api/projects/{project_id}https://api.us3.datadoghq.com/api/v2/model-lab-api/projects/{project_id}https://api.us5.datadoghq.com/api/v2/model-lab-api/projects/{project_id}

Información general

Get a single Model Lab project by its ID.

Argumentos

Parámetros de ruta

Nombre

Tipo

Descripción

project_id [required]

integer

The ID of the Model Lab project.

Respuesta

OK

Response containing a single Model Lab project.

Expand All

Campo

Tipo

Descripción

data [required]

object

A Model Lab project JSON:API resource object.

attributes [required]

object

Attributes of a Model Lab project.

artifact_storage_location [required]

string

The storage location for project artifacts.

created_at [required]

date-time

The date and time the project was created.

deleted_at

date-time

The date and time the project was soft-deleted.

description [required]

string

A description of the project.

external_url

string

An optional external URL associated with the project.

is_starred [required]

boolean

Whether the project is starred by the current user.

name [required]

string

The name of the project.

owner_id

string

The UUID of the project owner.

tags [required]

[object]

The list of tags associated with the project.

key [required]

string

The tag key.

value [required]

string

The tag value.

updated_at [required]

date-time

The date and time the project was last updated.

id [required]

string

The unique identifier of the project.

type [required]

enum

The JSON:API type for a Model Lab project resource. Allowed enum values: projects

{
  "data": {
    "attributes": {
      "artifact_storage_location": "s3://bucket/active-project",
      "created_at": "2024-01-20T10:00:00Z",
      "deleted_at": "2019-09-19T10:00:00.000Z",
      "description": "A machine learning training project.",
      "external_url": "string",
      "is_starred": false,
      "name": "active-project",
      "owner_id": "string",
      "tags": [
        {
          "key": "model",
          "value": "opus"
        }
      ],
      "updated_at": "2024-01-20T11:00:00Z"
    },
    "id": "2",
    "type": "projects"
  }
}

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # Path parameters
export project_id="1"
# 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/model-lab-api/projects/${project_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

List Model Lab project facet keys

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/project-facet-keyshttps://api.ap2.datadoghq.com/api/v2/model-lab-api/project-facet-keyshttps://api.datadoghq.eu/api/v2/model-lab-api/project-facet-keyshttps://api.ddog-gov.com/api/v2/model-lab-api/project-facet-keyshttps://api.us2.ddog-gov.com/api/v2/model-lab-api/project-facet-keyshttps://api.datadoghq.com/api/v2/model-lab-api/project-facet-keyshttps://api.us3.datadoghq.com/api/v2/model-lab-api/project-facet-keyshttps://api.us5.datadoghq.com/api/v2/model-lab-api/project-facet-keys

Información general

List all available facet keys for filtering Model Lab projects.

Respuesta

OK

Response containing available facet keys.

Expand All

Campo

Tipo

Descripción

data [required]

object

A facet keys JSON:API resource object.

attributes [required]

object

Available facet key names for filtering resources.

metrics [required]

[string]

The list of available metric facet keys.

parameters [required]

[string]

The list of available parameter facet keys.

tags [required]

[string]

The list of available tag facet keys.

id [required]

string

The unique identifier of the facet keys resource.

type [required]

enum

The JSON:API type for a facet keys resource. Allowed enum values: facet_keys

{
  "data": {
    "attributes": {
      "metrics": [
        "accuracy"
      ],
      "parameters": [
        "learning_rate"
      ],
      "tags": [
        "model"
      ]
    },
    "id": "1",
    "type": "facet_keys"
  }
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # 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/model-lab-api/project-facet-keys" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

List Model Lab project facet values

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/project-facet-valueshttps://api.ap2.datadoghq.com/api/v2/model-lab-api/project-facet-valueshttps://api.datadoghq.eu/api/v2/model-lab-api/project-facet-valueshttps://api.ddog-gov.com/api/v2/model-lab-api/project-facet-valueshttps://api.us2.ddog-gov.com/api/v2/model-lab-api/project-facet-valueshttps://api.datadoghq.com/api/v2/model-lab-api/project-facet-valueshttps://api.us3.datadoghq.com/api/v2/model-lab-api/project-facet-valueshttps://api.us5.datadoghq.com/api/v2/model-lab-api/project-facet-values

Información general

List available facet values for a specific project facet key.

Argumentos

Cadenas de consulta

Nombre

Tipo

Descripción

facet_type [required]

enum

Facet type. Valid values: tag.
Allowed enum values: tag

facet_name [required]

string

Facet name.

Respuesta

OK

Response containing available values for a facet key.

Expand All

Campo

Tipo

Descripción

data [required]

object

A facet values JSON:API resource object.

attributes [required]

object

Available values for a specific facet key.

facet_name [required]

string

The name of the facet.

facet_type [required]

string

The type of the facet.

metric_stat_ranges

[object]

The ranges for each metric statistic.

max [required]

double

The maximum value of the statistic.

min [required]

double

The minimum value of the statistic.

stat [required]

string

The metric statistic name.

numeric_range

object

The numeric range of values for a facet.

max [required]

double

The maximum value.

min [required]

double

The minimum value.

values [required]

[string]

The list of available string values for this facet.

id [required]

string

The unique identifier of the facet values resource.

type [required]

enum

The JSON:API type for a facet values resource. Allowed enum values: facet_values

{
  "data": {
    "attributes": {
      "facet_name": "model",
      "facet_type": "tag",
      "metric_stat_ranges": [
        {
          "max": 1,
          "min": 0,
          "stat": "mean"
        }
      ],
      "numeric_range": {
        "max": 1,
        "min": 0
      },
      "values": [
        "gpt4"
      ]
    },
    "id": "1",
    "type": "facet_values"
  }
}

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # Required query arguments
export facet_type="tag"
export facet_name="model"
# 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/model-lab-api/project-facet-values?facet_type=${facet_type}&facet_name=${facet_name}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Star a Model Lab project

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

POST https://api.ap1.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/starhttps://api.ap2.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/starhttps://api.datadoghq.eu/api/v2/model-lab-api/projects/{project_id}/starhttps://api.ddog-gov.com/api/v2/model-lab-api/projects/{project_id}/starhttps://api.us2.ddog-gov.com/api/v2/model-lab-api/projects/{project_id}/starhttps://api.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/starhttps://api.us3.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/starhttps://api.us5.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/star

Información general

Star a Model Lab project for the current user.

Argumentos

Parámetros de ruta

Nombre

Tipo

Descripción

project_id [required]

integer

The ID of the Model Lab project.

Respuesta

No Content

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Forbidden

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # Path parameters
export project_id="1"
# Curl command
curl -X POST "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/model-lab-api/projects/${project_id}/star" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Remove star from a Model Lab project

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

DELETE https://api.ap1.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/starhttps://api.ap2.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/starhttps://api.datadoghq.eu/api/v2/model-lab-api/projects/{project_id}/starhttps://api.ddog-gov.com/api/v2/model-lab-api/projects/{project_id}/starhttps://api.us2.ddog-gov.com/api/v2/model-lab-api/projects/{project_id}/starhttps://api.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/starhttps://api.us3.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/starhttps://api.us5.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/star

Información general

Remove the star from a Model Lab project for the current user.

Argumentos

Parámetros de ruta

Nombre

Tipo

Descripción

project_id [required]

integer

The ID of the Model Lab project.

Respuesta

No Content

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Forbidden

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # Path parameters
export project_id="1"
# Curl command
curl -X DELETE "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/model-lab-api/projects/${project_id}/star" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

List Model Lab runs

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/runshttps://api.ap2.datadoghq.com/api/v2/model-lab-api/runshttps://api.datadoghq.eu/api/v2/model-lab-api/runshttps://api.ddog-gov.com/api/v2/model-lab-api/runshttps://api.us2.ddog-gov.com/api/v2/model-lab-api/runshttps://api.datadoghq.com/api/v2/model-lab-api/runshttps://api.us3.datadoghq.com/api/v2/model-lab-api/runshttps://api.us5.datadoghq.com/api/v2/model-lab-api/runs

Información general

List all Model Lab runs for the current organization.

Argumentos

Cadenas de consulta

Nombre

Tipo

Descripción

filter[id]

string

Filter by run ID(s). Comma-separated list for multiple IDs.

filter

string

Text search filter for run name or description.

filter[owner_id]

string

Filter by owner UUID.

filter[status]

enum

Filter by run status. Valid values: pending, running, completed, failed, killed, unresponsive, paused.
Allowed enum values: pending, running, completed, failed, killed, unresponsive, paused

filter[project_id]

integer

Filter by project ID.

filter[tags]

string

Filter by tags. Format: key:value,key2:value2.

filter[params]

string

Filter by params. Format: key:value,key2:>0.5,key3:true.

filter[parent_run_id]

string

Filter by parent run ID. Use ’null’ to return only root runs (runs with no parent).

pinned_first

boolean

Sort pinned runs before non-pinned runs. Pinned runs are ordered by pin time descending.

include_pinned

boolean

Include all runs pinned by the current user, regardless of other filters.

include_descendant_matches

boolean

When true, also return runs whose descendants match the active filters. The descendant_match field in each result indicates whether the run was included via a descendant match.

sort

string

Sort field. Valid values: name, created_at, updated_at, duration. Prefix with ‘-’ for descending order (e.g., -updated_at).

page[size]

integer

Number of items per page. Maximum is 100.

page[number]

integer

Page number (1-indexed).

Respuesta

OK

Response containing a list of Model Lab runs with pagination metadata.

Expand All

Campo

Tipo

Descripción

data [required]

[object]

The list of runs.

attributes [required]

object

Attributes of a Model Lab run.

completed_at

date-time

The date and time the run completed.

created_at [required]

date-time

The date and time the run was created.

deleted_at

date-time

The date and time the run was soft-deleted.

descendant_match [required]

boolean

Whether a descendant run matched the applied filters.

description [required]

string

A description of the run.

duration

double

The duration of the run in seconds.

external_url

string

An optional external URL associated with the run.

has_children [required]

boolean

Whether the run has child runs.

is_pinned [required]

boolean

Whether the run is pinned by the current user.

metric_summaries [required]

[object]

Summary statistics for metrics recorded during the run.

count [required]

int64

The total number of recorded values.

first_step

int64

The first step at which the metric was recorded.

key [required]

string

The metric name.

last_step

int64

The last step at which the metric was recorded.

latest

double

The most recently recorded value.

max

double

The maximum recorded value.

mean

double

The mean of recorded values.

min

double

The minimum recorded value.

stddev

double

The standard deviation of recorded values.

mlflow_artifact_location [required]

string

The MLflow artifact storage location for this run.

name [required]

string

The name of the run.

owner_id

string

The UUID of the run owner.

params [required]

[object]

The list of parameters used for the run.

key [required]

string

The parameter key.

value [required]

string

The parameter value.

project_id [required]

int64

The ID of the project this run belongs to.

started_at [required]

date-time

The date and time the run started.

status [required]

enum

The status of a Model Lab run. Allowed enum values: pending,running,completed,failed,killed,unresponsive,paused

tags [required]

[object]

The list of tags associated with the run.

key [required]

string

The tag key.

value [required]

string

The tag value.

updated_at [required]

date-time

The date and time the run was last updated.

id [required]

string

The unique identifier of the run.

type [required]

enum

The JSON:API type for a Model Lab run resource. Allowed enum values: runs

links

object

Pagination links for navigating list responses.

first

string

Link to the first page.

last

string

Link to the last page.

next

string

Link to the next page.

prev

string

Link to the previous page.

self

string

Link to the current page.

meta [required]

object

Pagination metadata for a list response.

page [required]

object

Pagination details for a list response.

first_number

int64

The first page number.

last_number

int64

The last page number.

next_number

int64

The next page number.

number [required]

int64

The current page number.

prev_number

int64

The previous page number.

size [required]

int64

The number of items per page.

total [required]

int64

The total number of items.

type

string

The pagination type.

{
  "data": [
    {
      "attributes": {
        "completed_at": "2019-09-19T10:00:00.000Z",
        "created_at": "2024-01-20T10:00:00Z",
        "deleted_at": "2019-09-19T10:00:00.000Z",
        "descendant_match": false,
        "description": "Fine-tuning run with custom hyperparameters.",
        "duration": "number",
        "external_url": "string",
        "has_children": false,
        "is_pinned": false,
        "metric_summaries": [
          {
            "count": 100,
            "first_step": "integer",
            "key": "accuracy",
            "last_step": "integer",
            "latest": "number",
            "max": "number",
            "mean": "number",
            "min": "number",
            "stddev": "number"
          }
        ],
        "mlflow_artifact_location": "s3://bucket/active-run",
        "name": "training-run-1",
        "owner_id": "string",
        "params": [
          {
            "key": "algorithm",
            "value": "gpt4"
          }
        ],
        "project_id": 101,
        "started_at": "2024-01-20T10:00:00Z",
        "status": "running",
        "tags": [
          {
            "key": "model",
            "value": "opus"
          }
        ],
        "updated_at": "2024-01-20T11:00:00Z"
      },
      "id": "42",
      "type": "runs"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string",
    "self": "string"
  },
  "meta": {
    "page": {
      "first_number": "integer",
      "last_number": "integer",
      "next_number": "integer",
      "number": 1,
      "prev_number": "integer",
      "size": 25,
      "total": 100,
      "type": "string"
    }
  }
}

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # 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/model-lab-api/runs" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Get a Model Lab run

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/runs/{run_id}https://api.ap2.datadoghq.com/api/v2/model-lab-api/runs/{run_id}https://api.datadoghq.eu/api/v2/model-lab-api/runs/{run_id}https://api.ddog-gov.com/api/v2/model-lab-api/runs/{run_id}https://api.us2.ddog-gov.com/api/v2/model-lab-api/runs/{run_id}https://api.datadoghq.com/api/v2/model-lab-api/runs/{run_id}https://api.us3.datadoghq.com/api/v2/model-lab-api/runs/{run_id}https://api.us5.datadoghq.com/api/v2/model-lab-api/runs/{run_id}

Información general

Get a single Model Lab run by its ID.

Argumentos

Parámetros de ruta

Nombre

Tipo

Descripción

run_id [required]

integer

The ID of the Model Lab run.

Respuesta

OK

Response containing a single Model Lab run.

Expand All

Campo

Tipo

Descripción

data [required]

object

A Model Lab run JSON:API resource object.

attributes [required]

object

Attributes of a Model Lab run.

completed_at

date-time

The date and time the run completed.

created_at [required]

date-time

The date and time the run was created.

deleted_at

date-time

The date and time the run was soft-deleted.

descendant_match [required]

boolean

Whether a descendant run matched the applied filters.

description [required]

string

A description of the run.

duration

double

The duration of the run in seconds.

external_url

string

An optional external URL associated with the run.

has_children [required]

boolean

Whether the run has child runs.

is_pinned [required]

boolean

Whether the run is pinned by the current user.

metric_summaries [required]

[object]

Summary statistics for metrics recorded during the run.

count [required]

int64

The total number of recorded values.

first_step

int64

The first step at which the metric was recorded.

key [required]

string

The metric name.

last_step

int64

The last step at which the metric was recorded.

latest

double

The most recently recorded value.

max

double

The maximum recorded value.

mean

double

The mean of recorded values.

min

double

The minimum recorded value.

stddev

double

The standard deviation of recorded values.

mlflow_artifact_location [required]

string

The MLflow artifact storage location for this run.

name [required]

string

The name of the run.

owner_id

string

The UUID of the run owner.

params [required]

[object]

The list of parameters used for the run.

key [required]

string

The parameter key.

value [required]

string

The parameter value.

project_id [required]

int64

The ID of the project this run belongs to.

started_at [required]

date-time

The date and time the run started.

status [required]

enum

The status of a Model Lab run. Allowed enum values: pending,running,completed,failed,killed,unresponsive,paused

tags [required]

[object]

The list of tags associated with the run.

key [required]

string

The tag key.

value [required]

string

The tag value.

updated_at [required]

date-time

The date and time the run was last updated.

id [required]

string

The unique identifier of the run.

type [required]

enum

The JSON:API type for a Model Lab run resource. Allowed enum values: runs

{
  "data": {
    "attributes": {
      "completed_at": "2019-09-19T10:00:00.000Z",
      "created_at": "2024-01-20T10:00:00Z",
      "deleted_at": "2019-09-19T10:00:00.000Z",
      "descendant_match": false,
      "description": "Fine-tuning run with custom hyperparameters.",
      "duration": "number",
      "external_url": "string",
      "has_children": false,
      "is_pinned": false,
      "metric_summaries": [
        {
          "count": 100,
          "first_step": "integer",
          "key": "accuracy",
          "last_step": "integer",
          "latest": "number",
          "max": "number",
          "mean": "number",
          "min": "number",
          "stddev": "number"
        }
      ],
      "mlflow_artifact_location": "s3://bucket/active-run",
      "name": "training-run-1",
      "owner_id": "string",
      "params": [
        {
          "key": "algorithm",
          "value": "gpt4"
        }
      ],
      "project_id": 101,
      "started_at": "2024-01-20T10:00:00Z",
      "status": "running",
      "tags": [
        {
          "key": "model",
          "value": "opus"
        }
      ],
      "updated_at": "2024-01-20T11:00:00Z"
    },
    "id": "42",
    "type": "runs"
  }
}

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # Path parameters
export run_id="42"
# 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/model-lab-api/runs/${run_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Delete a Model Lab run

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

DELETE https://api.ap1.datadoghq.com/api/v2/model-lab-api/runs/{run_id}https://api.ap2.datadoghq.com/api/v2/model-lab-api/runs/{run_id}https://api.datadoghq.eu/api/v2/model-lab-api/runs/{run_id}https://api.ddog-gov.com/api/v2/model-lab-api/runs/{run_id}https://api.us2.ddog-gov.com/api/v2/model-lab-api/runs/{run_id}https://api.datadoghq.com/api/v2/model-lab-api/runs/{run_id}https://api.us3.datadoghq.com/api/v2/model-lab-api/runs/{run_id}https://api.us5.datadoghq.com/api/v2/model-lab-api/runs/{run_id}

Información general

Delete a Model Lab run by its ID.

Argumentos

Parámetros de ruta

Nombre

Tipo

Descripción

run_id [required]

integer

The ID of the Model Lab run.

Respuesta

No Content

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # Path parameters
export run_id="42"
# Curl command
curl -X DELETE "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/model-lab-api/runs/${run_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Pin a Model Lab run

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

POST https://api.ap1.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/pinhttps://api.ap2.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/pinhttps://api.datadoghq.eu/api/v2/model-lab-api/runs/{run_id}/pinhttps://api.ddog-gov.com/api/v2/model-lab-api/runs/{run_id}/pinhttps://api.us2.ddog-gov.com/api/v2/model-lab-api/runs/{run_id}/pinhttps://api.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/pinhttps://api.us3.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/pinhttps://api.us5.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/pin

Información general

Pin a Model Lab run for the current user.

Argumentos

Parámetros de ruta

Nombre

Tipo

Descripción

run_id [required]

integer

The ID of the Model Lab run.

Respuesta

No Content

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Forbidden

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # Path parameters
export run_id="42"
# Curl command
curl -X POST "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/model-lab-api/runs/${run_id}/pin" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Unpin a Model Lab run

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

DELETE https://api.ap1.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/pinhttps://api.ap2.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/pinhttps://api.datadoghq.eu/api/v2/model-lab-api/runs/{run_id}/pinhttps://api.ddog-gov.com/api/v2/model-lab-api/runs/{run_id}/pinhttps://api.us2.ddog-gov.com/api/v2/model-lab-api/runs/{run_id}/pinhttps://api.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/pinhttps://api.us3.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/pinhttps://api.us5.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/pin

Información general

Remove the pin from a Model Lab run for the current user.

Argumentos

Parámetros de ruta

Nombre

Tipo

Descripción

run_id [required]

integer

The ID of the Model Lab run.

Respuesta

No Content

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Forbidden

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # Path parameters
export run_id="42"
# Curl command
curl -X DELETE "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/model-lab-api/runs/${run_id}/pin" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

List Model Lab run facet keys

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/facet-keyshttps://api.ap2.datadoghq.com/api/v2/model-lab-api/facet-keyshttps://api.datadoghq.eu/api/v2/model-lab-api/facet-keyshttps://api.ddog-gov.com/api/v2/model-lab-api/facet-keyshttps://api.us2.ddog-gov.com/api/v2/model-lab-api/facet-keyshttps://api.datadoghq.com/api/v2/model-lab-api/facet-keyshttps://api.us3.datadoghq.com/api/v2/model-lab-api/facet-keyshttps://api.us5.datadoghq.com/api/v2/model-lab-api/facet-keys

Información general

List all available facet keys for filtering Model Lab runs.

Argumentos

Cadenas de consulta

Nombre

Tipo

Descripción

filter[project_id] [required]

integer

Filter by project ID.

Respuesta

OK

Response containing available facet keys.

Expand All

Campo

Tipo

Descripción

data [required]

object

A facet keys JSON:API resource object.

attributes [required]

object

Available facet key names for filtering resources.

metrics [required]

[string]

The list of available metric facet keys.

parameters [required]

[string]

The list of available parameter facet keys.

tags [required]

[string]

The list of available tag facet keys.

id [required]

string

The unique identifier of the facet keys resource.

type [required]

enum

The JSON:API type for a facet keys resource. Allowed enum values: facet_keys

{
  "data": {
    "attributes": {
      "metrics": [
        "accuracy"
      ],
      "parameters": [
        "learning_rate"
      ],
      "tags": [
        "model"
      ]
    },
    "id": "1",
    "type": "facet_keys"
  }
}

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # Required query arguments
export filter[project_id]="101"
# 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/model-lab-api/facet-keys?filter[project_id]=${filter[project_id]}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

List Model Lab run facet values

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/facet-valueshttps://api.ap2.datadoghq.com/api/v2/model-lab-api/facet-valueshttps://api.datadoghq.eu/api/v2/model-lab-api/facet-valueshttps://api.ddog-gov.com/api/v2/model-lab-api/facet-valueshttps://api.us2.ddog-gov.com/api/v2/model-lab-api/facet-valueshttps://api.datadoghq.com/api/v2/model-lab-api/facet-valueshttps://api.us3.datadoghq.com/api/v2/model-lab-api/facet-valueshttps://api.us5.datadoghq.com/api/v2/model-lab-api/facet-values

Información general

List available facet values for a specific run facet key.

Argumentos

Cadenas de consulta

Nombre

Tipo

Descripción

filter[project_id] [required]

integer

Filter by project ID.

facet_type [required]

enum

Facet type. Valid values: parameter, attribute, tag, metric.
Allowed enum values: parameter, attribute, tag, metric

facet_name [required]

string

Facet name.

Respuesta

OK

Response containing available values for a facet key.

Expand All

Campo

Tipo

Descripción

data [required]

object

A facet values JSON:API resource object.

attributes [required]

object

Available values for a specific facet key.

facet_name [required]

string

The name of the facet.

facet_type [required]

string

The type of the facet.

metric_stat_ranges

[object]

The ranges for each metric statistic.

max [required]

double

The maximum value of the statistic.

min [required]

double

The minimum value of the statistic.

stat [required]

string

The metric statistic name.

numeric_range

object

The numeric range of values for a facet.

max [required]

double

The maximum value.

min [required]

double

The minimum value.

values [required]

[string]

The list of available string values for this facet.

id [required]

string

The unique identifier of the facet values resource.

type [required]

enum

The JSON:API type for a facet values resource. Allowed enum values: facet_values

{
  "data": {
    "attributes": {
      "facet_name": "model",
      "facet_type": "tag",
      "metric_stat_ranges": [
        {
          "max": 1,
          "min": 0,
          "stat": "mean"
        }
      ],
      "numeric_range": {
        "max": 1,
        "min": 0
      },
      "values": [
        "gpt4"
      ]
    },
    "id": "1",
    "type": "facet_values"
  }
}

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # Required query arguments
export filter[project_id]="101"
export facet_type="tag"
export facet_name="algorithm"
# 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/model-lab-api/facet-values?filter[project_id]=${filter[project_id]}&facet_type=${facet_type}&facet_name=${facet_name}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

List Model Lab run artifacts

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/artifactshttps://api.ap2.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/artifactshttps://api.datadoghq.eu/api/v2/model-lab-api/runs/{run_id}/artifactshttps://api.ddog-gov.com/api/v2/model-lab-api/runs/{run_id}/artifactshttps://api.us2.ddog-gov.com/api/v2/model-lab-api/runs/{run_id}/artifactshttps://api.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/artifactshttps://api.us3.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/artifactshttps://api.us5.datadoghq.com/api/v2/model-lab-api/runs/{run_id}/artifacts

Información general

List artifact files for a specific Model Lab run.

Argumentos

Parámetros de ruta

Nombre

Tipo

Descripción

run_id [required]

integer

The ID of the Model Lab run.

Cadenas de consulta

Nombre

Tipo

Descripción

path

string

Optional subdirectory path within the run’s artifacts.

Respuesta

OK

Response containing the artifact listing for a Model Lab run.

Expand All

Campo

Tipo

Descripción

data [required]

object

A run artifacts JSON:API resource object.

attributes [required]

object

Artifact listing for a Model Lab run.

files [required]

[object]

The list of artifact files and directories.

file_size

int64

The size of the file in bytes.

is_dir [required]

boolean

Whether this artifact entry is a directory.

path [required]

string

The path of the artifact relative to the run's artifact root.

path_in_project [required]

string

The path of the run's artifacts relative to the project's artifact root.

id [required]

string

The unique identifier of the artifacts resource.

type [required]

enum

The JSON:API type for a run artifacts resource. Allowed enum values: artifacts

{
  "data": {
    "attributes": {
      "files": [
        {
          "file_size": "integer",
          "is_dir": false,
          "path": "model/weights.pt"
        }
      ],
      "path_in_project": "runs/42"
    },
    "id": "42",
    "type": "artifacts"
  }
}

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # Path parameters
export run_id="42"
# 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/model-lab-api/runs/${run_id}/artifacts" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

List Model Lab project artifacts

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/artifactshttps://api.ap2.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/artifactshttps://api.datadoghq.eu/api/v2/model-lab-api/projects/{project_id}/artifactshttps://api.ddog-gov.com/api/v2/model-lab-api/projects/{project_id}/artifactshttps://api.us2.ddog-gov.com/api/v2/model-lab-api/projects/{project_id}/artifactshttps://api.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/artifactshttps://api.us3.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/artifactshttps://api.us5.datadoghq.com/api/v2/model-lab-api/projects/{project_id}/artifacts

Información general

List all artifact files for a specific Model Lab project.

Argumentos

Parámetros de ruta

Nombre

Tipo

Descripción

project_id [required]

integer

The ID of the Model Lab project.

Respuesta

OK

Response containing the artifact listing for a Model Lab project.

Expand All

Campo

Tipo

Descripción

data [required]

object

A project artifacts JSON:API resource object.

attributes [required]

object

Artifact listing for a Model Lab project.

files [required]

[object]

The list of artifact files associated with the project.

artifact_path [required]

string

The full artifact path relative to the project's artifact root.

created_at [required]

date-time

The date and time the artifact was created.

file_size

int64

The size of the file in bytes.

filename [required]

string

The filename of the artifact.

id [required]

string

The unique identifier of the project artifacts resource.

type [required]

enum

The JSON:API type for a project artifacts resource. Allowed enum values: project_files

{
  "data": {
    "attributes": {
      "files": [
        {
          "artifact_path": "projects/1/artifacts/model.pkl",
          "created_at": "2024-01-20T10:00:00Z",
          "file_size": "integer",
          "filename": "model.pkl"
        }
      ]
    },
    "id": "1",
    "type": "project_files"
  }
}

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # Path parameters
export project_id="1"
# 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/model-lab-api/projects/${project_id}/artifacts" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Get Model Lab artifact content

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/artifacts/contenthttps://api.ap2.datadoghq.com/api/v2/model-lab-api/artifacts/contenthttps://api.datadoghq.eu/api/v2/model-lab-api/artifacts/contenthttps://api.ddog-gov.com/api/v2/model-lab-api/artifacts/contenthttps://api.us2.ddog-gov.com/api/v2/model-lab-api/artifacts/contenthttps://api.datadoghq.com/api/v2/model-lab-api/artifacts/contenthttps://api.us3.datadoghq.com/api/v2/model-lab-api/artifacts/contenthttps://api.us5.datadoghq.com/api/v2/model-lab-api/artifacts/content

Información general

Download the raw content of a Model Lab artifact file.

Argumentos

Cadenas de consulta

Nombre

Tipo

Descripción

project_id [required]

string

ID of the project.

artifact_path [required]

string

Path to the artifact relative to the project directory.

Respuesta

OK

Expand All

Campo

Tipo

Descripción

No response body

{}

Bad Request

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Internal Server Error

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Ejemplo de código

                  # Required query arguments
export project_id="1"
export artifact_path="runs/42/model/weights.pt"
# 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/model-lab-api/artifacts/content?project_id=${project_id}&artifact_path=${artifact_path}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"