Newsdesks
Set up the newsdesks Nuvelics writes pitches for, and choose the data sources each one subscribes to.
x-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.
limit?integerMaximum items per page (1–100, default 25)
1 <= value <= 10025cursor?stringOpaque cursor from a prior nextCursor
sort?stringSort order: "-field" descending, "field" ascending. Accepted: name, -name, createdAt, -createdAt, updatedAt, -updatedAt (default -updatedAt)
A page of newsdesks, most-recently-updated first
application/json- response
items*array<>pagination*sort*filters*facets?Value/count breakdown for each field requested via ?facets=. Present only when facets were requested.
included?curl -X GET 'https://api.nuvelics.com/api/tenant/v1/newsdesks'{ "items": [ { "id": "string", "orgId": "string", "name": "string", "description": "string", "audience": "string", "customInstructions": "string", "contentLanguage": "aa", "topics": [], "locations": [], "datasourceIds": [], "enabled": true, "version": 0, "lastRunAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "pagination": { "nextCursor": "string" }, "sort": { "applied": "string", "default": "string", "available": [ "string" ] }, "filters": { "applied": { "property1": null, "property2": null }, "available": [ { "field": "string", "kind": "string", "facetable": true } ] }, "facets": { "property1": { "values": [ { "value": "string", "count": 0 } ], "capped": true }, "property2": { "values": [ { "value": "string", "count": 0 } ], "capped": true } }, "included": { "datasources": { "property1": { "id": "string", "name": "string", "type": "string", "vendor": "datafactory", "iconId": "string" }, "property2": { "id": "string", "name": "string", "type": "string", "vendor": "datafactory", "iconId": "string" } }, "credentials": { "property1": { "id": "string", "name": "string", "schemeType": "string" }, "property2": { "id": "string", "name": "string", "schemeType": "string" } }, "users": { "property1": { "id": "string", "name": "string", "email": "string" }, "property2": { "id": "string", "name": "string", "email": "string" } }, "articlePitches": { "property1": [ { "id": "string", "title": "string", "status": "string", "newsdeskId": "string" } ], "property2": [ { "id": "string", "title": "string", "status": "string", "newsdeskId": "string" } ] } }}x-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.
application/json- body
name*stringNewsdesk display name
1 <= lengthdescription?stringFree-text description of the newsdesk's purpose
audience?stringFree-text description of the intended readership
customInstructions?stringFree-text editorial guidance passed to pitch generation
contentLanguage*stringOutput language this newsdesk's pitches are generated in
"aa""ab""ae""af""ak""am""an""ar""as""av""ay""az""ba""be""bg""bh""bi""bm""bn""bo""br""bs""ca""ce""ch""co""cr""cs""cu""cv""cy""da""de""dv""dz""ee""el""en""eo""es""et""eu""fa""ff""fi""fj""fo""fr""fy""ga""gd""gl""gn""gu""gv""ha""he""hi""ho""hr""ht""hu""hy""hz""ia""id""ie""ig""ii""ik""io""is""it""iu""ja""jv""ka""kg""ki""kj""kk""kl""km""kn""ko""kr""ks""ku""kv""kw""ky""la""lb""lg""li""ln""lo""lt""lu""lv""mg""mh""mi""mk""ml""mn""mr""ms""mt""my""na""nb""nd""ne""ng""nl""nn""no""nr""nv""ny""oc""oj""om""or""os""pa""pi""pl""ps""pt""qu""rm""rn""ro""ru""rw""sa""sc""sd""se""sg""sh""si""sk""sl""sm""sn""so""sq""sr""ss""st""su""sv""sw""ta""te""tg""th""ti""tk""tl""tn""to""tr""ts""tt""tw""ty""ug""uk""ur""uz""ve""vi""vo""wa""wo""xh""yi""yo""za""zh""zu"topics?array<>Beat topics this newsdesk covers, drawn from the controlled topic vocabulary
[]locations?array<string>Free-text beat locations this newsdesk covers, not a controlled vocabulary
[]datasourceIds?array<>The data sources subscribed to this newsdesk; their articles feed its pitch generation
[]Newsdesk created
application/json- response
id*stringNewsdesk identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$orgId*stringOwning organization identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$name*stringNewsdesk display name
1 <= lengthdescription?stringFree-text description of the newsdesk's purpose
audience?stringFree-text description of the intended readership
customInstructions?stringFree-text editorial guidance passed to pitch generation
contentLanguage*stringOutput language this newsdesk's pitches are generated in
"aa""ab""ae""af""ak""am""an""ar""as""av""ay""az""ba""be""bg""bh""bi""bm""bn""bo""br""bs""ca""ce""ch""co""cr""cs""cu""cv""cy""da""de""dv""dz""ee""el""en""eo""es""et""eu""fa""ff""fi""fj""fo""fr""fy""ga""gd""gl""gn""gu""gv""ha""he""hi""ho""hr""ht""hu""hy""hz""ia""id""ie""ig""ii""ik""io""is""it""iu""ja""jv""ka""kg""ki""kj""kk""kl""km""kn""ko""kr""ks""ku""kv""kw""ky""la""lb""lg""li""ln""lo""lt""lu""lv""mg""mh""mi""mk""ml""mn""mr""ms""mt""my""na""nb""nd""ne""ng""nl""nn""no""nr""nv""ny""oc""oj""om""or""os""pa""pi""pl""ps""pt""qu""rm""rn""ro""ru""rw""sa""sc""sd""se""sg""sh""si""sk""sl""sm""sn""so""sq""sr""ss""st""su""sv""sw""ta""te""tg""th""ti""tk""tl""tn""to""tr""ts""tt""tw""ty""ug""uk""ur""uz""ve""vi""vo""wa""wo""xh""yi""yo""za""zh""zu"topics?array<>Beat topics this newsdesk covers, drawn from the controlled topic vocabulary
[]locations?array<string>Free-text beat locations this newsdesk covers, not a controlled vocabulary
[]datasourceIds?array<>The data sources subscribed to this newsdesk; their articles feed its pitch generation
[]enabled*booleanWhen false the newsdesk is excluded from pitch generation runs
version*integerMonotonic row version; used as concurrency token
lastRunAt?stringISO 8601 timestamp of the most recent pitch generation run
date-timecreatedAt*stringISO 8601 creation timestamp
date-timeupdatedAt*stringISO 8601 last-modified timestamp
date-timecurl -X POST 'https://api.nuvelics.com/api/tenant/v1/newsdesks' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "contentLanguage": "aa"}'{ "id": "string", "orgId": "string", "name": "string", "description": "string", "audience": "string", "customInstructions": "string", "contentLanguage": "aa", "topics": [], "locations": [], "datasourceIds": [], "enabled": true, "version": 0, "lastRunAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}x-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.
id*stringNewsdesk identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Newsdesk found
application/json- response
id*stringNewsdesk identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$orgId*stringOwning organization identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$name*stringNewsdesk display name
1 <= lengthdescription?stringFree-text description of the newsdesk's purpose
audience?stringFree-text description of the intended readership
customInstructions?stringFree-text editorial guidance passed to pitch generation
contentLanguage*stringOutput language this newsdesk's pitches are generated in
"aa""ab""ae""af""ak""am""an""ar""as""av""ay""az""ba""be""bg""bh""bi""bm""bn""bo""br""bs""ca""ce""ch""co""cr""cs""cu""cv""cy""da""de""dv""dz""ee""el""en""eo""es""et""eu""fa""ff""fi""fj""fo""fr""fy""ga""gd""gl""gn""gu""gv""ha""he""hi""ho""hr""ht""hu""hy""hz""ia""id""ie""ig""ii""ik""io""is""it""iu""ja""jv""ka""kg""ki""kj""kk""kl""km""kn""ko""kr""ks""ku""kv""kw""ky""la""lb""lg""li""ln""lo""lt""lu""lv""mg""mh""mi""mk""ml""mn""mr""ms""mt""my""na""nb""nd""ne""ng""nl""nn""no""nr""nv""ny""oc""oj""om""or""os""pa""pi""pl""ps""pt""qu""rm""rn""ro""ru""rw""sa""sc""sd""se""sg""sh""si""sk""sl""sm""sn""so""sq""sr""ss""st""su""sv""sw""ta""te""tg""th""ti""tk""tl""tn""to""tr""ts""tt""tw""ty""ug""uk""ur""uz""ve""vi""vo""wa""wo""xh""yi""yo""za""zh""zu"topics?array<>Beat topics this newsdesk covers, drawn from the controlled topic vocabulary
[]locations?array<string>Free-text beat locations this newsdesk covers, not a controlled vocabulary
[]datasourceIds?array<>The data sources subscribed to this newsdesk; their articles feed its pitch generation
[]enabled*booleanWhen false the newsdesk is excluded from pitch generation runs
version*integerMonotonic row version; used as concurrency token
lastRunAt?stringISO 8601 timestamp of the most recent pitch generation run
date-timecreatedAt*stringISO 8601 creation timestamp
date-timeupdatedAt*stringISO 8601 last-modified timestamp
date-timecurl -X GET 'https://api.nuvelics.com/api/tenant/v1/newsdesks/string'{ "id": "string", "orgId": "string", "name": "string", "description": "string", "audience": "string", "customInstructions": "string", "contentLanguage": "aa", "topics": [], "locations": [], "datasourceIds": [], "enabled": true, "version": 0, "lastRunAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}x-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.
id*stringNewsdesk identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$application/json- body
name?string1 <= lengthdescription?stringaudience?stringcustomInstructions?stringcontentLanguage?string"aa""ab""ae""af""ak""am""an""ar""as""av""ay""az""ba""be""bg""bh""bi""bm""bn""bo""br""bs""ca""ce""ch""co""cr""cs""cu""cv""cy""da""de""dv""dz""ee""el""en""eo""es""et""eu""fa""ff""fi""fj""fo""fr""fy""ga""gd""gl""gn""gu""gv""ha""he""hi""ho""hr""ht""hu""hy""hz""ia""id""ie""ig""ii""ik""io""is""it""iu""ja""jv""ka""kg""ki""kj""kk""kl""km""kn""ko""kr""ks""ku""kv""kw""ky""la""lb""lg""li""ln""lo""lt""lu""lv""mg""mh""mi""mk""ml""mn""mr""ms""mt""my""na""nb""nd""ne""ng""nl""nn""no""nr""nv""ny""oc""oj""om""or""os""pa""pi""pl""ps""pt""qu""rm""rn""ro""ru""rw""sa""sc""sd""se""sg""sh""si""sk""sl""sm""sn""so""sq""sr""ss""st""su""sv""sw""ta""te""tg""th""ti""tk""tl""tn""to""tr""ts""tt""tw""ty""ug""uk""ur""uz""ve""vi""vo""wa""wo""xh""yi""yo""za""zh""zu"topics?array<>locations?array<string>enabled?booleanNewsdesk updated
application/json- response
id*stringNewsdesk identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$orgId*stringOwning organization identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$name*stringNewsdesk display name
1 <= lengthdescription?stringFree-text description of the newsdesk's purpose
audience?stringFree-text description of the intended readership
customInstructions?stringFree-text editorial guidance passed to pitch generation
contentLanguage*stringOutput language this newsdesk's pitches are generated in
"aa""ab""ae""af""ak""am""an""ar""as""av""ay""az""ba""be""bg""bh""bi""bm""bn""bo""br""bs""ca""ce""ch""co""cr""cs""cu""cv""cy""da""de""dv""dz""ee""el""en""eo""es""et""eu""fa""ff""fi""fj""fo""fr""fy""ga""gd""gl""gn""gu""gv""ha""he""hi""ho""hr""ht""hu""hy""hz""ia""id""ie""ig""ii""ik""io""is""it""iu""ja""jv""ka""kg""ki""kj""kk""kl""km""kn""ko""kr""ks""ku""kv""kw""ky""la""lb""lg""li""ln""lo""lt""lu""lv""mg""mh""mi""mk""ml""mn""mr""ms""mt""my""na""nb""nd""ne""ng""nl""nn""no""nr""nv""ny""oc""oj""om""or""os""pa""pi""pl""ps""pt""qu""rm""rn""ro""ru""rw""sa""sc""sd""se""sg""sh""si""sk""sl""sm""sn""so""sq""sr""ss""st""su""sv""sw""ta""te""tg""th""ti""tk""tl""tn""to""tr""ts""tt""tw""ty""ug""uk""ur""uz""ve""vi""vo""wa""wo""xh""yi""yo""za""zh""zu"topics?array<>Beat topics this newsdesk covers, drawn from the controlled topic vocabulary
[]locations?array<string>Free-text beat locations this newsdesk covers, not a controlled vocabulary
[]datasourceIds?array<>The data sources subscribed to this newsdesk; their articles feed its pitch generation
[]enabled*booleanWhen false the newsdesk is excluded from pitch generation runs
version*integerMonotonic row version; used as concurrency token
lastRunAt?stringISO 8601 timestamp of the most recent pitch generation run
date-timecreatedAt*stringISO 8601 creation timestamp
date-timeupdatedAt*stringISO 8601 last-modified timestamp
date-timecurl -X PATCH 'https://api.nuvelics.com/api/tenant/v1/newsdesks/string' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": "string", "orgId": "string", "name": "string", "description": "string", "audience": "string", "customInstructions": "string", "contentLanguage": "aa", "topics": [], "locations": [], "datasourceIds": [], "enabled": true, "version": 0, "lastRunAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}x-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.
id*stringNewsdesk identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Newsdesk deleted
curl -X DELETE 'https://api.nuvelics.com/api/tenant/v1/newsdesks/string'x-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.
id*stringNewsdesk identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$application/json- body
datasourceIds*array<>Newsdesk's datasource subscription replaced
application/json- response
id*stringNewsdesk identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$orgId*stringOwning organization identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$name*stringNewsdesk display name
1 <= lengthdescription?stringFree-text description of the newsdesk's purpose
audience?stringFree-text description of the intended readership
customInstructions?stringFree-text editorial guidance passed to pitch generation
contentLanguage*stringOutput language this newsdesk's pitches are generated in
"aa""ab""ae""af""ak""am""an""ar""as""av""ay""az""ba""be""bg""bh""bi""bm""bn""bo""br""bs""ca""ce""ch""co""cr""cs""cu""cv""cy""da""de""dv""dz""ee""el""en""eo""es""et""eu""fa""ff""fi""fj""fo""fr""fy""ga""gd""gl""gn""gu""gv""ha""he""hi""ho""hr""ht""hu""hy""hz""ia""id""ie""ig""ii""ik""io""is""it""iu""ja""jv""ka""kg""ki""kj""kk""kl""km""kn""ko""kr""ks""ku""kv""kw""ky""la""lb""lg""li""ln""lo""lt""lu""lv""mg""mh""mi""mk""ml""mn""mr""ms""mt""my""na""nb""nd""ne""ng""nl""nn""no""nr""nv""ny""oc""oj""om""or""os""pa""pi""pl""ps""pt""qu""rm""rn""ro""ru""rw""sa""sc""sd""se""sg""sh""si""sk""sl""sm""sn""so""sq""sr""ss""st""su""sv""sw""ta""te""tg""th""ti""tk""tl""tn""to""tr""ts""tt""tw""ty""ug""uk""ur""uz""ve""vi""vo""wa""wo""xh""yi""yo""za""zh""zu"topics?array<>Beat topics this newsdesk covers, drawn from the controlled topic vocabulary
[]locations?array<string>Free-text beat locations this newsdesk covers, not a controlled vocabulary
[]datasourceIds?array<>The data sources subscribed to this newsdesk; their articles feed its pitch generation
[]enabled*booleanWhen false the newsdesk is excluded from pitch generation runs
version*integerMonotonic row version; used as concurrency token
lastRunAt?stringISO 8601 timestamp of the most recent pitch generation run
date-timecreatedAt*stringISO 8601 creation timestamp
date-timeupdatedAt*stringISO 8601 last-modified timestamp
date-timecurl -X PUT 'https://api.nuvelics.com/api/tenant/v1/newsdesks/string/datasources' \ -H 'Content-Type: application/json' \ -d '{ "datasourceIds": [ "string" ]}'{ "id": "string", "orgId": "string", "name": "string", "description": "string", "audience": "string", "customInstructions": "string", "contentLanguage": "aa", "topics": [], "locations": [], "datasourceIds": [], "enabled": true, "version": 0, "lastRunAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}