MAM connections

Connect your media asset management systems, whose archives Nuvelics searches for photos and videos when it researches a story.

List MAM connections for the organization

GET

/api/tenant/v1/mam-configs

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Query Parameters

include?string

Set to health to include each connection's outbound credential health. Omitted entirely by default, so the ordinary list pays no health-lookup cost.

Response Body

Every MAM connection configured for the organization. Items carry health only when the request includes ?include=health.

application/json

response

items*array<>

Example Request

curl -X GET 'https://api.nuvelics.com/api/tenant/v1/mam-configs'

Example Request

curl -X GET 'https://api.nuvelics.com/api/tenant/v1/mam-configs'

Example ResponseSchema

{
  "items": [
    {
      "id": "string",
      "orgId": "string",
      "displayName": "string",
      "credentialId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "version": 0,
      "vendor": "mimir",
      "baseUrl": "http://example.com",
      "health": {
        "status": "healthy",
        "lastError": "string",
        "lastCheckedAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "fundingStatus": "ok"
      }
    }
  ]
}

{  "items": [    {      "id": "string",      "orgId": "string",      "displayName": "string",      "credentialId": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "version": 0,      "vendor": "mimir",      "baseUrl": "http://example.com",      "health": {        "status": "healthy",        "lastError": "string",        "lastCheckedAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "fundingStatus": "ok"      }    }  ]}

body

Mimir MAM connection

displayName*string

MAM connection display name

Length1 <= length

vendor*"mimir"

Value in"mimir"

baseUrl*string

The tenant's Mimir stage host, e.g. https://mimir.mjoll.no (https only)

Formaturi

apiKey*string

Length1 <= length

Response Body

MAM connection created

application/json

response

id*string

MAM connection identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

orgId*string

Owning organization identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

displayName*string

MAM connection display name

Length1 <= length

credentialId*string

Reference to stored credential

createdAt*string

ISO 8601 creation timestamp

Formatdate-time

updatedAt*string

ISO 8601 last-modified timestamp

Formatdate-time

version*integer

Monotonic row version; used as concurrency token

vendor*"mimir"

Value in"mimir"

baseUrl*string

The tenant's Mimir stage host, e.g. https://mimir.mjoll.no (https only)

Formaturi

Example Request

curl -X POST 'https://api.nuvelics.com/api/tenant/v1/mam-configs' \
  -H 'Content-Type: application/json' \
  -d '{
  "displayName": "string",
  "vendor": "mimir",
  "baseUrl": "http://example.com",
  "apiKey": "string"
}'

Example Request

curl -X POST 'https://api.nuvelics.com/api/tenant/v1/mam-configs' \  -H 'Content-Type: application/json' \  -d '{  "displayName": "string",  "vendor": "mimir",  "baseUrl": "http://example.com",  "apiKey": "string"}'

Example ResponseSchema

{
  "id": "string",
  "orgId": "string",
  "displayName": "string",
  "credentialId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "version": 0,
  "vendor": "mimir",
  "baseUrl": "http://example.com"
}

{  "id": "string",  "orgId": "string",  "displayName": "string",  "credentialId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "version": 0,  "vendor": "mimir",  "baseUrl": "http://example.com"}

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Query Parameters

include?string

Set to health to include the connection's outbound credential health. Omitted entirely by default.

Response Body

The MAM connection. Carries health only when the request includes ?include=health.

application/json

response

health?

Health of a credential from the most recent harvest auth check, null when never checked

id*string

MAM connection identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

orgId*string

Owning organization identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

displayName*string

MAM connection display name

Length1 <= length

credentialId*string

Reference to stored credential

createdAt*string

ISO 8601 creation timestamp

Formatdate-time

updatedAt*string

ISO 8601 last-modified timestamp

Formatdate-time

version*integer

Monotonic row version; used as concurrency token

vendor*"mimir"

Value in"mimir"

baseUrl*string

The tenant's Mimir stage host, e.g. https://mimir.mjoll.no (https only)

Formaturi

Example Request

curl -X GET 'https://api.nuvelics.com/api/tenant/v1/mam-configs/string'

Example Request

curl -X GET 'https://api.nuvelics.com/api/tenant/v1/mam-configs/string'

Example ResponseSchema

{
  "id": "string",
  "orgId": "string",
  "displayName": "string",
  "credentialId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "version": 0,
  "vendor": "mimir",
  "baseUrl": "http://example.com",
  "health": {
    "status": "healthy",
    "lastError": "string",
    "lastCheckedAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "fundingStatus": "ok"
  }
}

{  "id": "string",  "orgId": "string",  "displayName": "string",  "credentialId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "version": 0,  "vendor": "mimir",  "baseUrl": "http://example.com",  "health": {    "status": "healthy",    "lastError": "string",    "lastCheckedAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "fundingStatus": "ok"  }}

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Request Body

application/json

body

displayName?string

Length1 <= length

baseUrl?string

Formaturi

apiKey?string

Length1 <= length

Response Body

MAM connection updated

application/json

response

id*string

MAM connection identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

orgId*string

Owning organization identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

displayName*string

MAM connection display name

Length1 <= length

credentialId*string

Reference to stored credential

createdAt*string

ISO 8601 creation timestamp

Formatdate-time

updatedAt*string

ISO 8601 last-modified timestamp

Formatdate-time

version*integer

Monotonic row version; used as concurrency token

vendor*"mimir"

Value in"mimir"

baseUrl*string

The tenant's Mimir stage host, e.g. https://mimir.mjoll.no (https only)

Formaturi

Example Request

curl -X PATCH 'https://api.nuvelics.com/api/tenant/v1/mam-configs/string' \
  -H 'Content-Type: application/json' \
  -d '{}'

Example Request

curl -X PATCH 'https://api.nuvelics.com/api/tenant/v1/mam-configs/string' \  -H 'Content-Type: application/json' \  -d '{}'

Example ResponseSchema

{
  "id": "string",
  "orgId": "string",
  "displayName": "string",
  "credentialId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "version": 0,
  "vendor": "mimir",
  "baseUrl": "http://example.com"
}

{  "id": "string",  "orgId": "string",  "displayName": "string",  "credentialId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "version": 0,  "vendor": "mimir",  "baseUrl": "http://example.com"}

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

MAM connection deleted, together with its credential

Example Request

curl -X DELETE 'https://api.nuvelics.com/api/tenant/v1/mam-configs/string'

Example Request

curl -X DELETE 'https://api.nuvelics.com/api/tenant/v1/mam-configs/string'

Example Response

Empty

List MAM connections for the organization

Authorization

Query Parameters

Response Body

Create a MAM connection

Authorization

Request Body

Response Body

Get a MAM connection

Authorization

Path Parameters

Query Parameters

Response Body

Update a MAM connection (PATCH-merge)

Authorization

Path Parameters

Request Body

Response Body

Delete a MAM connection

Authorization

Path Parameters

Response Body

On this page

MAM connections

List MAM connections for the organizationCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Create a MAM connectionCopy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Get a MAM connectionCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Update a MAM connection (PATCH-merge)Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Delete a MAM connectionCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

On this page

List MAM connections for the organization

Authorization

Query Parameters

Response Body

Create a MAM connection

Authorization

Request Body

Response Body

Get a MAM connection

Authorization

Path Parameters

Query Parameters

Response Body

Update a MAM connection (PATCH-merge)

Authorization

Path Parameters

Request Body

Response Body

Delete a MAM connection

Authorization

Path Parameters

Response Body