PAGES

← taranis-ai

taranis-ai — API

Taranis AIv1.3.6 Read the vendor's spec ↗

  • 363 endpoints
  • 2 versions archived since Nov 11, 2026
  • Last checked Nov 14, 2026

The Taranis API provides endpoints for the Taranis is an OSINT gathering and analysis tool.

Get started

first call
$ curl "/api/health"
Base URL
/api
Authenticate
Bearer token in the Authorization header
2 other schemes
  • Bearer token in the Authorization header
  • API key in the X-Realtime-Proxy-Key header

What it covers

  • Config 161 read/update/delete everything config-related
  • Assess 63 read/update/delete OSINT sources and news items
  • Worker 33 create, read, update
  • Analyze 28 read/update report items, their types, groups and attributes
  • Assets 17 read/update/delete asset groups, notification templates and attributes
  • Bots 17 read/update/delete bots-related information
  • Publish 15 read/update/delete/publish products
  • Dashboard 8 get dashboard data
  • Auth 5 session-related functionality
  • Chat 5 persistent analyst conversations backed by the configured LLM provider
  • Users 4 read/update the profile, get wordlists, product types and publisher presets
  • Realtime 3 authenticate Centrifugo realtime connections
3 more areas
  • Tasks 2 read
  • Health 1 see whether Taranis dependencies are healthy
  • Isalive 1 see whether the Taranis instance is alive

Endpoints

363 of 363

Open an endpoint for a runnable command, its inputs and what it returns.

