Polarity REST API Reference

The Polarity API, version 5.7.3, provides a comprehensive set of endpoints for managing various aspects of the Polarity platform, including user interactions, server settings, and integrations. To access these resources, authentication is required using a bearer token obtained from the authentication endpoint. Responses are typically in JSON format, with support for both application/json and application/vnd.api+json. This API is designed for developers looking to integrate Polarity features into their applications or manage server configurations directly. The reference documentation is organized by resource group, making it easy to find the specific endpoints needed; a full schema reference can be found at the end of this document.

This page is generated from the Polarity OpenAPI specification (https://{POLARITY_SERVER}/api/openapi).
Do not edit it directly in Document360 — changes are overwritten on the next publish.
Regenerate with the apidocs tool.

Authentication

• authorization — http, scheme bearer, format JWT

  JWT Authorization header using the Bearer scheme. Example: Authorization: Bearer {token}

Contents

Authentication & Access

• Authentication — User authentication (2 operations)
• Socket Authentication — This endpoint allows developers to obtain a WebSocket authentication token necessary for establishing secure and authenticated connections (1 operation)
• API Keys — API key management (7 operations)

Users & Groups

• Users — User management (16 operations)
• User Stats — User statistics (2 operations)
• Groups — User notifications (10 operations)

Channels & Conversations

• Channels — Channels (15 operations)
• Channel Subscriptions — Channel subscriptions (5 operations)
• Channel Write Subscriptions — Channel write subscriptions (4 operations)
• Conversations — Conversations (7 operations)

Annotations & Intelligence

• Annotations — Annotations (9 operations)
• Comments — Comments on annotations (5 operations)
• Votes — Votes for annotations (3 operations)
• Tags — Annotation tags (4 operations)
• Entities — Entities (3 operations)
• Parsed Entities — Accessing the entity parsing service (1 operation)
• Searchable Items — Searchable items (1 operation)

Integrations

• Integrations — Integrations (33 operations)
• Dataminr — Dataminr alert ingestion and processing (2 operations)

Server & Administration

• Server — Server management (1 operation)
• Server Settings — Server settings (7 operations)
• Feature Flags — Feature flags (2 operations)
• Colors — Color configurations (2 operations)
• AI Metrics — This endpoint allows developers to retrieve a list of AI performance metrics associated with a specific user (1 operation)
• Audit Logs — This endpoint allows developers to record new audit logs, capturing important events for tracking and review (1 operation)
• Health — Health check endpoints for the server (3 operations)
• HUD URLs — HUD URLs (5 operations)

Authentication & Access

Authentication

Endpoints related to user authentication

This resource group allows developers to manage and retrieve different authentication schemes, enabling secure user login and access control.

GET /api/authentication-schemes — List all authentication schemes

operationId: PolarityWeb.AuthenticationController.index

List all authentication schemes

Responses

GET /api/authentication-schemes/{id} — Get an authentication scheme by ID

operationId: PolarityWeb.AuthenticationController.show

Get an authentication scheme by ID

Parameters

Responses

↑ Back to top

Socket Authentication

This endpoint allows developers to obtain a WebSocket authentication token necessary for establishing secure and authenticated connections.

POST /api/socket-token — Create WebSocket authentication token

operationId: PolarityWeb.SocketController.create_token

Generates a short-lived Phoenix token (5 minutes) for WebSocket authentication. Requires valid JWT or API token authentication.

Responses

↑ Back to top

API Keys

Endpoints related to API key management

This resource group allows developers to manage API keys, including creating, updating, retrieving, and deleting keys, as well as generating auth tokens.

GET /api/api-keys — List API keys

operationId: PolarityWeb.ApiKeyController.index

Lists all API keys.

Parameters

Responses

POST /api/api-keys — Create an API key

operationId: PolarityWeb.ApiKeyController.create

Creates a new API key for the authenticated user.

Request body

Create API Key Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "enabled": false,
      "expiration-time": "",
      "name": ""
    },
    "type": ""
  }
}

Responses

POST /api/api-keys/auth — Create an auth token

operationId: PolarityWeb.ApiKeyController.create_auth_token

