Endpoint:
https://api.semstorm.com/api-v3/content-assistant/article/create [POST]

Description:
Creates new article.

Error:
User do not have permission to access Content Assistant.

Curl:

curl -X POST -d '{ "title": "My new article", "content": "<p>Some text...", "services_token": __ACCESS_TOKEN__ }' https://api.semstorm.com/api-v3/content-assistant/article/create.json

Output:

{ "id": __ID__ }

Endpoint:
https://api.semstorm.com/api-v3/content-assistant/article/retrieve [POST]

Description:
Get article data.

Error:
User do not have permission to access Content Assistant.

Curl:

curl -X POST -d '{ "id": __ID__, "additional_data": ["keywords", "share_url"], "services_token": __ACCESS_TOKEN__ }' https://api.semstorm.com/api-v3/content-assistant/article/retrieve.json

Output:

{"results": { "id": __ID__, "title": "(...)", "language": "(...)", "content": "(...)" (...)}}

Endpoint:
https://api.semstorm.com/api-v3/content-assistant/article/update [POST]

Description:
Change article data.

Error:
User do not have permission to access Content Assistant.
User do not have editor access to given article.

Curl:

curl -X POST -d '{ "id": __ID__, "title": "new title", "content": "Updated content about something else", (...) }' https://api.semstorm.com/api-v3/content-assistant/article/update.json

Output:

{ results: { "id": __ID__ } }

Endpoint:
https://api.semstorm.com/api-v3/content-assistant/article/delete [POST]

Description:
Change article state to "deleted", so it is moved to trash. After 30 days without any activity it will be deleted permanently.

Error:
User do not have permission to access Content Assistant.
User do not have editor access to given article.

Curl:

curl -X POST -d '{ "id": __ID__, "services_token": __ACCESS_TOKEN__ }' https://api.semstorm.com/api-v3/content-assistant/article/delete.json

Output:

{ results: { "id": __ID__ } }

Endpoint:
https://api.semstorm.com/api-v3/content-assistant/article/get-list [POST]

Description:
Get articles list.

Error:
User do not have permission to access Content Assistant.

Curl:

curl -X POST -d '{ "pager": { "items_per_page":10, "page":1 }, "services_token": __ACCESS_TOKEN__ }' https://api.semstorm.com/api-v3/content-assistant/article/get-list.json

Output:

{ "articles"[ (...) ], "count":27 }

Endpoint:
https://api.semstorm.com/api-v3/content-assistant/primary-keywords/create [POST]

Description:
Creates primary keywords for given article.

Error:
User do not have permission to access Content Assistant.
User do not have editor access to given article.

Curl:

curl -X POST -d '{ "title": "My new article", "content": "<p>Some text...", "services_token": __ACCESS_TOKEN__ }' https://api.semstorm.com/api-v3/content-assistant/article/create.json

Output:

{ "keywords_ids": [(...)] }

Endpoint:
https://api.semstorm.com/api-v3/content-assistant/primary-keywords/retrieve [POST]

Description:
Get primary keywords data.

Error:
User do not have permission to access Content Assistant.
User do not have editor access to given article.

Curl:

curl -X POST -d '{article_id: __ARTICLE_ID__, "keywords_ids": [__KEYWORDS_ID_1__, (...)], "services_token": __ACCESS_TOKEN__ }' https://api.semstorm.com/api-v3/content-assistant/primary-keywords/retrieve.json

Output:

{"services_token": __ACCESS_TOKEN__, "keywords": {__KEYWORD_ID__: (...) }}

Endpoint:
https://api.semstorm.com/api-v3/content-assistant/primary-keywords/update [POST]

Description:
Change primary keywords data.

Error:
User do not have permission to access Content Assistant.
User do not have editor access to given article.

Curl:

curl -X POST -d '{article_id: __ARTICLE_ID__, "keywords": {__KEYWORD_ID_1__: {"alter_competitors": { "2": false, "3": true }}, (...)}, "services_token": __ACCESS_TOKEN__ }' https://api.semstorm.com/api-v3/content-assistant/primary-keywords/update.json

Output:

[ true ]