Config 161

  • DELETE /config/acls delete acls

    Loading…

  • DELETE /config/acls/{acl_id} delete ACL entry

    Loading…

  • DELETE /config/attributes delete attributes

    Loading…

  • DELETE /config/attributes/{attribute_id} delete attribute

    Loading…

  • DELETE /config/bots/{bot_id} delete bot

    Loading…

  • DELETE /config/connectors/{connector_id} delete connectors

    Loading…

  • DELETE /config/organizations delete organizations

    Loading…

  • DELETE /config/organizations/{organization_id} delete organization

    Loading…

  • DELETE /config/osint-source-groups delete osint source groups

    Loading…

  • DELETE /config/osint-source-groups/{group_id} delete OSINT source group

    Loading…

  • DELETE /config/osint-sources delete multiple OSINT sources

    Loading…

  • DELETE /config/osint-sources/{osint_source_id} delete OSINT source

    Loading…

  • DELETE /config/product-types/{type_id} delete product type

    Loading…

  • DELETE /config/publisher-presets/{preset_id} delete publisher presets

    Loading…

  • DELETE /config/publishers-presets/{preset_id} delete publishers presets

    Loading…

  • DELETE /config/report-item-types delete report item types

    Loading…

  • DELETE /config/report-item-types/{type_id} delete report item type

    Loading…

  • DELETE /config/roles delete roles

    Loading…

  • DELETE /config/roles/{role_id} delete role

    Loading…

  • DELETE /config/sources/{source_id} delete sources

    Loading…

  • DELETE /config/templates delete templates

    Loading…

  • DELETE /config/templates/{template_path} delete a presenter template

    Loading…

  • DELETE /config/users delete users

    Loading…

  • DELETE /config/users/{user_id} delete user

    Loading…

  • DELETE /config/word-lists delete word lists

    Loading…

  • DELETE /config/word-lists/{word_list_id} delete wordlist

    Loading…

  • DELETE /tasks delete tasks

    Loading…

  • DELETE /tasks/{task_id} delete a task result

    Loading…

  • GET /config/acls get all ACL entries

    Loading…

  • GET /config/acls/{acl_id} get acls

    Loading…

  • GET /config/admin-menu-badges get admin menu badges

    Loading…

  • GET /config/attributes get attributes

    Loading…

  • GET /config/attributes/{attribute_id} get attributes

    Loading…

  • GET /config/bots get all bots

    Loading…

  • GET /config/bots/{bot_id} get bots

    Loading…

  • GET /config/connectors get connectors

    Loading…

  • GET /config/connectors/{connector_id} get connectors

    Loading…

  • GET /config/curated-osint-source-lists get the bundled curated OSINT source lists

    Loading…

  • GET /config/export-osint-sources export OSINT sources

    Loading…

  • GET /config/export-report-item-types get export report item types

    Loading…

  • GET /config/export-word-lists export Wordlists

    Loading…

  • GET /config/organizations get all organizations

    Loading…

  • GET /config/organizations/{organization_id} get organizations

    Loading…

  • GET /config/osint-source-groups get all OSINT source groups

    Loading…

  • GET /config/osint-source-groups/options Get IDs and names for source-group form options.

    Loading…

  • GET /config/osint-source-groups/{group_id} get osint source groups

    Loading…

  • GET /config/osint-sources get all OSINT sources

    Loading…

  • GET /config/osint-sources/{osint_source_id} get osint sources

    Loading…

  • GET /config/osint-sources/{source_id}/preview get osint sources preview

    Loading…

  • GET /config/permissions get all permissions

    Loading…

  • GET /config/product-types get all product types

    Loading…

  • GET /config/product-types/{type_id} get product types

    Loading…

  • GET /config/publisher-presets get publisher presets

    Loading…

  • GET /config/publisher-presets/{preset_id} get publisher presets

    Loading…

  • GET /config/publishers-presets get all publisher preset

    Loading…

  • GET /config/publishers-presets/{preset_id} get publishers presets

    Loading…

  • GET /config/report-item-types get report item types

    Loading…

  • GET /config/report-item-types/{type_id} get report item types

    Loading…

  • GET /config/roles get all roles

    Loading…

  • GET /config/roles/{role_id} get roles

    Loading…

  • GET /config/schedule get schedule

    Loading…

  • GET /config/schedule/{task_id} get schedule

    Loading…

  • GET /config/sources get sources

    Loading…

  • GET /config/sources/{source_id} get sources

    Loading…

  • GET /config/templates list all presenter templates with validation status

    Loading…

  • GET /config/templates/{template_path} get a single presenter template (base64 encoded content) with validation status

    Loading…

  • GET /config/users get all users

    Loading…

  • GET /config/users-export get users export

    Loading…

  • GET /config/users/{user_id} get user details

    Loading…

  • GET /config/word-lists get all wordlists

    Loading…

  • GET /config/word-lists/{word_list_id} get word lists

    Loading…

  • GET /config/workers get all workers connected for RQ (via Redis)

    Loading…

  • GET /config/workers/active get workers active

    Loading…

  • GET /config/workers/cron-jobs get workers cron jobs

    Loading…

  • GET /config/workers/failed get workers failed

    Loading…

  • GET /config/workers/queue-status get queue status for all workers

    Loading…

  • GET /config/workers/schedule get workers schedule

    Loading…

  • GET /config/workers/stats get workers stats

    Loading…

  • GET /config/workers/tasks get workers tasks

    Loading…

  • GET /settings/export-stories Export all stories as a JSON array.

    Loading…

  • GET /settings/settings Get settings including llm_endpoints (API keys omitted, api_key_configured indicates whether a key is stored).

    Loading…

  • GET /tasks list task history and statistics

    Loading…

  • GET /tasks/{task_id} get a single task result

    Loading…

  • PATCH /config/bots/{bot_id} merge configured worker parameters

    Loading…

  • PATCH /config/connectors/{connector_id} update connectors

    Loading…

  • PATCH /config/osint-sources/{osint_source_id} update osint sources

    Loading…

  • PATCH /config/product-types/{type_id} merge configured worker parameters

    Loading…

  • PATCH /config/publisher-presets/{preset_id} merge configured worker parameters

    Loading…

  • PATCH /config/publishers-presets/{preset_id} merge configured worker parameters

    Loading…

  • PATCH /config/sources/{source_id} update sources

    Loading…

  • PATCH /settings/settings update settings

    Loading…

  • POST /config/acls add ACL entry

    Loading…

  • POST /config/attributes add attribute

    Loading…

  • POST /config/bots add bot

    Loading…

  • POST /config/bots/dag-preview preview a bot run-order DAG

    Loading…

  • POST /config/bots/{bot_id}/execute execute bot

    Loading…

  • POST /config/connectors handle connectors

    Loading…

  • POST /config/connectors/{connector_id}/pull handle connectors pull

    Loading…

  • POST /config/curated-osint-source-lists add or relink sources from bundled curated lists

    Loading…

  • POST /config/dictionaries-reload/{dictionary_type} handle dictionaries reload

    Loading…

  • POST /config/import-osint-sources import OSINT sources

    Loading…

  • POST /config/import-report-item-types handle import report item types

    Loading…

  • POST /config/import-word-lists import Wordlists

    Loading…

  • POST /config/organizations add organization

    Loading…

  • POST /config/osint-source-groups add OSINT source group

    Loading…

  • POST /config/osint-sources add OSINT source

    Loading…

  • POST /config/osint-sources/collect collect all OSINT sources

    Loading…

  • POST /config/osint-sources/{osint_source_id}/collect collect OSINT source

    Loading…

  • POST /config/osint-sources/{source_id}/preview handle osint sources preview

    Loading…

  • POST /config/parameter-secrets/{resource}/{resource_id}/{parameter}/reveal reveal a configured secret after resource update authorization

    Loading…

  • POST /config/product-types add product type

    Loading…

  • POST /config/publisher-presets handle publisher presets

    Loading…

  • POST /config/publishers-presets add publisher preset

    Loading…

  • POST /config/report-item-types add report item type

    Loading…

  • POST /config/roles add role

    Loading…

  • POST /config/sources handle sources

    Loading…

  • POST /config/templates create or update a presenter template (by name in body) and return validation status

    Loading…

  • POST /config/templates/validate validate a Jinja2 template without saving it

    Loading…

  • POST /config/templates/{template_path} handle templates

    Loading…

  • POST /config/users add user

    Loading…

  • POST /config/users-import handle users import

    Loading…

  • POST /config/word-lists add wordlist

    Loading…

  • POST /config/word-lists/gather handle word lists gather

    Loading…

  • POST /config/word-lists/gather/{word_list_id} gather wordlist entries

    Loading…

  • POST /settings/clear-queues clear queues

    Loading…

  • POST /settings/delete-stories delete stories

    Loading…

  • POST /settings/delete-tags delete tags

    Loading…

  • POST /settings/llm-endpoints Create an LLM endpoint (ADMIN_OPERATIONS required).

    Loading…

  • POST /settings/llm-endpoints/{endpoint_id} Update submitted endpoint fields.

    Loading…

  • POST /settings/llm-endpoints/{endpoint_id}/delete Delete an endpoint after removing its default, feature, and bot assignments.

    Loading…

  • POST /settings/rebuild-story-search-vectors rebuild story search vectors

    Loading…

  • POST /settings/reset-database reset database

    Loading…

  • POST /settings/settings update settings

    Loading…

  • POST /settings/ungroup-stories ungroup stories

    Loading…

  • POST /tasks submit a worker task result

    Loading…

  • PUT /config/acls update acls

    Loading…

  • PUT /config/acls/{acl_id} update ACL entry

    Loading…

  • PUT /config/attributes update attributes

    Loading…

  • PUT /config/attributes/{attribute_id} update attribute

    Loading…

  • PUT /config/bots/{bot_id} update bot

    Loading…

  • PUT /config/connectors/{connector_id} update connectors

    Loading…

  • PUT /config/organizations update organizations

    Loading…

  • PUT /config/organizations/{organization_id} update organization

    Loading…

  • PUT /config/osint-source-groups update osint source groups

    Loading…

  • PUT /config/osint-source-groups/{group_id} update OSINT source group

    Loading…

  • PUT /config/osint-sources/{osint_source_id} update OSINT source

    Loading…

  • PUT /config/product-types/{type_id} update product type

    Loading…

  • PUT /config/publisher-presets/{preset_id} update publisher presets

    Loading…

  • PUT /config/publishers-presets/{preset_id} update publisher preset

    Loading…

  • PUT /config/report-item-types update report item types

    Loading…

  • PUT /config/report-item-types/{type_id} update report item type

    Loading…

  • PUT /config/roles update roles

    Loading…

  • PUT /config/roles/{role_id} update role

    Loading…

  • PUT /config/sources/{source_id} update sources

    Loading…

  • PUT /config/templates update templates

    Loading…

  • PUT /config/templates/{template_path} update a presenter template (by path) and return validation status

    Loading…

  • PUT /config/users update users

    Loading…

  • PUT /config/users/{user_id} update user

    Loading…

  • PUT /config/word-lists update word lists

    Loading…

  • PUT /config/word-lists/{word_list_id} update wordlist

    Loading…

  • PUT /settings/settings update settings

    Loading…