Creates a new auth token for the authenticated user.

Responses

GET /api/api-keys/me — Get info about current API key

operationId: PolarityWeb.ApiKeyController.me

This endpoint only accepts request from API type tokens, and returns the metadata of the API key.

Responses

DELETE /api/api-keys/{id} — Delete an API key

operationId: PolarityWeb.ApiKeyController.delete

Deletes an API key.

Parameters

Responses

GET /api/api-keys/{id} — Get an API key

operationId: PolarityWeb.ApiKeyController.show

Gets a single API key by its ID.

Parameters

Responses

PATCH /api/api-keys/{id} — Update an API key

operationId: PolarityWeb.ApiKeyController.update

Updates an API key.

Parameters

Request body

Update API Key Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "name": ""
    },
    "type": ""
  }
}

Responses

↑ Back to top

Users & Groups

Users

Endpoints related to user management

This resource group allows developers to manage users, including authentication, creating and updating user profiles, resetting passwords, and managing user sessions.

GET /api/auth — Authentication Info

operationId: PolarityWeb.UserController.auth

Get the current user and JWT

Responses

POST /api/user-clone — Clone user

operationId: PolarityWeb.UserController.clone

Create a new user using an existing user as a template.

Parameters

Request body

Create User Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "source-user": "",
      "target-user": ""
    },
    "type": ""
  }
}

Responses

GET /api/users — List users

operationId: PolarityWeb.UserController.index

List polarity users

Parameters

Responses

POST /api/users — Create user

operationId: PolarityWeb.UserController.create

Create a new user

Parameters

Request body

Create User Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "clone-user": "",
      "email": "",
      "enabled": false,
      "force-password-reset": false,
      "full-name": "",
      "is-admin": false,
      "is-local": false,
      "password": "",
      "username": ""
    },
    "relationships": {
      "groups": {
        "data": [
          {
            "id": 0,
            "type": ""
          }
        ]
      }
    },
    "type": ""
  }
}

Responses

POST /api/users/forgot-password — Forgot password

operationId: PolarityWeb.UserController.forgot_password

Send a password reset email to the user.

Request body

Create User Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "identification": ""
    },
    "type": ""
  }
}

Responses

POST /api/users/login — Login

operationId: PolarityWeb.UserController.login

Login user with username and password, returning a JWT in addition to user information.

Request body

Create User Request

Content type: application/vnd.api+json

Example request:

{
  "identification": "",
  "password": "",
  "token": ""
}

Responses

POST /api/users/logout — Logout

operationId: PolarityWeb.UserController.logout

Logout the authenticated user, revoking their JWT

Responses

POST /api/users/logout-all-sessions — Logout all sessions

operationId: PolarityWeb.UserController.logout_all_sessions

Logout user from all devices by revoking all session tokens and API keys owned by the user

Responses

GET /api/users/refresh — Refresh token

operationId: PolarityWeb.UserController.refresh_token

Refresh the user's JWT

Responses

POST /api/users/reset-password/{token} — Reset password

operationId: PolarityWeb.UserController.reset_password

Reset the password for a user.

Parameters

Request body

Reset Password Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "password": ""
    },
    "type": ""
  }
}

Responses

GET /api/users/sessions — List active sessions

operationId: PolarityWeb.UserController.list_sessions

List all active sessions for the authenticated user

Responses

GET /api/users/{id} — Show user

operationId: PolarityWeb.UserController.show

Find a user by ID

Parameters

Responses

PATCH /api/users/{id} — Update user

operationId: PolarityWeb.UserController.update

Update an existing user

Parameters

Request body

Create User Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "email": "",
      "enabled": false,
      "first-time-user": false,
      "force-password-reset": false,
      "full-name": "",
      "is-admin": false,
      "is-local": false,
      "settings": {
        "annotations": {
          "split-entities-newline": false
        },
        "channels": {},
        "conversations": {},
        "emails": {
          "notified-inactive": false,
          "send-channel-notification": false,
          "send-comment-notification": false,
          "send-integration-notification": false,
          "send-upvote-notification": false
        },
        "onboarding": {
          "annotation-tour-complete": false,
          "viewed-apply-tags": false,
          "viewed-welcome": false
        },
        "startup": {
          "default-recognition-mode-set": false
        },
        "usertips": {
          "channels": {
            "create-channel": false,
            "subscribe": false
          },
          "integrations": {
            "options": false,
            "subscribe": false
          },
          "notifications": {
            "all-settings": false,
            "buttons": false,
            "on-demand-search-shortcut": false,
            "search-bar": false,
            "settings": false
          }
        }
      },
      "username": ""
    },
    "type": ""
  }
}