Endpoint:
https://api.semstorm.com/api-v3/content-assistant/primary-keywords/delete [POST]

Description:
Delete primary keywords with all their data. This action is irreversable, use with caution.

Error:
User do not have permission to access Content Assistant.
User do not have editor access to given article.

Curl:

curl -X POST -d '{ "article_id": __ARTICLE_ID__ "keywords_ids": [ __KEYWORD_ID_1__, __KEYWORD_ID_2__, (...) ], "services_token": __ACCESS_TOKEN__ }' https://api.semstorm.com/api-v3/content-assistant/primary-keywords/delete.json

Output:

{ __KEYWORD_ID_1__: true, __KEYWORD_ID_2__: true, (...) }

Endpoint:
https://api.semstorm.com/api-v3/content-assistant/primary-keywords/get-list [POST]

Description:
Get primary keywords list.

Error:
User do not have permission to access Content Assistant.
User do not have editor access to given article.

Curl:

curl -X POST -d '{ "article_id": __ARTICLE_ID__, "services_token": __ACCESS_TOKEN__ }' https://api.semstorm.com/api-v3/content-assistant/primary-keywords/get-list.json

Output:

{ "keywords": { __KEYWORD_ID_1__: { (...) } } }

Endpoint:
https://api.semstorm.com/api-v3/content-assistant/article-revisions/get-list [POST]

Description:
Get article revisions list.

Error:
User do not have permission to access Content Assistant.
User do not have editor access to given article.

Curl:

curl -X POST -d '{ "article_id": __ARTICLE_ID__, "services_token": __ACCESS_TOKEN__ }' https://api.semstorm.com/api-v3/content-assistant/article-revisions/get-list.json

Output:

{ "results": { __REVISION_ID_1__: { (...) } } }

Endpoint:
https://api.semstorm.com/api-v3/content-assistant/article-revisions/retrieve [POST]

Description:
Get article revision.

Error:
User do not have permission to access Content Assistant.
User do not have editor access to given article.

Curl:

curl -X POST -d '{ "article_id": __ARTICLE_ID__, "revision_id": __REVISION_ID__, "services_token": __ACCESS_TOKEN__ }' https://api.semstorm.com/api-v3/content-assistant/article-revisions/retrieve.json

Output:

{ "results": { (...) } }

Endpoint:
https://api.semstorm.com/api-v3/content-assistant/article-revisions/revert [POST]

Description:
Get article revisions list.

Error:
User do not have permission to access Content Assistant.
User do not have editor access to given article.

Curl:

curl -X POST -d '{ "article_id": __ARTICLE_ID__, "revision_id": __REVISION_ID__, "services_token": __ACCESS_TOKEN__ }' https://api.semstorm.com/api-v3/content-assistant/article-revisions/revert.json

Output:

{ "results": { "revert": true } }

Passing invalid token (or not passing at all) in request will result in authorization error.

PHP example code:

examples/Monitoring/ErrorAuthorization.php

Curl:

curl https://api.semstorm.com/api-v3/content-assistant/article/create.json?services_token=this-is-wrong-access-token

Output:

[ "Unauthorised access." ]

When error occurs you can check "message" in "error" variable returned from server.

PHP example code:

examples/Monitoring/ErrorSimple.php

Curl:

curl https://api.semstorm.com/api-v3/monitoring/monitoring-campaign/123456.json?services_token=__ACCESS_TOKEN__

Output:

{"error": { "message": "(404) No entry for given id." }

Error with code 503 in most cases will concern throttle prevention. If error message will contain "Throttle prevention. Data may be incomplete(...)" that means system was overloaded and refused to sustain connection.
This is temporary problem, you can retry your request after few secons - just remember that very large request will require more time to wait.
If problem sustains it propably means you are requesting too big set of data at once. Try split it into few smaller requests.

PHP example code:

There is no example of this error, as it happens occasionaly for big set of data.

Curl:

There is no example of this error, as it happens occasionaly for big set of data.

Output:

{ "params": {(...)}, "error": { "message": "(503) Service unavailable. Throttle prevention. Data may be incomplete. Try again later.", "result": {(...)} } }