Assess 63

  • DELETE /assess/bookmarks/{bookmark_id} delete a private story bookmark collection without deleting stories

    Loading…

  • DELETE /assess/news-items/{item_id} delete the specified news item

    Loading…

  • DELETE /assess/stories/{story_id} delete stories

    Loading…

  • DELETE /assess/story/{story_id} delete the specified story

    Loading…

  • GET /assess/analyst-review/snapshot get the stable shift and unread story snapshot for an analyst review

    Loading…

  • GET /assess/bookmarks get private story bookmark collections for the current user

    Loading…

  • GET /assess/bookmarks/{bookmark_id} get a private story bookmark collection

    Loading…

  • GET /assess/connectors get connectors available to assess users for story sharing

    Loading…

  • GET /assess/connectors/proposals get connectors proposals

    Loading…

  • GET /assess/filter-lists get filter lists

    Loading…

  • GET /assess/news-items get news items

    Loading…

  • GET /assess/news-items/{item_id} get the specified news item

    Loading…

  • GET /assess/news-items/{item_id}/cti get CTI information for IOC tags on the specified news item

    Loading…

  • GET /assess/osint-source-group-list get all the user's OSINT source groups

    Loading…

  • GET /assess/osint-sources-list get manual OSINT sources

    Loading…

  • GET /assess/stories get stories by filters

    Loading…

  • GET /assess/stories/bulk_action get stories bulk action

    Loading…

  • GET /assess/stories/export Export selected stories as an import-compatible JSON download.

    Loading…

  • GET /assess/stories/{story_id} get stories

    Loading…

  • GET /assess/stories/{story_id}/cti get CTI information for IOC tags on news items in the story

    Loading…

  • GET /assess/stories/{story_id}/revisions get stories revisions

    Loading…

  • GET /assess/stories/{story_id}/revisions/{revision_number} get stories revisions

    Loading…

  • GET /assess/story/{connector_id}/share get story share

    Loading…

  • GET /assess/story/{story_id} get the specified story

    Loading…

  • GET /assess/taglist Get unique non-report tag names from stories visible to the current user.

    Loading…

  • GET /connectors/conflicts/news-items get conflicts news items

    Loading…

  • GET /connectors/conflicts/stories get conflicts stories

    Loading…

  • GET /connectors/conflicts/stories/{story_id} get conflicts stories

    Loading…

  • GET /connectors/story-summary/{story_id} get story summary

    Loading…

  • PATCH /assess/bookmarks/order update private story bookmark collection order for the current user

    Loading…

  • PATCH /assess/bookmarks/{bookmark_id} Rename a private story bookmark collection or make it the quick-save default

    Loading…

  • PATCH /assess/news-items/{item_id} partially modify the specified news item

    Loading…

  • PATCH /assess/stories/{story_id} update stories

    Loading…

  • PATCH /assess/story/{story_id} update story

    Loading…

  • POST /assess/analyst-review/actions apply one atomic analyst review decision

    Loading…

  • POST /assess/bookmarks create a private story bookmark collection

    Loading…

  • POST /assess/bookmarks/memberships Atomically add/remove private memberships, optionally create a collection, and choose a default.

    Loading…

  • POST /assess/bookmarks/quick-save Save stories to the user's explicit default collection, creating Bookmarks as the fallback.

    Loading…

  • POST /assess/bookmarks/{bookmark_id}/stories bookmark stories into a private collection

    Loading…

  • POST /assess/bookmarks/{bookmark_id}/stories/remove remove stories from a private bookmark collection without deleting stories

    Loading…

  • POST /assess/connectors handle connectors

    Loading…

  • POST /assess/import handle import

    Loading…

  • POST /assess/news-items add news item

    Loading…

  • POST /assess/news-items/fetch handle news items fetch

    Loading…

  • POST /assess/stories handle stories

    Loading…

  • POST /assess/stories/botactions queue a bot action for one or more stories or reports

    Loading…

  • POST /assess/stories/bulk_action Update selected stories in one transaction.

    Loading…

  • POST /assess/stories/group handle stories group

    Loading…

  • POST /assess/story/{connector_id}/share handle story share

    Loading…

  • POST /connectors/conflicts/clear clear conflicts

    Loading…

  • POST /connectors/conflicts/news-items handle conflicts news items

    Loading…

  • PUT /assess/news-items/ungroup update news items ungroup

    Loading…

  • PUT /assess/news-items/{item_id} modify the specified news item

    Loading…

  • PUT /assess/news-items/{item_id}/tags replace tags for the specified news item

    Loading…

  • PUT /assess/news-items/{news_item_id}/attributes update news items attributes

    Loading…

  • PUT /assess/stories/group Group News Items to an Story

    Loading…

  • PUT /assess/stories/ungroup Remove News Items from an story

    Loading…

  • PUT /assess/stories/{story_id} update stories

    Loading…

  • PUT /assess/stories/{story_id}/news-item-order Save local display order.

    Loading…

  • PUT /assess/story/{story_id} modify the specified story

    Loading…

  • PUT /connectors/conflicts/news-items update conflicts news items

    Loading…

  • PUT /connectors/conflicts/stories update conflicts stories

    Loading…

  • PUT /connectors/conflicts/stories/{story_id} update conflicts stories

    Loading…

Worker 33

  • GET /worker/bots Get all bots with effective parameters.

    Loading…

  • GET /worker/bots/{bot_id} Get bot configuration with effective parameters.

    Loading…

  • GET /worker/connectors/{connector_id} get connectors

    Loading…

  • GET /worker/cron-jobs get cron jobs

    Loading…

  • GET /worker/osint-sources get osint sources

    Loading…

  • GET /worker/osint-sources/{source_id} Get OSINT source by ID

    Loading…

  • GET /worker/presenters/{presenter} download presenter

    Loading…

  • GET /worker/products/{product_id} get products

    Loading…

  • GET /worker/products/{product_id}/render render product

    Loading…

  • GET /worker/publishers/{publisher} get publishers

    Loading…

  • GET /worker/report-items/{report_id} get report items

    Loading…

  • GET /worker/stories Get stories

    Loading…

  • GET /worker/tags Get all tags

    Loading…

  • GET /worker/word-list/{word_list_id} get word list

    Loading…

  • GET /worker/word-lists get word lists

    Loading…

  • POST /worker/bot-pipeline/stories Select the union of stories for a bot pipeline in one worker response

    Loading…

  • POST /worker/cron-jobs rebuild queue runtime state from PostgreSQL after Redis loses its data without clearing queued work

    Loading…

  • POST /worker/iocs get IOC enrichment rows for observable keys

    Loading…

  • POST /worker/misp/last-change handle misp last change

    Loading…

  • POST /worker/misp/stories handle misp stories

    Loading…

  • POST /worker/news-items handle news items

    Loading…

  • POST /worker/products/{product_id}/publish store a rendered product as a public Taranis report

    Loading…

  • POST /worker/stories create stories

    Loading…

  • POST /worker/tasks/changed invalidate scheduler and owner task views after RQ state changes

    Loading…

  • POST /worker/tasks/history/cleanup clean up persisted task history older than the configured retention window

    Loading…

  • PUT /worker/bots update bots

    Loading…

  • PUT /worker/bots/{bot_id} update bots

    Loading…

  • PUT /worker/misp/last-change update misp last change

    Loading…

  • PUT /worker/misp/stories update misp stories

    Loading…

  • PUT /worker/osint-sources/{source_id}/icon upload source icon

    Loading…

  • PUT /worker/post-collection-bots Run post-collection bots only for the supplied new or changed stories.

    Loading…

  • PUT /worker/word-list/{word_list_id} update word list

    Loading…

  • PUT /worker/word-lists update word lists

    Loading…