Responses

GET /api/users/{id}/group-history — Get Group Membership History for User

operationId: PolarityWeb.UserController.group_history

Retrieves all group membership changes for a specific user

Parameters

Responses

POST /api/users/{id}/password — Change password

operationId: PolarityWeb.UserController.change_password

Change password for logged in user, or any user if the requestor is an admin.

Parameters

Request body

Create User Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "current_password": "",
      "new_password": ""
    },
    "type": ""
  }
}

Responses

GET /api/users/{id}/permissions — List permissions for user

operationId: PolarityWeb.UserController.list_permissions

List the permissions for the provided user

Parameters

Responses

↑ Back to top

User Stats

Endpoints related to user statistics

This resource group allows developers to retrieve statistical information about users, including both an overview of all user stats and detailed stats for a specific user.

GET /api/user-stats — Index User Stats

operationId: PolarityWeb.UserStatsController.index

Index User Stats

Parameters

Responses

GET /api/user-stats/{id} — Show User Stats

operationId: PolarityWeb.UserStatsController.show

Show User Stats

Parameters

Responses

↑ Back to top

Groups

Endpoints related to user notifications

This resource group allows developers to manage user groups, including creating, updating, and deleting groups, as well as adding or removing members. Notifications related to these actions can be retrieved using the provided endpoints.

GET /api/groups — List Groups

operationId: PolarityWeb.GroupController.index

List Groups

Parameters

Responses

POST /api/groups — Create Group

operationId: PolarityWeb.GroupController.create

Create Group

Request body

Create Group Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "description": "",
      "group-name": "",
      "is-user": false,
      "user-count": 0
    },
    "type": ""
  }
}

Responses

DELETE /api/groups/{id} — Delete Group

operationId: PolarityWeb.GroupController.delete

Delete Group

Parameters

Responses

GET /api/groups/{id} — Get Group by ID

operationId: PolarityWeb.GroupController.show

Get Group by ID

Parameters

Responses

PATCH /api/groups/{id} — Update Group

operationId: PolarityWeb.GroupController.update_2

Update Group

Parameters

Request body

Update Group Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "description": "",
      "group-name": ""
    },
    "type": ""
  }
}

Responses

PUT /api/groups/{id} — Update Group

operationId: PolarityWeb.GroupController.update

Update Group

Parameters

Request body

Update Group Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "description": "",
      "group-name": ""
    },
    "type": ""
  }
}

Responses

GET /api/groups/{id}/members — List Group Members

operationId: PolarityWeb.GroupController.list_members

List Group Members

Parameters

Responses

GET /api/groups/{id}/membership-history — Get Membership History for Group

operationId: PolarityWeb.GroupController.membership_history

Retrieves the membership change history for a specific group

Parameters

Responses

DELETE /api/groups/{id}/relationships/members — Remove Members from Group

operationId: PolarityWeb.GroupController.remove_members

Remove Members from Group

Parameters

Request body

Remove Members Request

Content type: application/vnd.api+json

Example request:

{
  "data": [
    {
      "id": 0,
      "type": ""
    }
  ]
}

Responses

POST /api/groups/{id}/relationships/members — Add Members to Group

operationId: PolarityWeb.GroupController.add_members

Add Members to Group

Parameters

Request body

Add Members Request

Content type: application/vnd.api+json

Example request:

{
  "data": [
    {
      "id": 0,
      "type": ""
    }
  ]
}

Responses

↑ Back to top

Channels & Conversations

Channels

Endpoints related to channels

This resource group allows developers to manage channels, including listing, creating, updating, and deleting channels, as well as managing permissions associated with them.

GET /api/channel-filter-downloads — List all filter downloads

