--- canonical_url: "https://docs.composio.dev/toolkits/pipeless" markdown_url: "https://docs.composio.dev/toolkits/pipeless.md" product: "platform" version: null last_updated: null --- # Pipeless Recommendations Pipeless provides graph-based activity feeds and personalized recommendations from application event data. - **Category:** artificial intelligence - **Auth:** API_KEY - **Composio-managed OAuth available?** N/A - **Tools:** 10 - **Triggers:** 0 - **Slug:** `PIPELESS` - **Version:** 00000000_00 ## Tools ### Create Event **Slug:** `PIPELESS_CREATE_EVENT` Record one typed relationship event for Pipeless activity and recommendation algorithms. Referenced object records may be created or retained and are not removed when the event is later deleted. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `event` | object | Yes | The actor, relationship, and target that make up the event. | | `synchronous` | boolean | No | Wait for processing and return synchronously instead of accepting the event for asynchronous processing. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Events Batch **Slug:** `PIPELESS_CREATE_EVENTS_BATCH` Record 1 to 10 relationship events in one Pipeless request. Referenced object records may be created or retained and are not removed when the events are later deleted. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `events` | array | Yes | Events to ingest together; Pipeless accepts exactly 1 to 10 per call. | | `synchronous` | boolean | No | Wait for processing and return synchronously instead of accepting the batch for asynchronous processing. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Event **Slug:** `PIPELESS_DELETE_EVENT` Delete event records matching an exact start object, relationship type and timestamp, and end object. Wildcard deletion is not supported by this tool. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `end_object` | object | Yes | Exact target object of the event to remove; wildcard deletion is not supported. | | `start_object` | object | Yes | Actor or source object of the event to remove. | | `relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | Yes | Relationship type of the event to remove. | | `relationship_created_on` | string | Yes | Exact whole-second event timestamp from the event record. Accepts RFC 3339 or Pipeless YYYY-MM-DDTHH:MM:SS format and remains required so similar events are not removed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Activity Feed **Slug:** `PIPELESS_LIST_ACTIVITY_FEED` Return one cursor-controlled chronological page of actions by objects followed by a specified object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum feed actions to return in this page; Pipeless documents no maximum. | | `cursor` | string | No | Continuation cursor from the previous response's next_cursor. Omit it for the first page and pass it back unchanged to fetch the next page; it is sent to Pipeless as before. | | `object` | object | Yes | Object whose followed-objects feed should be generated. | | `event_object_types` | array | No | Only include actions targeting these object types. | | `exclude_self_object` | boolean | No | Exclude actions performed by the requesting object. | | `follow_object_types` | array | No | Only follow objects of these types when constructing the feed. | | `allow_missing_object` | boolean | No | Return a cold-start feed instead of failing if the requesting object is missing. | | `event_relationship_types` | array | No | Only include feed actions with these relationship types. | | `follow_relationship_types` | array | No | Relationship types that identify which objects are followed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Object Activity **Slug:** `PIPELESS_LIST_OBJECT_ACTIVITY` Return one cursor-controlled page of incoming or outgoing relationship activity involving a specific object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum events to return in this page; Pipeless documents no maximum. | | `cursor` | string | No | Continuation cursor from the previous response's next_cursor. Omit it for the first page and pass it back unchanged to fetch the next page; it is sent to Pipeless as before. | | `object` | object | Yes | Object whose incoming or outgoing activity should be returned. | | `direction` | string ("incoming" | "outgoing" | "all") | No | Only include activity in this direction relative to the object; use all to explicitly include both directions. | | `relationship_types` | array | No | Only include activity with these relationship types. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Recent Events **Slug:** `PIPELESS_LIST_RECENT_EVENTS` Return the most recent events sent to the app, up to the requested limit; Pipeless provides no continuation cursor for this read. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of recent events to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Recommended Content **Slug:** `PIPELESS_LIST_RECOMMENDED_CONTENT` Return a bounded personalized list of content recommendations for an object using configurable positive, negative, tag, author, follow, and dismissal signals. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum recommendations to return; this endpoint provides no continuation cursor. | | `object` | object | Yes | User or other object receiving personalized recommendations. | | `filter_tag_ids` | array | No | Only return content associated with these tag IDs. | | `coldstart_tag_ids` | array | No | Tag IDs used to seed recommendations when the requesting object has little activity. | | `content_object_type` | string ("user" | "product" | "image" | "comment" | "article" | "post" | "video" | "content" | "tag" | "category" | "app" | "book" | "person" | "skill" | "job" | "company" | "account" | "card" | "country" | "state" | "film" | "cart" | "document" | "project") | Yes | Type of content objects to recommend. | | `content_tag_object_type` | string ("user" | "product" | "image" | "comment" | "article" | "post" | "video" | "content" | "tag" | "category" | "app" | "book" | "person" | "skill" | "job" | "company" | "account" | "card" | "country" | "state" | "film" | "cart" | "document" | "project") | No | Object type used for content tags. | | `include_content_authors` | boolean | No | Include author objects with each recommendation. Set content_created_relationship_type when true. | | `followed_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Relationship identifying followed authors when exclude_content_from_followed is enabled. | | `dismissed_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Relationship identifying content that should be excluded as dismissed. | | `exclude_content_from_followed` | boolean | No | Exclude content authored by objects the requester follows. Set content_created_relationship_type when true. | | `content_tagged_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Relationship connecting content objects to tag objects. | | `content_created_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Relationship connecting authors to content. Required when authors are included or content from followed authors is excluded. | | `primary_negative_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Negative-feedback relationship used to down-rank content. | | `primary_positive_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Strong positive-feedback relationship used for ranking. | | `secondary_positive_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Weaker positive-feedback relationship used for ranking. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Related Content **Slug:** `PIPELESS_LIST_RELATED_CONTENT` Return content objects related to a target content object using optional tag and collaborative-interaction signals. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `object` | object | Yes | Target content object for which related content should be found. | | `actor_object_type` | string ("user" | "product" | "image" | "comment" | "article" | "post" | "video" | "content" | "tag" | "category" | "app" | "book" | "person" | "skill" | "job" | "company" | "account" | "card" | "country" | "state" | "film" | "cart" | "document" | "project") | No | Actor type whose positive interactions contribute to collaborative similarity. | | `content_tagged_object_type` | string ("user" | "product" | "image" | "comment" | "article" | "post" | "video" | "content" | "tag" | "category" | "app" | "book" | "person" | "skill" | "job" | "company" | "account" | "card" | "country" | "state" | "film" | "cart" | "document" | "project") | No | Object type used as tags for the tag signal. | | `positive_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Positive interaction relationship used for collaborative similarity; omit to disable this signal. | | `content_tagged_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Relationship connecting content to tags; omit to disable this tag signal. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Users To Follow **Slug:** `PIPELESS_LIST_USERS_TO_FOLLOW` Return a bounded personalized list of user or account objects that the specified object may want to follow. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum suggestions to return; this endpoint provides no continuation cursor. | | `object` | object | Yes | User or account receiving follow recommendations. | | `content_object_type` | string ("user" | "product" | "image" | "comment" | "article" | "post" | "video" | "content" | "tag" | "category" | "app" | "book" | "person" | "skill" | "job" | "company" | "account" | "card" | "country" | "state" | "film" | "cart" | "document" | "project") | No | Content type used to infer follow affinity. This explicit default is the value documented in the Pipeless OpenAPI definition. | | `allow_missing_object` | boolean | No | Return cold-start suggestions rather than failing if the requesting object is missing. | | `content_tag_object_type` | string ("user" | "product" | "image" | "comment" | "article" | "post" | "video" | "content" | "tag" | "category" | "app" | "book" | "person" | "skill" | "job" | "company" | "account" | "card" | "country" | "state" | "film" | "cart" | "document" | "project") | No | Object type used for content tags. | | `followed_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Relationship that represents following another object. | | `positive_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Positive interaction relationship used to infer follow affinity. | | `dismissed_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Relationship identifying candidates that should be excluded as dismissed. | | `content_tagged_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Relationship connecting content to tags. | | `content_created_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Relationship connecting candidate users to content they created. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Rank Content **Slug:** `PIPELESS_RANK_CONTENT` Rank a supplied set of content IDs for an object and report which IDs Pipeless could rank. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum ranked candidates to return; omit it to use Pipeless's endpoint behavior. | | `object` | object | Yes | User or other object for whom the candidate content should be ranked. | | `content_ids` | array | Yes | Candidate content IDs to rank. | | `content_object_type` | string ("user" | "product" | "image" | "comment" | "article" | "post" | "video" | "content" | "tag" | "category" | "app" | "book" | "person" | "skill" | "job" | "company" | "account" | "card" | "country" | "state" | "film" | "cart" | "document" | "project") | Yes | Object type shared by all candidate content IDs. | | `content_tag_object_type` | string ("user" | "product" | "image" | "comment" | "article" | "post" | "video" | "content" | "tag" | "category" | "app" | "book" | "person" | "skill" | "job" | "company" | "account" | "card" | "country" | "state" | "film" | "cart" | "document" | "project") | No | Object type used for content tags. | | `content_tagged_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Relationship connecting candidate content to tag objects. | | `primary_negative_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Negative-feedback relationship used to down-rank candidates. | | `primary_positive_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Strong positive-feedback relationship used for ranking. | | `secondary_positive_relationship_type` | string ("posted" | "followed" | "liked" | "favorited" | "saved" | "unsaved" | "disliked" | "purchased" | "commentedOn" | "created" | "viewed" | "reported" | "blocked" | "deleted" | "authored" | "used" | "dismissed" | "loggedIn" | "taggedWith" | "categorizedIn" | "interestedIn" | "locatedIn" | "readQuarter" | "readHalf" | "readAll" | "subscribedTo" | "subscribedFrom" | "addedTo" | "madeBy" | "pausedOn" | "updated" | "enabled" | "disabled") | No | Weaker positive-feedback relationship used for ranking. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |