...
Note: Ensure that all calls to the Compass API include a trailing slash in the endpoint URL.
...
Tokens
POST /login/
GET /tokens/
GET /tokens/<token>/
DELETE /tokens/<token>/
...
Projects
GET /projects/
POST /projects/
GET /projects/<project_id>/
PUT /projects/<project_id>/
DELETE /projects/<project_id>/
...
Documents
GET /projects/<project_id>/p/documents/
POST /projects/<project_id>/p/documents/
...
Classifiers
GET /projects/<project_id>/p/classifiers/
POST /projects/<project_id>/p/classifiers/
GET /projects/<project_id>/p/classifiers/<classifier_id>/
PUT /projects/<project_id>/p/classifiers/<classifier_id>/
DELETE /projects/<project_id>/p/classifiers/<classifier_id>/
POST /projects/<project_id>/p/classifiers/<classifier_id>/rebuild/
POST /projects/<project_id>/p/classifiers/<classifier_id>/test/
Domain Expansion for Sentiment Classifiers
Classifier Topics for topic-based classifier
POST /projects/<project_id>/p/classifiers/<classifier_id>/topics
PUT /projects/<project_id>/p/topics/<topic_id>
DELETE /projects/<project_id>/p/topics/<topic_id>
Topic Syntax
...
Classifiers/Chain
POST /projects/<project_id>/p/classifiers/chain
...
Classify
POST /projects/<project_id>/p/classify/
...
Project Topics
GET /projects/<project_id>/p/topics/
GET /projects/<project_id>/p/topics/<id>/
[DEPRECATED] GET /projects/<project_id>/p/topics/<id>/messages/
PUT /projects/<project_id>/p/topics/<id>/
DELETE /projects/<project_id>/p/topics/<id>/
...
[DEPRECATED] Historical Topics
[DEPRECATED] GET /projects/<project_id>/p/topics_history/
...
[DEPRECATED] Project Messages
[DEPRECATED] POST /projects/<project_id>/p/messages/
[DEPRECATED] GET /projects/<project_id>/p/messages/
[DEPRECATED] GET /projects/<project_id>/p/messages/<id>/
[DEPRECATED] DELETE /projects/<project_id>/p/messages/<id>/
...
[DEPRECATED] Project Statistics
[DEPRECATED] GET /projects/<project_id>/p/stats/
...
Project Message Usage
GET /projects/<project_id>/p/usage/
GET /projects/<project_id>/p/usage/<id>/
...
[DEPRECATED] Project Configuration
[DEPRECATED] GET /projects/<project_id>/p/config/
[DEPRECATED] GET /projects/<project_id>/p/config/<key>/
[DEPRECATED] PUT /projects/<project_id>/p/config/<key>/
[DEPRECATED] DELETE /projects/<project_id>/p/config/<key>/
...
Accounts
GET /accounts/
POST /accounts/
GET /accounts/<account_id>/
PUT /accounts/<account_id>/
DELETE /accounts/<account_id>/
...
Users
GET /users/
POST /users/
GET /users/<email>/
PUT /users/<email>/
DELETE /users/<email>/
PUT /users/<email>/password/
POST /users/<email>/password/reset/
Permissions
...
GET /permissions/
...
POST /permissions/
...
GET /permissions/<permission_id>/
...
| Table of Contents |
|---|
To make API requests, the endpoints listed here should be prefixed with "https://<compass-url.tld>/api"
...