operationId: PolarityWeb.ChannelController.list_filter_downloads

List all filter downloads

Responses

GET /api/channel-filter-downloads/{id} — Show filter download

operationId: PolarityWeb.ChannelController.show_filter_download

Show filter download given a channel ID

Parameters

Responses

GET /api/channel-filter-words — List all filter words

operationId: PolarityWeb.ChannelController.list_filter_words

List all filter words

Parameters

Responses

GET /api/channel-filter-words/{id} — Show filter words

operationId: PolarityWeb.ChannelController.show_filter_words

Show filter words given a channel ID

Parameters

Responses

GET /api/channel-filters — List all filters

operationId: PolarityWeb.ChannelController.list_filters

List all filters

Responses

GET /api/channel-filters/{id} — Show a filter

operationId: PolarityWeb.ChannelController.show_filter

Show a filter by ID

Parameters

Responses

GET /api/channels — List all channels

operationId: PolarityWeb.ChannelController.index

List all channels

Parameters

Responses

POST /api/channels — Create a channel

operationId: PolarityWeb.ChannelController.create

Create a channel

Request body

Channel Create Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "channel-name": "",
      "default-color": "",
      "default-color-is-locked": false,
      "description": "",
      "groups": [
        {
          "id": 0,
          "permissions": [
            ""
          ]
        }
      ]
    },
    "type": ""
  }
}

Responses

DELETE /api/channels/{id} — Delete a channel

operationId: PolarityWeb.ChannelController.delete

Delete a channel

Parameters

Responses

GET /api/channels/{id} — Show a channel

operationId: PolarityWeb.ChannelController.show

Show a channel by ID

Parameters

Responses

PATCH /api/channels/{id} — Update a channel

operationId: PolarityWeb.ChannelController.update_2

Update a channel

Parameters

Request body

Channel Update Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "channel-name": "",
      "default-color": "",
      "default-color-is-locked": false,
      "description": "",
      "pending-deletion": false
    },
    "type": ""
  }
}

Responses

PUT /api/channels/{id} — Update a channel

operationId: PolarityWeb.ChannelController.update

Update a channel

Parameters

Request body

Channel Update Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "channel-name": "",
      "default-color": "",
      "default-color-is-locked": false,
      "description": "",
      "pending-deletion": false
    },
    "type": ""
  }
}

Responses

GET /api/channels/{id}/permissions — List permissions for a channel

operationId: PolarityWeb.ChannelController.list_permissions

List permissions for a channel

Parameters

Responses

POST /api/channels/{id}/permissions — Add permissions to a channel

operationId: PolarityWeb.ChannelController.add_permissions

Add permissions to a channel

Parameters

Request body

Channel Permissions Request

Content type: application/vnd.api+json

Example request:

{
  "data": [
    {
      "attributes": {
        "permissions": [
          ""
        ]
      },
      "relationships": {
        "channel": {
          "data": {
            "id": 0,
            "type": ""
          }
        },
        "group": {
          "data": {
            "id": 0,
            "type": ""
          }
        }
      },
      "type": ""
    }
  ]
}

Responses

DELETE /api/channels/{id}/relationships/permissions — Remove permissions from a channel

operationId: PolarityWeb.ChannelController.remove_permissions

Remove permissions from a channel

Parameters

Request body

Channel Permissions Request

Content type: application/vnd.api+json

Example request:

{
  "data": [
    {
      "id": "",
      "type": ""
    }
  ]
}

Responses

↑ Back to top

Channel Subscriptions

Endpoints related to channel subscriptions

This group of endpoints allows developers to manage channel subscriptions, enabling them to list existing subscriptions, create new ones, and delete existing subscriptions.

GET /api/channel-subscriptions — List Channel Subscriptions

operationId: PolarityWeb.ChannelSubscriptionController.index

List Channel Subscriptions

Parameters

Responses

POST /api/channel-subscriptions — Create a Channel Subscription

operationId: PolarityWeb.ChannelSubscriptionController.create

Create a Channel Subscription, allowing a user to subscribe others to a channel

Request body

Channel Subscription Create Request

Content type: application/vnd.api+json

