The Sync API from Relevance AI — 8 operation(s) for sync.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/relevance-ai-sync-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
description: Relevance AI Endpoints
title: Relevance AI Endpoints Sync API
version: latest
contact:
email: dev@tryrelevance.com
servers:
- url: /latest
security:
- AuthorizationHeader:
- Authorization
tags:
- name: Sync
paths:
/sync/template/{sync_template_id}:
delete:
summary: DeleteSyncTemplate
tags:
- Sync
description: 'Delete an existing sync template by its display ID.
### Required permissions
> [
{
"actions": [
"datasets:write"
]
}
]'
operationId: DeleteSyncTemplate
parameters:
- name: sync_template_id
in: path
description: ID of sync_template
required: true
schema:
type: string
maxLength: 240
pattern: ^[a-zd._-]+$
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSyncTemplateInput'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSyncTemplateOutput'
/sync/config/list:
get:
summary: ListSyncConfigs
tags:
- Sync
description: 'List all sync configs
### Required permissions
> []'
operationId: ListSyncConfigs
parameters:
- in: query
name: provider
schema:
type: string
description: Filter sync configs by provider (e.g., 'gmail', 'outlook', 'pipedream')
description: Filter sync configs by provider (e.g., 'gmail', 'outlook', 'pipedream')
- in: query
name: page
schema:
type: number
description: Page number (1-based) for pagination
minimum: 1
description: Page number (1-based) for pagination
- in: query
name: page_size
schema:
type: number
description: Number of results per page
minimum: 1
maximum: 100
default: 20
description: Number of results per page
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ListSyncConfigsOutput'
/sync/templates/list:
get:
summary: ListSyncTemplates
tags:
- Sync
description: 'List all sync templates for a project
### Required permissions
> [
{
"actions": [
"role:reader"
]
}
]'
operationId: ListSyncTemplates
parameters:
- in: query
name: filters
schema:
type: object
properties:
agent_id:
type: string
description: Filter sync templates by agent (display ID)
workforce_id:
type: string
description: Filter sync templates by workforce (display ID)
additionalProperties: false
description: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ListSyncTemplatesOutput'
/sync/template/{sync_template_id}/invite/create:
post:
summary: InviteUsersToAgentTrigger
tags:
- Sync
description: 'Invite users to connect their accounts to an agent trigger
### Required permissions
> []'
operationId: InviteUsersToAgentTrigger
parameters:
- name: sync_template_id
in: path
description: ID of sync_template
required: true
schema:
type: string
maxLength: 240
pattern: ^[a-zd._-]+$
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InviteUsersToAgentTriggerInput'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/InviteUsersToAgentTriggerOutput'
/sync/template/{sync_template_id}/invite/status:
get:
summary: GetSyncTemplateInviteStatus
tags:
- Sync
description: 'Get the status of invites for a specific sync template
### Required permissions
> []'
operationId: GetSyncTemplateInviteStatus
parameters:
- name: sync_template_id
in: path
description: ID of sync_template
required: true
schema:
type: string
maxLength: 240
pattern: ^[a-zd._-]+$
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/GetSyncTemplateInviteStatusOutput'
/sync/invites:
get:
summary: GetPendingInvites
tags:
- Sync
description: 'Get all pending invites for the current user
### Required permissions
> []'
operationId: GetPendingInvites
parameters: []
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/GetPendingInvitesOutput'
/sync/invite/{invite_id}/cancel:
post:
summary: CancelSyncInvite
tags:
- Sync
description: 'Cancel a pending sync invite. Only the invite creator or a project admin can cancel invites.
### Required permissions
> [
{
"actions": [
"agents:write"
]
}
]'
operationId: CancelSyncInvite
parameters:
- name: invite_id
in: path
description: ID of invite
required: true
schema:
type: string
maxLength: 240
pattern: ^[a-zd._-]+$
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CancelSyncInviteInput'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CancelSyncInviteOutput'
/sync/invite/{invite_id}/reject:
post:
summary: RejectSyncInvite
tags:
- Sync
description: 'Reject a sync invite
### Required permissions
> []'
operationId: RejectSyncInvite
parameters:
- name: invite_id
in: path
description: ID of invite
required: true
schema:
type: string
maxLength: 240
pattern: ^[a-zd._-]+$
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RejectSyncInviteInput'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/RejectSyncInviteOutput'
components:
schemas:
GetPendingInvitesOutput:
type: object
properties:
agent_invites:
type: array
items:
type: object
properties:
agent_id:
type: string
agent_name:
type:
- string
- 'null'
agent_description:
type:
- string
- 'null'
invites:
type: array
items:
type: object
properties:
invite_id:
type: string
sync_template_id:
type: string
email:
type: string
status:
type: string
created_at:
type: string
expires_at:
type:
- string
- 'null'
sync_type:
type: string
sync_template_config:
type: object
oneOf:
- type: object
properties:
type:
type: string
gmail:
type: object
properties:
include_labels:
type: array
items:
type: string
exclude_emails:
type: array
items:
type: string
is_outreach_reply_only:
type: boolean
default: false
is_attachments_enabled:
type: boolean
default: false
recently_processed_ids:
type: array
items:
type: object
properties:
gmail_id:
type: string
required:
- gmail_id
additionalProperties: false
search:
type: string
thread_id_mapping:
type: string
additionalProperties: true
required:
- gmail
- type
additionalProperties: false
- type: object
properties:
type:
type: string
google_calendar:
type: object
properties:
events:
type: object
properties:
updated_min_date:
type: string
description: Lower bound for event's last modification time (as a RFC3339 timestamp) to filter by.
notifications:
type: array
items:
type: object
properties:
timeOffset:
type: object
oneOf:
- properties:
unit:
type: string
enum:
- minutes
quantity:
type: integer
minimum: 0
maximum: 1440
direction:
type: string
enum:
- before
- after
required:
- unit
- quantity
- direction
- properties:
unit:
type: string
enum:
- hours
quantity:
type: integer
minimum: 0
maximum: 24
direction:
type: string
enum:
- before
- after
required:
- unit
- quantity
- direction
- properties:
unit:
type: string
enum:
- days
quantity:
type: integer
minimum: 0
maximum: 365
direction:
type: string
enum:
- before
- after
required:
- unit
- quantity
- direction
message:
type: object
properties:
type:
type: string
enum:
- raw
- custom
description: Type of the message
content:
type: string
description: Custom message content (optional if type is 'Whole payload')
required:
- type
additionalProperties: false
required:
- timeOffset
- message
additionalProperties: false
description: An array of notifications
required:
- notifications
required:
- events
additionalProperties: true
required:
- google_calendar
- type
additionalProperties: false
- type: object
properties:
type:
type: string
teams_calendar:
type: object
properties:
events:
type: object
properties:
updated_min_date:
type: string
description: Lower bound for event's last modification time (as a RFC3339 timestamp) to filter by.
watched_sensitivities:
type: array
items:
type: string
enum:
- normal
- private
description: Which Microsoft Graph event sensitivity levels should trigger the agent or workforce. Omit to watch every event (the default). The UI pre-selects all levels; removing one (e.g. 'private') stops events of that sensitivity from triggering. An empty array watches nothing.
notifications:
type: array
items:
type: object
properties:
timeOffset:
type: object
oneOf:
- properties:
unit:
type: string
enum:
- minutes
quantity:
type: integer
minimum: 0
maximum: 1440
direction:
type: string
enum:
- before
- after
required:
- unit
- quantity
- direction
- properties:
unit:
type: string
enum:
- hours
quantity:
type: integer
minimum: 0
maximum: 24
direction:
type: string
enum:
- before
- after
required:
- unit
- quantity
- direction
- properties:
unit:
type: string
enum:
- days
quantity:
type: integer
minimum: 0
maximum: 365
direction:
type: string
enum:
- before
- after
required:
- unit
- quantity
- direction
message:
type: object
properties:
type:
type: string
enum:
- raw
- custom
description: Type of the message
content:
type: string
description: Custom message content (optional if type is 'Whole payload')
required:
- type
additionalProperties: false
required:
- timeOffset
- message
additionalProperties: false
description: An array of notifications
required:
- events
additionalProperties: true
required:
- teams_calendar
- type
additionalProperties: false
- type: object
properties:
type:
type: string
outlook:
type: object
properties:
exclude_emails:
type: array
items:
type: string
is_outreach_reply_only:
type: boolean
default: false
is_attachments_enabled:
type: boolean
default: false
recently_processed_ids:
type: array
items:
type: object
properties:
outlook_id:
type: string
required:
- outlook_id
additionalProperties: false
search:
type: string
thread_id_mapping:
type: string
additionalProperties: true
required:
- outlook
- type
additionalProperties: false
- type: object
properties:
type:
type: string
hubspot:
type: object
properties:
include_labels:
type: array
items:
type: string
exclude_labels:
type: array
items:
type: string
labels:
type: array
items:
type: string
search:
type: string
additionalProperties: true
required:
- hubspot
- type
additionalProperties: false
- type: object
properties:
type:
type: string
unipile:
type: object
properties:
is_outreach_reply_only:
type: boolean
default: false
additionalProperties: true
required:
- unipile
- type
additionalProperties: false
- type: object
properties:
type:
type: string
unipile:
type: object
properties:
is_outreach_reply_only:
type: boolean
default: false
additionalProperties: true
required:
- unipile
- type
additionalProperties: false
- type: object
properties:
type:
type: string
unipile:
type: object
properties:
is_outreach_reply_only:
type: boolean
default: false
additionalProperties: true
required:
- unipile
- type
additionalProperties: false
- type: object
properties:
type:
type: string
whatsapp:
type: object
properties:
whatsapp_business_account_id:
type: string
required:
- whatsapp_business_account_id
additionalProperties: true
required:
- whatsapp
- type
additionalProperties: false
- type: object
properties:
type:
type: string
relevance_meeting_bot:
type: object
properties:
bot_id:
type: string
additionalProperties: true
required:
- relevance_meeting_bot
- type
additionalProperties: false
- type: object
properties:
type:
type: string
freshdesk:
type: object
properties:
whitelist:
type: array
items:
type: object
properties:
source_object:
type: string
enum:
- ticket
default: ticket
source_properties:
type: array
items:
type: object
properties:
field_name:
type: string
whitelist_values:
type: array
items: {}
required:
- field_name
- whitelist_values
additionalProperties: false
required:
- source_object
- source_properties
additionalProperties: false
additionalProperties: false
required:
- freshdesk
- type
additionalProperties: false
- type: object
properties:
type:
type: string
salesforce:
type: object
properties:
salesforce_query:
type: string
last_processed_message_date_utc:
type: string
page_size:
type: number
default: 1000
sync_interval:
type: string
enum:
- minutely
- hourly
- daily
default: minutely
last_sync_date_utc:
type: string
dedupe_field:
type: string
enum:
- Email
- None
- Disabled
mapping:
type: object
properties:
unique_id:
type: string
description: jq path to unique input field for idempotency
thread_id:
type: string
description: jq path to input field for conversation threading
additionalProperties: false
task_creation_mode:
type: string
enum:
- existing_tasks_only
- new_and_existing_tasks
description: The task creation mode controls how tasks are created and appended to.
required:
- salesforce_query
additionalProperties: false
required:
- salesforce
- type
additionalProperties: false
- type: object
properties:
type:
type: string
zoominfo:
type: object
properties:
intent_topics:
type: array
items:
type: string
signal_score_min:
# --- truncated at 32 KB (201 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/openapi/relevance-ai-sync-api-openapi.yml