Deployments

Read deployment progress and qualification results. Start deployments in the console.

GET /v1/org/deployments

Authorization

Authorizationheader · string: Bearer $BOARDWALK_API_KEY. Requires deployments:read.

Request

curl "https://api.boardwalk.cloud/v1/org/deployments?limit=50" \
  -H "Authorization: Bearer $BOARDWALK_API_KEY"

Query parameters

cursorstringoptional: Opaque next_cursor from the previous page, at most 256 characters. Keep all other filters unchanged.
limitintegeroptional: Page size from 1 to 200. Default: 50.
model_idstringoptional: Internal model ID.
statusstringoptional: Filter bucket: running, succeeded, failed, or stopped. Responses return the actual phase name.

Response

Example response. IDs, token counts, and rates are illustrative.

{
  "object": "list",
  "data": [
    {
      "id": "dep_example",
      "object": "deployment",
      "model_id": "mdl_example",
      "model": "support-agent",
      "status": "screening",
      "failure_detail": null,
      "created_at": "2026-09-16T00:00:00.000Z",
      "updated_at": "2026-09-16T00:00:00.000Z",
      "ended_at": null,
      "revision_id": null,
      "hf_revision": "0123456789abcdef0123456789abcdef01234567",
      "started_by_user_id": "user_example"
    }
  ],
  "next_cursor": null
}

object"list"

Object type.

dataobject[]

Records ordered newest first.

Child fields

idstring: Deployment ID.
object"deployment": Object type.
model_idstring: Internal model ID.
modelstring: Callable model name.
statusstring: Actual phase: screening, materializing, waiting, queued, provisioning, booting, checking, measuring, benchmarking, activating, activated, failed, or cancelled.
failure_detailstring | null: Redacted failure explanation.
created_atstring: ISO 8601 start time.
updated_atstring: ISO 8601 last update time.
ended_atstring | null: ISO 8601 completion time; null while running.
revision_idstring | null: Associated configuration revision.
hf_revisionstring | null: Pinned weight commit.
started_by_user_idstring | null: User who started the deployment, when known.

next_cursorstring | null

Pass as cursor for the next page. Null marks the end.

Retrieve one record

GET /v1/org/deployments/{id} returns one object directly, without the list envelope. It accepts no query parameters.

idpath · stringrequired: Record ID from a list response.

curl https://api.boardwalk.cloud/v1/org/deployments/dep_example \
  -H "Authorization: Bearer $BOARDWALK_API_KEY"

{
  "id": "dep_example",
  "object": "deployment",
  "model_id": "mdl_example",
  "model": "support-agent",
  "status": "screening",
  "failure_detail": null,
  "created_at": "2026-09-16T00:00:00.000Z",
  "updated_at": "2026-09-16T00:00:00.000Z",
  "ended_at": null,
  "revision_id": null,
  "hf_revision": "0123456789abcdef0123456789abcdef01234567",
  "started_by_user_id": "user_example",
  "phases": [
    { "status": "screening", "at": "2026-09-16T00:00:00.000Z" }
  ],
  "checks": [],
  "revision": null
}

phasesobject[]

Detail response only: recorded phase transitions.

Child fields

statusstring: Phase name.
atstring: ISO 8601 transition time.

checksobject[]

Detail response only: qualification results.

Child fields

namestring: Check name.
passedboolean: Whether the check passed.
detailstring: Additional detail, when recorded.

revisionobject | null

Detail response only: associated configuration.

Child fields

idstring

Configuration revision ID.

statusstring

draft, active, or superseded.

hf_revisionstring

Pinned weight commit.

dtypestring

Serving precision.

quantizationstring

Quantization method, or none.

max_model_leninteger

Combined input and output token limit.

enginestring

Serving engine.

engine_versionstring

Pinned engine version.

gpu_poolstring

GPU pool for the configuration.

gpu_countinteger

GPUs in the configuration.

pricesobject

Rates for this configuration. Draft prices are not active rates.

Child fields

input_micros_per_mtokstring: Input rate. Integer micro-dollars per million tokens.
output_micros_per_mtokstring: Output rate. Integer micro-dollars per million tokens.
cache_read_micros_per_mtokstring: Cache-read rate. Integer micro-dollars per million tokens.
cache_write_micros_per_mtokstring: Cache-write rate. Integer micro-dollars per million tokens.

verified_atstring | null

Qualification time, in ISO 8601 format.

Errors

Errors use the shared error format. Save the x-request-id response header for receipts and support.