Example request:

{
  "data": [
    {
      "relationships": {
        "channel": {
          "data": {
            "id": 0,
            "type": ""
          }
        },
        "user": {
          "data": {
            "id": 0,
            "type": ""
          }
        }
      },
      "type": ""
    }
  ],
  "meta": {
    "channel-id": 0,
    "subscribe-all": false
  }
}

Responses

DELETE /api/channel-subscriptions/{id} — Delete a Channel Subscription

operationId: PolarityWeb.ChannelSubscriptionController.delete

Delete a Channel Subscription

Parameters

Responses

GET /api/channel-subscriptions/{id} — Show a Channel Subscription (Placeholder)

operationId: PolarityWeb.ChannelSubscriptionController.show

This route is just a placeholder to enable the path helper methods for this controller.

Parameters

Responses

PATCH /api/channel-subscriptions/{id} — Update a Channel Subscription

operationId: PolarityWeb.ChannelSubscriptionController.update

Update a Channel Subscription

Parameters

Request body

Channel Subscription Update Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "show-notifications": false
    },
    "type": ""
  }
}

Responses

↑ Back to top

Channel Write Subscriptions

Endpoints related to channel write subscriptions

This resource group allows developers to manage channel write subscriptions, including listing existing subscriptions, creating new ones, and deleting specific subscriptions.

GET /api/channel-write-subscriptions — List Channel Write Subscriptions

operationId: PolarityWeb.ChannelWriteSubscriptionsController.index

List Channel Write Subscriptions

Parameters

Responses

POST /api/channel-write-subscriptions — Create Channel Write Subscription

operationId: PolarityWeb.ChannelWriteSubscriptionsController.create

Create Channel Write Subscription

Request body

Channel Write Subscription Create Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "relationships": {
      "channel": {
        "data": {
          "id": 0,
          "type": ""
        }
      }
    },
    "type": ""
  }
}

Responses

DELETE /api/channel-write-subscriptions/{id} — Delete Channel Write Subscription

operationId: PolarityWeb.ChannelWriteSubscriptionsController.delete

Delete Channel Write Subscription

Parameters

Responses

GET /api/channel-write-subscriptions/{id} — Show a Channel Write Subscription (Placeholder)

operationId: PolarityWeb.ChannelWriteSubscriptionsController.show

This route is just a placeholder to enable the path helper methods for this controller.

Parameters

Responses

↑ Back to top

Conversations

Endpoints related to conversations

This resource group allows developers to manage and interact with chat conversations, including creating new conversations, listing available chat providers, summarizing conversation history, and reducing integration data.

POST /api/conversations/chat — Create a conversation

operationId: createConversation

Submit messages to the AI conversation system and get a response. Optionally include notification context for AI tools.

Request body

Conversation Request

Content type: application/vnd.api+json

Responses

GET /api/conversations/providers — List Available Chat Providers

operationId: listChatProviders

Returns a list of available chat providers

Responses

GET /api/conversations/providers/{provider_name} — List Models for Provider

operationId: listProviderModels

Returns a list of available models for a specific chat provider

Parameters

Responses

POST /api/conversations/summarize-history — Summarize conversation history

operationId: summarizeConversationHistory

Accepts conversation history and returns a condensed summary for token reduction

Request body

Summarize History Request

Content type: application/vnd.api+json

Responses

POST /api/integrations/{id}/reducer/{name} — Reduce Integration Data

operationId: reduceIntegrationData

Apply a specified reducer to data for a given integration

Parameters

Request body (required)

Data to be reduced by the specified reducer

Content type: application/vnd.api+json

Responses

GET /api/model-settings/{id} — Get Model Settings

operationId: getModelSettings

Retrieve the current settings for the text model used in conversations

Parameters

Responses

PATCH /api/model-settings/{id} — Update Model Settings

operationId: updateModelSettings

Update the settings for the text model used in conversations

Parameters

Responses

↑ Back to top

Annotations & Intelligence

Annotations

Endpoints related to annotations

This group of endpoints allows developers to manage and interact with annotations, including creating, updating, deleting, and retrieving annotation entities, as well as listing and viewing related comments.

