Skip to content

Click in-app to access the full platform documentation for your version of DataRobot.

Blueprints

This page outlines the operations, endpoints, parameters, and example requests and responses for the Blueprints.

GET /api/v2/projects/{projectId}/blueprints/

List appropriate blueprints for the project.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/blueprints/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID.

Example responses

200 Response

[
  {
    "blueprintCategory": "string",
    "id": "string",
    "modelType": "string",
    "monotonicDecreasingFeaturelistId": "string",
    "monotonicIncreasingFeaturelistId": "string",
    "processes": [
      "string"
    ],
    "projectId": "string",
    "recommendedFeaturelistId": "string",
    "supportsComposableMl": true,
    "supportsMonotonicConstraints": true
  }
]

Responses

Status Meaning Description Schema
200 OK The list of blueprints Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [BlueprintResponse] false none none
» blueprintCategory string true none describes the category of the blueprint and indicates the kind of model this blueprint produces. Will be either "DataRobot" or "Scaleout DataRobot".
» id string true none the blueprint ID of this blueprint - note that this is not an ObjectId.
» modelType string true none the model this blueprint will produce.
» monotonicDecreasingFeaturelistId string¦null true none the ID of the featurelist that defines the set of features with a monotonically decreasing relationship to the target. If null, no such constraints are enforced.
» monotonicIncreasingFeaturelistId string¦null true none null or str, the ID of the featurelist that defines the set of features with a monotonically increasing relationship to the target. If null, no such constraints are enforced.
» processes [string] true none a list of strings representing processes the blueprint uses.
» projectId string true none the project the blueprint belongs to.
» recommendedFeaturelistId string¦null true none The ID of the feature list recommended for this blueprint. If this field is not present, then there is no recommended feature list.
» supportsComposableMl boolean true none indicates whether this blueprint is supported in Composable ML.
» supportsMonotonicConstraints boolean true none whether this model supports enforcing monotonic constraints.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/blueprints/{blueprintId}/

