API documentation
Documentation
Docs navigation
API navigation
Sources
Sources define what Posts should be pulled into a particular Feed. A Source is made up of a source_type
(e.g. Instagram Tag) and a value (called tag
) that's used to query the source type.
Methods
List Sources
Create Source
Update Source
Delete Source
List Sources
This endpoint lists all sources.
GET /sources
Request
GET /v1/sources
Response
[
{
"id": "d7de2fb2-a272-4c75-9e0a-ac9e89aee2b3",
"feed_id": "660b923a-a6e7-4540-bd03-7e08fd006e0d",
"source_type": {
"id": 56,
"network_id": 11,
"network_connection_id": 0,
"name": "Linkedin Company Page",
"minimum_interval": 240,
"app_status": "active",
"worker_status": "active",
"tag_label": "Linkedin Company Page",
"order": 1
},
"network_id": 11,
"company_connection_id": 0,
"status": "active",
"tag": "https://www.linkedin.com/company/microsoft/",
"name": "Microsoft",
"interval": 240,
"first_post_date": "2024-07-03T00:55:10.000000Z",
"error_count": 2,
"post_count": 10,
"default_user_image": "",
"post_field_overrides": null
},
]
Params
Param | Description | Required |
---|---|---|
feed_id | Show sources for a particular Feed | No |
Create Source
This end point creates a Source for a Feed.
When a source is created the platform will request the latest 20 posts from the source.
The example below creates a source that pulls in Instagram posts with the hashtag #myawesometag.
POST /sources
Request
POST /v1/sources
{
"feed_id": "660b923a-a6e7-4540-bd03-7e08fd006e0d",
"source_type": 2,
"tag": "myawesometag"
}
Response
{
"id": "b37d3706-7fbd-4af9-a989-e8d20a50e04e",
"feed_id": "660b923a-a6e7-4540-bd03-7e08fd006e0d"
"source_type": {
"id": 38,
"network_id": 2,
"network_connection_id": 16,
"name": "Instagram Business Hashtag",
"minimum_interval": 1,
"tag_label": "Hashtag Posts",
"example_image": "",
"app_status": "active",
"worker_status": "active",
"order": 3
},
"status": "active",
"tag": "cats",
"name": "cats",
"interval": 5,
"first_post_date": "2025-01-14T16:09:02.000000Z",
"error_count": 0,
"post_count": 0,
"network_id": 2,
"company_connection_id": "9d7b3b50-4187-456a-87b9-e5e25bb02441",
"default_user_image": "",
"post_field_overrides": null,
"response": {
"success": true,
"message": "25 posts were added to your feed"
}
}
Params
Param_type | Description | Required |
---|---|---|
feed_id | Feed to assign source to | Yes |
source_type | Source Type to to pull posts from. See Source Type ID | Yes |
tag | Value to query source | Yes |
Update Source
Updates a Source.
Note: Once created a Sources feed_id
and source_type
can not be modified.
PUT /sources/SOURCE_ID
Request
PUT /v1/sources/SOURCE_ID
{
"tag": "curator_io"
}
Response
{
"id": "1301a1f9-4982-4101-8a2f-2bd4d98db41a",
"feed_id": "660b923a-a6e7-4540-bd03-7e08fd006e0d",
"source_type": {
"id": 38,
"network_id": 2,
"network_connection_id": 16,
"name": "Instagram Business Hashtag",
"minimum_interval": 1,
"tag_label": "Hashtag Posts",
"example_image": "",
"app_status": "active",
"worker_status": "active",
"order": 3
},
"status": "uninitialised",
"tag": "cats",
"name": "cats",
"interval": 5,
"first_post_date": "2025-01-14T16:09:02.000000Z",
"error_count": 0,
"post_count": 0,
"network_id": 2,
"company_connection_id": "9d7b3b50-4187-456a-q5g8-e5e25bb02441",
"default_user_image": "",
"post_field_overrides": null
}
Params
Param | Description | Required |
---|---|---|
SOURCE_ID | Id of Source to update | Yes |
tag | Value to use when querying source | Yes |
Delete Source
Delete a source.
Note: Deleting a source will delete all the associated posts.
DELETE /sources/SOURCE_ID
Request
DELETE /v1/sources/SOURCE_ID
Response
{
"success": true,
"message": "Source deleted"
}
Params
Param | Description | Required |
---|---|---|
SOURCE_ID | Id of Source to delete | Yes |