POST /api/lookups — Lookup entities

operationId: PolarityWeb.TagEntityController.lookup_entity

Lookup entities to see if there are any annotation matches for the given entities.

Parameters

Request body

Integration Options Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "ip-entities": [
        ""
      ],
      "string-entities": [
        ""
      ]
    },
    "type": ""
  }
}

Responses

DELETE /api/tag-entity-pairs — Destory tag entities

operationId: PolarityWeb.TagEntityController.destroy

Destory tag entities given a specific user ID

Parameters

Responses

GET /api/tag-entity-pairs — List tag entities

operationId: PolarityWeb.TagEntityController.index

List tag entities

Parameters

Responses

POST /api/tag-entity-pairs — Create tag entity

operationId: PolarityWeb.TagEntityController.create

Create a tag entity pair for annotation

Request body

Create Tag Entity Request

Content type: application/vnd.api+json

Example request:

{
  "data": [
    {
      "attributes": {
        "channel-id": [
          0
        ],
        "comment": "",
        "confidence": 0,
        "doi-end": "",
        "doi-start": "",
        "entity": "",
        "entity_name_ip": "",
        "tag": "",
        "type": "ip"
      },
      "type": ""
    }
  ]
}

Responses

DELETE /api/tag-entity-pairs/{id} — Delete tag entity

operationId: PolarityWeb.TagEntityController.delete

Delete a specific tag entity pair

Parameters

Responses

GET /api/tag-entity-pairs/{id} — Show tag entity

operationId: PolarityWeb.TagEntityController.show

Show a specific tag entity

Parameters

Responses

PATCH /api/tag-entity-pairs/{id} — Update tag entity

operationId: PolarityWeb.TagEntityController.update_2

Update a specific tag entity pair

Parameters

Request body

Update Tag Entity Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "confidence": 0,
      "doi-end": "",
      "doi-start": ""
    },
    "type": ""
  }
}

Responses

PUT /api/tag-entity-pairs/{id} — Update tag entity

operationId: PolarityWeb.TagEntityController.update

Update a specific tag entity pair

Parameters

Request body

Update Tag Entity Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "confidence": 0,
      "doi-end": "",
      "doi-start": ""
    },
    "type": ""
  }
}

Responses

GET /api/tag-entity-pairs/{id}/relationships/comments — List comments

operationId: PolarityWeb.TagEntityController.list_comments

List comments for a specific tag entity pair

Parameters

Responses

↑ Back to top

Comments

Endpoints related to comments on annotations

This resource group allows developers to manage comments associated with annotations, enabling them to create, delete, show, and update comment entries.

POST /api/comments — Create Comment

operationId: PolarityWeb.CommentController.create

Create Comment

Request body

Create Comment Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "note": ""
    },
    "relationships": {
      "tag-entity-pair": {
        "data": {
          "id": 0,
          "type": ""
        }
      }
    },
    "type": ""
  }
}

Responses

DELETE /api/comments/{id} — Delete Comment

operationId: PolarityWeb.CommentController.delete

Delete Comment

Parameters

Responses

GET /api/comments/{id} — Show Comment (Placeholder)

operationId: PolarityWeb.CommentController.show

There is no show action for comments on the legacy controller.

Parameters

Responses

PATCH /api/comments/{id} — Update Comment

operationId: PolarityWeb.CommentController.update_2

Update Comment

Parameters

Request body

Update Comment Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "note": ""
    },
    "type": ""
  }
}

Responses

PUT /api/comments/{id} — Update Comment

operationId: PolarityWeb.CommentController.update

Update Comment

Parameters

Request body

Update Comment Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "note": ""
    },
    "type": ""
  }
}

Responses

↑ Back to top

Votes

Endpoints related to votes for annotations

This resource group allows developers to manage votes on annotations, enabling them to retrieve and cast votes.

GET /api/votes — Index Votes

operationId: PolarityWeb.VotesController.index

Index Votes

Parameters

Responses

POST /api/votes — Create Vote

operationId: PolarityWeb.VotesController.create

Create Vote

Request body