Analyze 28

  • DELETE /analyze/report-items delete report items

    Loading…

  • DELETE /analyze/report-items/{report_item_id} delete a specific report item

    Loading…

  • DELETE /analyze/report-items/{report_item_id}/lock unlock the specified field

    Loading…

  • DELETE /analyze/report/{report_item_id} delete report

    Loading…

  • DELETE /analyze/reports delete reports

    Loading…

  • GET /analyze/report-editors/{report_item_id} Read the report form with linked Story summaries.

    Loading…

  • GET /analyze/report-items get the report items

    Loading…

  • GET /analyze/report-items/{report_item_id} get a specific report item

    Loading…

  • GET /analyze/report-items/{report_item_id}/cti get CTI information for all IOC tags in stories attached to the report item

    Loading…

  • GET /analyze/report-items/{report_item_id}/locks get a report item's field locks

    Loading…

  • GET /analyze/report-items/{report_item_id}/revisions get report items revisions

    Loading…

  • GET /analyze/report-items/{report_item_id}/revisions/{revision_number} get report items revisions

    Loading…

  • GET /analyze/report-items/{report_item_id}/stories get report items stories

    Loading…

  • GET /analyze/report-types get the types of report items

    Loading…

  • GET /analyze/report/{report_item_id} get report

    Loading…

  • GET /analyze/reports get reports

    Loading…

  • POST /analyze/report-items add report item

    Loading…

  • POST /analyze/report-items/botactions queue a bot action for one or more report items

    Loading…

  • POST /analyze/report-items/publish-product Create a report and a product in a single request, then schedule an asynchronous render -> publish workflow for that product.

    Loading…

  • POST /analyze/report-items/{report_item_id}/clone clone the specified report item

    Loading…

  • POST /analyze/report-items/{report_item_id}/stories handle report items stories

    Loading…

  • POST /analyze/reports handle reports

    Loading…

  • PUT /analyze/report-items update report items

    Loading…

  • PUT /analyze/report-items/{report_item_id} modify a specific report item

    Loading…

  • PUT /analyze/report-items/{report_item_id}/lock lock the specified field

    Loading…

  • PUT /analyze/report-items/{report_item_id}/stories update report items stories

    Loading…

  • PUT /analyze/report/{report_item_id} update report

    Loading…

  • PUT /analyze/reports update reports

    Loading…

