Changelog

2026-10-16

• Adds the ios_files.files data type for Reincubate Relay sources. It lists the documents stored On My iPhone and in iCloud Drive, and, with include: ["app_documents"], those in apps' own Documents/ folders. The new paths and exclude_paths filters narrow it by path.
• Adds the lines and exclude_lines filters for dual-SIM devices, matching the line a message, call or voicemail went over. ios_messages.messages items gain line, line_id and line_label, and ios_phone.calls items gain line_id, line and line_label. See line filters.
• Adds the identifiers and exclude_identifiers filters, matching WeChat IDs and aliases on wechat.messages. WeChat messages gain wechat_id, wechat_alias, group_wechat_ids and group_wechat_aliases. Phone number and email address filters no longer apply to WeChat messages, which previously ignored them.
• Adds the include filter. include: ["transcript"] adds Voice Memos transcripts to .recordings.
• ios_messages.messages items that aren't linked to a conversation now carry orphaned: true and a conversation_id_source. See message handles and conversations.
• The exclude and include filters now reject unrecognised values with a validation error, where unrecognised exclude values were previously ignored.
• Data-level filters now only apply to the data types they can match, and leave the others untouched, so a filter set on the whole poll no longer empties data types that never carry its kind of value. See filter applicability.
• Contacts are now matched on all their phone numbers and email addresses together. exclude_phone_numbers and exclude_email_addresses leave out a contact if any of its numbers or addresses match, where previously a contact that also had an unmatched value was kept. They no longer leave out contacts that have no phone number or email address.
• Corrects WhatsApp participant_added events in whatsapp.messages and whatsapp_business.messages. These were previously labelled group_context, with the person added as the handle. handle is now the admin who added them, and the new group_event_participants field lists the people added. participants_batch_added events are split the same way. See WhatsApp group event types.
• Adds group_event_description to WhatsApp group events whose text is only identifiers or codes, giving a readable sentence such as Iphone 6 (40743660246@s.whatsapp.net) added Luci (40726367814@s.whatsapp.net).
• On WhatsApp group events whose handle comes from the event, handle_name and contact now describe that person, where previously they described the original sender.
• WhatsApp senders and group members identified only by an unresolved LID no longer get a phone number in contact or group_contacts. It was previously made from the LID's digits, which aren't a phone number.

2023-01-23

• Improves data consistency for the ios_messages.messages data module by implementing additional fallback and inference when determining which conversation a message relates to. This patches over issues with source data that has not been smoothly migrated across app and iOS updates over time.

2022-07-08

• Adds support for until filtering to polls and subscriptions on the Relay service. This extends the existing since filter to allow for specifying a period of interest for data retrieval.

2020-03-12

• Adds ability to modify default subscription interval for rirelay service subscriptions. Previously, as rirelay subscriptions are push-based, the interval was set at 24 hours for all subscriptions. Note, this is the interval by which the Reincubate Relay application will be instructed to ask a device for updated data, therefore the device must be connected within this time interval for a poll to be triggered. The default interval is now 24 hours for rirelay.source sources, with a minimum interval of 1 hour.
• Improves the rirelay service progressive polling mechanism. This helps minimise the amount of duplicate data published in subsequent poll results.
• Fixes issue with ordering of list items for certain resources.

2020-02-27

• Adds support for signed URLs. This adds the signed_urls_enabled and signed_urls_expiry on the storage config object to toggle generation of signed URLs for results and how long the signed URLs should be active.
• Adds the signed_url attribute to the result object. This is a nested dictionary containing the signed URL in the url attribute and when it expires in date_expires.
• Adds the ability to acknowledge results in batches with the new POST /results/ack endpoint.
• Adds first_name, last_name, and full_name to the root of info_type:icloud.account.
• Fixes a bug with path prefixes in S3 storage configs.
• Ports over updates to the proxy allocation mechanism. This improves allocation efficiency by assigning iCloud accounts to emptiest proxy available.
• Fixes issue with Reincubate Relay service subscription deletion.

2020-02-20

• The API version can now be specified in one of two ways:
  • Via the api_version attribute on the organisation object.
  • By including the Ricloud-Version header in requests.
  
  This coincides with the first major changes in the API. All existing organisations will by default use the older version of the API.
• Major The results attribute of the poll object is now a nested list object, rather than a simple list attribute. This makes it possible to paginate results when a poll publishes a large number of results.

Now:

{
    "id": <poll ID>,
    "resource": "poll",
    ...
    "results": {
        "data": [{
            "resource": "result",
            ...
        }],
        "has_more": False,
        "total_count": 1,
        "url": "/polls/<poll ID>/results"
    },
    ...
}

Before:

{
    "id": <poll ID>,
    "resource": "poll",
    ...
    "results": [{
        "resource": "result",
        ...
    }],
    ...
}

• Major The results attribute of the task object is now a nested list object, rather than a simple list attribute.
• Major The children attribute of the source object is now a nested list object, rather than a simple list attribute.
• Major The storage_configs and webhook_configs attributes of the organisation object are now a nested list object, rather than a simple list attribute.

2019-10-16

• Adds the Reincubate Relay service. This allows for data retrieval from Reincubate Relay apps running on users' machines. This adds two new source types: rirelay.instance and rirelay.source.
• Adds the subscription object to control periodic and scheduled polling patterns.
• Adds the subscription attribute to the poll object to indicate whether the poll was triggered by a subscription.
• The state attribute of the task object can now have the value suspended. This indicates that the API is awaiting completion of actions by the Reincubate Relay application, such as a file upload or metadata update, for it to resume and complete the task.

2019-06-01

• The poll object payload attribute can now be composed of multiple operation types. This means a poll can be created with any or all of info-types, data-types and files in the payload.
• Major The type attribute on the poll object is deprecated in favour of composable poll payloads.

2018-01-07

Initial release of v3 the Reincubate Cloud API.