Create Vote Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "vote": 0
    },
    "relationships": {
      "tag-entity-pair": {
        "data": {
          "id": 0,
          "type": ""
        }
      }
    },
    "type": ""
  }
}

Responses

GET /api/votes/{id} — Show Vote (Placeholder)

operationId: PolarityWeb.VotesController.show

Placeholder for Show Vote since the action is not implemented.

Parameters

Responses

↑ Back to top

Tags

Endpoints related to annotation tags

This resource group allows developers to manage annotation tags, enabling them to list existing tags, create new ones, retrieve details of a specific tag, and delete unused tags.

GET /api/tags — List Tags

operationId: PolarityWeb.TagController.index

List Tags

Parameters

Responses

POST /api/tags — Create Tag

operationId: PolarityWeb.TagController.create

Create Tag

Request body

Create Tag Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "tag-name": ""
    },
    "relationships": {
      "tag-entity-pairs": {
        "data": [
          {
            "id": 0,
            "type": ""
          }
        ]
      }
    },
    "type": ""
  }
}

Responses

DELETE /api/tags/{id} — Delete Tag

operationId: PolarityWeb.TagController.delete

Delete Tag

Parameters

Responses

GET /api/tags/{id} — Show Tag

operationId: PolarityWeb.TagController.show

Show Tag

Parameters

Responses

↑ Back to top

Entities

Endpoints related to entities

This resource group allows developers to manage and retrieve information about entities, including listing all entities, viewing specific entity details, and listing user views associated with an entity.

GET /api/entities — List Entities

operationId: PolarityWeb.EntityController.index

List Entities

Parameters

Responses

GET /api/entities/{id} — Show Entity

operationId: PolarityWeb.EntityController.show

Show Entity

Parameters

Responses

GET /api/entities/{id}/relationships/user-views — List User Views

operationId: PolarityWeb.EntityController.list_user_views

List User Views

Parameters

Responses

↑ Back to top

Parsed Entities

Endpoints for accessing the entity parsing service

This endpoint allows developers to submit text for entity parsing, receiving structured data about identified entities within the text.

POST /api/parsed-entities — Parse entities

operationId: PolarityWeb.ParsedEntityController.create

Send text to be parsed for entities and annotations, to be passed to the integrations with a request to integration-lookups/{{integration-ID}}

Request body

Parsed Entities Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "text": ""
    },
    "type": ""
  }
}

Responses

↑ Back to top

Searchable Items

Endpoints related to searchable items

This endpoint allows developers to retrieve a list of searchable items, enabling efficient querying and filtering of relevant data.

GET /api/searchable-items — List Searchable Items

operationId: PolarityWeb.SearchableItemsController.index

List Searchable Items

Parameters

Responses

↑ Back to top

Integrations

Integrations

Endpoints related to integrations

This group of endpoints allows developers to manage and interact with various integrations, including listing, updating, installing, and controlling their lifecycle. Developers can also customize and configure integration types, handle errors, and manage permissions associated with these integrations.

GET /api/integration-options — List options

operationId: PolarityWeb.IntegrationController.list_options

List all integration options

Parameters

Responses

PATCH /api/integration-options — Update options

operationId: PolarityWeb.IntegrationController.update_options

Update options for a given integration

Request body

Integration Options Request

Content type: application/vnd.api+json

Example request:

{
  "data": [
    {
      "attributes": {
        "admin-only": false,
        "user-can-edit": false,
        "value": null
      },
      "id": "",
      "type": ""
    }
  ]
}

Responses

GET /api/integration-options/{id} — Show options

operationId: PolarityWeb.IntegrationController.show_options

Show options for a given integration

Parameters

Responses

GET /api/integration-templates/{id} — Get integration templates

operationId: PolarityWeb.IntegrationController.templates

Get integration templates by ID

Parameters

Responses

GET /api/integration-types — List integration types

operationId: PolarityWeb.IntegrationController.index_integration_types

List integration types for a user

Parameters

Responses

DELETE /api/integration-types/{id} — Delete an integration type

operationId: PolarityWeb.IntegrationController.delete_type

Delete an integration custom type from the database. ID supplied here is the type ID, which is a composite key of the integration ID and the type key. {integration_id}-{type.key}