Assets 17

  • DELETE /asset-groups delete asset groups

    Loading…

  • DELETE /asset-groups/{group_id} delete an asset group

    Loading…

  • DELETE /assets delete assets

    Loading…

  • DELETE /assets/{asset_id} delete assets

    Loading…

  • GET /asset-groups get and add to the user's asset groups

    Loading…

  • GET /asset-groups/{group_id} get asset groups

    Loading…

  • GET /assets get assets

    Loading…

  • GET /assets/cti get CTI information for all readable assets

    Loading…

  • GET /assets/{asset_id} get assets

    Loading…

  • GET /assets/{asset_id}/cti get CTI information for readable vulnerability reports linked to the asset

    Loading…

  • POST /asset-groups add new asset to the user's asset groups

    Loading…

  • POST /assets handle assets

    Loading…

  • PUT /asset-groups update asset groups

    Loading…

  • PUT /asset-groups/{group_id} update an asset group

    Loading…

  • PUT /assets update assets

    Loading…

  • PUT /assets/{asset_id} update assets

    Loading…

  • PUT /assets/{asset_id}/vulnerabilities/{vulnerability_id} update vulnerabilities

    Loading…

Bots 17

  • GET /bots get bots

    Loading…

  • GET /bots/news-item/{news_item_id} get news item

    Loading…

  • GET /bots/story/{story_id} get story

    Loading…

  • GET /bots/story/{story_id}/attributes get story attributes

    Loading…

  • GET /bots/{bot_id} get bots

    Loading…

  • GET /worker/endpoint-health/{kind}/{endpoint_id} Returns current probe configuration with credentials, or skip for a disabled endpoint or obsolete check.

    Loading…

  • PATCH /bots/story/{story_id}/attributes update story attributes

    Loading…

  • POST /worker/endpoint-health/{kind}/{endpoint_id} Save a result only if its check ID and configuration still match the current endpoint check.

    Loading…

  • PUT /bots update bots

    Loading…

  • PUT /bots/news-item/{news_item_id} update news item

    Loading…

  • PUT /bots/news-item/{news_item_id}/attributes update news item attributes

    Loading…

  • PUT /bots/stories/group Group News Items to a Story

    Loading…

  • PUT /bots/stories/group-multiple update stories group multiple

    Loading…

  • PUT /bots/stories/ungroup update stories ungroup

    Loading…

  • PUT /bots/story/{story_id} update story

    Loading…

  • PUT /bots/{bot_id} update bots

    Loading…

  • PUT /worker/tags update tags keyed by news item id

    Loading…

