API

Refresh one owned Provider group

Generated from the checked-in source. Do not edit this reference by hand.

POST /v1/media/groups/{id}/refresh

Requires a workspace inference API key, current model permissions, composed workspace/key model and Provider grants, an enabled selectable credential and eligible Provider or matching personal owner. Only the explicitly configured fastrouter-actions-v1 model channel is supported. Opaque Provider references, credentials, private source URLs and upstream raw responses are never returned. Performs one explicit read of the original owned Provider reference and saves validated metadata. This is not a generation or mutation retry. Successful identity-validated reads persist nullable observation metadata even while the resource status and original uncertain operation remain unknown. Unknown writes remain blocked; this read does not redispatch, infer write completion, acknowledge a delete from 404, discover an unknown creation ID or grant material reuse. Failed reads preserve the previous observation and its timestamp.

Operation: refresh_groupProviderAsset.

Authentication

Use the credential and permission scope described above. Each object below is an alternative; schemes within one object are required together.

[
  {
    "bearerAuth": []
  },
  {
    "niuApiKeyAuth": []
  }
]

HTTP request

Set NIU_ORIGIN to your installation origin (without /v1). Replace path, query and header placeholders with the required values. Query examples use curl 7.87 or newer to encode values with --url-query. Use the credential scope described above; a bearer token must have the authority required by this operation.

Authentication alternative: bearerAuth.

curl --fail-with-body -X POST "$NIU_ORIGIN/v1/media/groups/{id}/refresh" \
  -H "Authorization: Bearer $NIU_BEARER_TOKEN" \
  --url-query 'model=<MODEL>'

Authentication alternative: niuApiKeyAuth.

curl --fail-with-body -X POST "$NIU_ORIGIN/v1/media/groups/{id}/refresh" \
  -H "X-Niu-API-Key: $NIU_API_KEY" \
  --url-query 'model=<MODEL>'

Parameters

id

Location: path. Required.

{
  "type": "string",
  "format": "uuid"
}

model

Location: query. Required.

{
  "type": "string"
}

Request body

No request body is declared.

Responses

HTTP 200

Owned metadata

Content type: application/json.

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "id",
        "model",
        "name",
        "kind",
        "status",
        "revision",
        "created_at_ms",
        "updated_at_ms",
        "observation"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "model": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "kind": {
          "type": "string",
          "enum": [
            "generated",
            "person"
          ]
        },
        "status": {
          "type": "string"
        },
        "revision": {
          "type": "string",
          "pattern": "^[1-9][0-9]*$"
        },
        "created_at_ms": {
          "type": "integer",
          "format": "int64"
        },
        "updated_at_ms": {
          "type": "integer",
          "format": "int64"
        },
        "observation": {
          "oneOf": [
            {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "source",
                "status",
                "name",
                "observed_at_ms",
                "description"
              ],
              "properties": {
                "source": {
                  "type": "string",
                  "const": "provider_get"
                },
                "status": {
                  "type": "string",
                  "const": "present"
                },
                "name": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 64
                },
                "observed_at_ms": {
                  "type": "integer",
                  "format": "int64",
                  "description": "Server time of the saved successful Provider read. Historical observation, not a current availability guarantee."
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 300
                }
              }
            },
            {
              "type": "null"
            }
          ],
          "description": "Last successful identity-validated Provider Get metadata, independent of mutation status. Null before any successful read. An observation never acknowledges or unblocks unknown writes, grants dispatch or proves an uncertain write completed."
        }
      }
    }
  }
}

HTTP 400

Malformed or unsupported request fields

HTTP 401

Missing, expired or revoked API key

HTTP 403

Workspace or key policy refuses access

HTTP 404

Owned object or model unavailable

HTTP 409

Changed input, stale revision, unresolved identity or route conflict

HTTP 413

Request exceeds its bounded size

HTTP 501

Selected channel does not support asset management

HTTP 502

Provider read failed safely

HTTP 503

Credential, capacity or bounded storage unavailable

Behavior and supported scope

Supported scope: implemented