Parameters

Responses

GET /api/integration-types/{id} — Show integration types

operationId: PolarityWeb.IntegrationController.show_integration_types

Show integration types for a specific integration. ID is the type ID i.e. {integration_id}-{type.key}.

Parameters

Responses

PATCH /api/integration-types/{id} — Update an integration type

operationId: PolarityWeb.IntegrationController.update_type

Update a type for the integration in the database. ID supplied here is the type ID, which is a composite key of the integration ID and the type key, i.e. {integration_id}-{type.key}.

Parameters

Request body

Integration Type Update Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "description": "",
      "enabled": false,
      "is-case-sensitive": false,
      "is-global": false,
      "name": "",
      "regex": "",
      "white-list": [
        ""
      ]
    },
    "type": ""
  }
}

Responses

POST /api/integration-types/{id} — Create an integration custom type

operationId: PolarityWeb.IntegrationController.create_type

Create a custom type for an integration in the database. ID supplied here is the integration ID.

Parameters

Request body

Integration Type Create Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "description": "",
      "is-case-sensitive": false,
      "is-global": false,
      "key": "",
      "name": "",
      "regex": "",
      "type": "",
      "white-list": [
        ""
      ]
    },
    "type": ""
  }
}

Responses

GET /api/integrations — List integrations

operationId: PolarityWeb.IntegrationController.index

List integrations for a user

Parameters

Responses

POST /api/integrations-upload — Upload an integration

operationId: PolarityWeb.IntegrationController.upload

Upload an integration to polarity

Request body

Integration Installation Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "metadata": {}
  },
  "integration": {
    "content_type": "",
    "filename": "",
    "path": ""
  }
}

Responses

POST /api/integrations-upload/{id} — Update an integration

operationId: PolarityWeb.IntegrationController.update_upload

Update an integration with new version

Parameters

Request body

Integration Update Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "metadata": {}
  },
  "integration": {
    "content_type": "",
    "filename": "",
    "path": ""
  }
}

Responses

GET /api/integrations/errors — Index integration errors

operationId: PolarityWeb.IntegrationController.index_all_errors

Index all integration errors

Parameters

Responses

POST /api/integrations/install — Install an integration

operationId: PolarityWeb.IntegrationController.install

Install an integration to polarity

Request body

Integration Installation Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "metadata": {},
      "name": "",
      "url": "",
      "uuid": ""
    },
    "type": ""
  }
}

Responses

DELETE /api/integrations/{id} — Delete an integration

operationId: PolarityWeb.IntegrationController.delete_integration

Delete an integration by ID

Parameters

Responses

GET /api/integrations/{id} — Show an integration

operationId: PolarityWeb.IntegrationController.show

Show an integration by ID

Parameters

Responses

PATCH /api/integrations/{id} — Update an integration

operationId: PolarityWeb.IntegrationController.update

Update the entry setting for the integration in the database.

Parameters

Request body

Integration Update Request

Content type: application/vnd.api+json

Example request:

{
  "data": {
    "attributes": {
      "acronym": "",
      "auto-restart-enabled": false,
      "auto-restart-max-wait-time": 0,
      "auto-restart-min-wait-time": 0,
      "auto-restart-reset-after-up-time": 0,
      "auto-restart-total-starts": 0,
      "autosubscribe": false,
      "cache-compression-enabled": false,
      "cache-is-enabled": false,
      "cache-is-per-user": false,
      "cache-lookup-misses": false,
      "cache-miss-ttl": 0,
      "cache-status": "",
      "cache-ttl": 0,
      "default-color": "",
      "default-color-is-locked": false,
      "description": "",
      "name": "",
      "proxy-settings": {
        "enabled": false,
        "host": "",
        "password": "",
        "port": 0,
        "scheme": "http",
        "user": ""
      },
      "run-on-server-start": false,
      "tls-allow-unauthorized": false,
      "user-settings": {
        "subscribed": false,
        "user-color": ""
      }
    },
    "type": ""
  }
}

Responses

GET /api/integrations/{id}/assets/*file_path — Fetches an integration file

operationId: PolarityWeb.IntegrationController.serve_asset_file