Publish 15

  • DELETE /publish/products/{product_id} delete product

    Loading…

  • GET /publish/product-choices All ACL-visible Product choices ordered by title and ID.

    Loading…

  • GET /publish/product-metadata/{product_id} Product fields and compatible report metadata without fetching or returning the render.

    Loading…

  • GET /publish/product-type-choices ACL-visible Product Type IDs/titles, ordered by title/ID.

    Loading…

  • GET /publish/product-types get product types

    Loading…

  • GET /publish/products get products

    Loading…

  • GET /publish/products/auto-render/{report_item_id} auto render products

    Loading…

  • GET /publish/products/{product_id} get product details

    Loading…

  • GET /publish/products/{product_id}/render download a rendered product

    Loading…

  • GET /publish/publisher-presets get publisher presets available to publish users

    Loading…

  • GET /publish/publisher-presets/{preset_id} get a publisher preset available to publish users

    Loading…

  • POST /publish/products handle products

    Loading…

  • POST /publish/products/{product_id}/publishers/{publisher_id} Publish the current rendered product using a publisher.

    Loading…

  • POST /publish/products/{product_id}/render render a product

    Loading…

  • PUT /publish/products/{product_id} update product details

    Loading…

Dashboard 8

  • DELETE /dashboard/delete-tag/{tag_name} delete tag

    Loading…

  • GET /dashboard get dashboard data

    Loading…

  • GET /dashboard/build-info get build info

    Loading…

  • GET /dashboard/cluster-names get cluster names

    Loading…

  • GET /dashboard/cluster/{tag_type} get cluster

    Loading…

  • GET /dashboard/pizzint get the cached PizzINT DOUGHCON status

    Loading…

  • GET /dashboard/story-clusters get story clusters

    Loading…

Auth 5

  • DELETE /auth/logout invalidate API token (i.e. logout)

    Loading…

  • GET /auth/method get auth method

    Loading…

  • GET /auth/refresh refresh an access token for CLI and other non-browser clients

    Loading…

  • POST /auth/change_password handle change password

    Loading…

  • POST /auth/login authenticate with either username and password

    Loading…

Chat 5

  • DELETE /chat/conversations/{conversation_id} permanently delete an owned conversation and its messages

    Loading…

  • GET /chat/conversations list the current user's chat conversations

    Loading…

  • GET /chat/conversations/{conversation_id} reopen an owned chat conversation

    Loading…

  • POST /chat/conversations create a conversation after its first turn completes successfully; when realtime is enabled, progress is published to the authenticated user's Centrifugo channel using turn_id

    Loading…

  • POST /chat/conversations/{conversation_id}/messages complete and atomically persist a turn in an owned conversation; when realtime is enabled, progress is published to the authenticated user's Centrifugo channel using turn_id

    Loading…

Users 4

  • GET /users get the users details

    Loading…

  • GET /users/profile get the user's profile

    Loading…

  • POST /users/profile handle profile

    Loading…

  • PUT /users/profile update the user's profile

    Loading…

Realtime 3

  • GET /realtime/clients list connected realtime clients; requires ADMIN_OPERATIONS

    Loading…

  • POST /realtime/broadcast send a persistent notification to all connected users; requires ADMIN_OPERATIONS

    Loading…

  • POST /realtime/connect authenticate a Centrifugo connection using its dedicated proxy secret and the user's access cookie

    Loading…

Tasks 2

  • GET /tasks/runs List completed jobs and committed pipeline steps across users and background runs.

    Loading…

  • GET /tasks/user List queued, running, and completed tasks triggered by the authenticated user.

    Loading…

Health 1

  • GET /health see whether the Taranis instance dependencies are healthy

    Loading…

Isalive 1

  • GET /isalive see whether the Taranis instance is alive

    Loading…

Saved in this browser. Sign in to sync your tools.