Retrieve a blueprint by its ID.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/blueprints/{blueprintId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID.
blueprintId path string true The blueprint ID.

Example responses

200 Response

{
  "blueprintCategory": "string",
  "id": "string",
  "modelType": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "processes": [
    "string"
  ],
  "projectId": "string",
  "recommendedFeaturelistId": "string",
  "supportsComposableMl": true,
  "supportsMonotonicConstraints": true
}

Responses

Status Meaning Description Schema
200 OK A blueprint based on its blueprint ID. BlueprintResponse
404 Not Found This resource does not exist. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintChart/

Retrieve a blueprint chart by blueprint id.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintChart/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID.
blueprintId path string true The blueprint ID.

Example responses

200 Response

{
  "edges": [
    [
      "string",
      "string"
    ]
  ],
  "nodes": [
    {
      "id": "string",
      "label": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK A blueprint chart based on the blueprint id. BlueprintChartRetrieveResponse
404 Not Found No blueprint data found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintDocs/

Retrieve blueprint tasks documentation.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintDocs/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID.
blueprintId path string true The blueprint ID.

Example responses

200 Response

[
  {
    "description": "string",
    "links": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "parameters": [
      {
        "description": "string",
        "name": "string",
        "type": "string"
      }
    ],
    "references": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "task": "string",
    "title": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK The task documentation for a blueprint. Inline
404 Not Found Model document missing. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [BlueprintListDocumentsResponse] false none none
» description string true none The task description.
» links [BlueprintDocLinks] true none A list of external documentation links.
»» name string true none The name of the documentation at the link.
»» url string¦null true none The URL at which external documentation can be found.
» parameters [BlueprintDocParameters] true none An array of task parameters.
»» description string true none A description of what the parameter does.
»» name string true none The name of the parameter.
»» type string true none The type (and default value) of the parameter.
» references [BlueprintDocReferences] true none A list of reference links.
»» name string true none The name of the reference.
»» url string¦null true none The URL at which the reference can be found.
» task string true none The task described in document.
» title string true none The document title.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/blueprintChart/

Retrieve a reduced model blueprint chart by model id. The model blueprint charts are reduced from the full blueprint charts to show only those sections of the blueprint that were actually used in the model, given the selected featurelist.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/blueprintChart/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "edges": [
    [
      "string",
      "string"
    ]
  ],
  "nodes": [
    {
      "id": "string",
      "label": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK A reduced model blueprint chart based on the model id. BlueprintChartRetrieveResponse
404 Not Found No model found for given projectId and modelId. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/blueprintDocs/

Retrieve task documentation for a reduced model blueprint. The model blueprint is reduced from the full blueprint to show only those sections of the blueprint that were actually used in the model, given the selected featurelist.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/blueprintDocs/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

[
  {
    "description": "string",
    "links": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "parameters": [
      {
        "description": "string",
        "name": "string",
        "type": "string"
      }
    ],
    "references": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "task": "string",
    "title": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK The task documentation for a reduced model blueprint. Inline
404 Not Found No model found for given projectId and modelId. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [BlueprintListDocumentsResponse] false none none
» description string true none The task description.
» links [BlueprintDocLinks] true none A list of external documentation links.
»» name string true none The name of the documentation at the link.
»» url string¦null true none The URL at which external documentation can be found.
» parameters [BlueprintDocParameters] true none An array of task parameters.
»» description string true none A description of what the parameter does.
»» name string true none The name of the parameter.
»» type string true none The type (and default value) of the parameter.
» references [BlueprintDocReferences] true none A list of reference links.
»» name string true none The name of the reference.
»» url string¦null true none The URL at which the reference can be found.
» task string true none The task described in document.
» title string true none The document title.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/logs/

Retrieve an archive (tar.gz) of the logs produced and persisted by a model. Note that only blueprints with custom tasks create persistent logs - this will not work with any other type of model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/logs/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "data": "string"
}

Responses

Status Meaning Description Schema
200 OK An archive (tar.gz) of the logs produced and persisted by a model. PersistentModelLogsRetrieveResponse
403 Forbidden User does not have permissions to fetch model logs. None
404 Not Found Logs for this model could not be found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/trainingArtifact/

Retrieve an archive (tar.gz) of the artifacts produced and persisted by a model. Note that only blueprints with custom tasks create these artifacts - this will not work with any other type of model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/trainingArtifact/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "data": "string"
}

Responses

Status Meaning Description Schema
200 OK An archive (tar.gz) of the artifacts produced by this model. CustomModelArtifactsResponse
403 Forbidden User does not have permissions to fetch this artifact. None
404 Not Found The model with this modelID does not have any artifacts. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas

BlueprintChartRetrieveResponse

{
  "edges": [
    [
      "string",
      "string"
    ]
  ],
  "nodes": [
    {
      "id": "string",
      "label": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
edges [array] true none An array of chart edges - tuples of (start_id, end_id).
nodes [NodeDescription] true none An array of node descriptions.

{
  "name": "string",
  "url": "string"
}

Properties

Name Type Required Restrictions Description
name string true none The name of the documentation at the link.
url string¦null true none The URL at which external documentation can be found.

BlueprintDocParameters

{
  "description": "string",
  "name": "string",
  "type": "string"
}

Properties

Name Type Required Restrictions Description
description string true none A description of what the parameter does.
name string true none The name of the parameter.
type string true none The type (and default value) of the parameter.

BlueprintDocReferences

{
  "name": "string",
  "url": "string"
}

Properties

Name Type Required Restrictions Description
name string true none The name of the reference.
url string¦null true none The URL at which the reference can be found.

BlueprintListDocumentsResponse

{
  "description": "string",
  "links": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "parameters": [
    {
      "description": "string",
      "name": "string",
      "type": "string"
    }
  ],
  "references": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "task": "string",
  "title": "string"
}

Properties

Name Type Required Restrictions Description
description string true none The task description.
links [BlueprintDocLinks] true none A list of external documentation links.
parameters [BlueprintDocParameters] true none An array of task parameters.
references [BlueprintDocReferences] true none A list of reference links.
task string true none The task described in document.
title string true none The document title.

BlueprintResponse

{
  "blueprintCategory": "string",
  "id": "string",
  "modelType": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "processes": [
    "string"
  ],
  "projectId": "string",
  "recommendedFeaturelistId": "string",
  "supportsComposableMl": true,
  "supportsMonotonicConstraints": true
}

Properties

Name Type Required Restrictions Description
blueprintCategory string true none describes the category of the blueprint and indicates the kind of model this blueprint produces. Will be either "DataRobot" or "Scaleout DataRobot".
id string true none the blueprint ID of this blueprint - note that this is not an ObjectId.
modelType string true none the model this blueprint will produce.
monotonicDecreasingFeaturelistId string¦null true none the ID of the featurelist that defines the set of features with a monotonically decreasing relationship to the target. If null, no such constraints are enforced.
monotonicIncreasingFeaturelistId string¦null true none null or str, the ID of the featurelist that defines the set of features with a monotonically increasing relationship to the target. If null, no such constraints are enforced.
processes [string] true none a list of strings representing processes the blueprint uses.
projectId string true none the project the blueprint belongs to.
recommendedFeaturelistId string¦null true none The ID of the feature list recommended for this blueprint. If this field is not present, then there is no recommended feature list.
supportsComposableMl boolean true none indicates whether this blueprint is supported in Composable ML.
supportsMonotonicConstraints boolean true none whether this model supports enforcing monotonic constraints.

CustomModelArtifactsResponse

{
  "data": "string"
}

Properties

Name Type Required Restrictions Description
data string(binary) true none An archive (tar.gz) of the artifacts produced and persisted by a model.

NodeDescription

{
  "id": "string",
  "label": "string"
}

Properties

Name Type Required Restrictions Description
id string true none The ID of the node.
label string true none The label of the node.

PersistentModelLogsRetrieveResponse

{
  "data": "string"
}

Properties

Name Type Required Restrictions Description
data string(binary) true none An archive (tar.gz) of the logs produced and persisted by a model.

Updated December 7, 2022
Back to top