Relevance AI · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Relevance AI Endpoints Sync Items API
9 actions
9 updates
phrasing
extends
openapi/relevance-ai-sync-items-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Relevance AI's API. It is a proposal applied on top of the contract, not a document Relevance AI publishes.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/sync-items/collections/{collection_id}/items/{document_id}/get'].get
$.paths['/sync-items/collections/{collection_id}/items/{document_id}'].delete
$.paths['/sync-items/collections/{collection_id}/list'].post
$.paths['/sync-items/collections/{collection_id}/items/{document_id}/upsert'].post
$.paths['/sync-items/collections/{collection_id}/items/{document_id}/trigger'].post
$.paths['/sync-items/collections/{collection_id}/items/{document_id}/update_status'].post
$.paths['/sync-items/collections/{collection_id}/items/{document_id}/fields/update'].put
$.paths['/sync-items/collections/{collection_id}/bulk/postpone'].put
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Relevance AI Endpoints Sync Items API
version: 1.0.0
extends: openapi/relevance-ai-sync-items-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 8
- target: $.paths['/sync-items/collections/{collection_id}/items/{document_id}/get'].get
update:
x-apievangelist-phrasing:
intent: Get an item in a sync collection
effect: read
questions:
- How do I look up one synced item in a collection?
- Can I fetch only some fields of a sync item?
instructions:
- text: Get sync item {document_id} in collection {collection_id}.
slots:
document_id: path.document_id
collection_id: path.collection_id
- text: Show fields {select_fields} of item {document_id} in sync collection {collection_id}.
slots:
select_fields: query.select_fields
document_id: path.document_id
collection_id: path.collection_id
method: generated
generated: '2026-09-26'
- target: $.paths['/sync-items/collections/{collection_id}/items/{document_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an item from a sync collection
effect: destructive
questions:
- How do I remove a single synced item from a collection?
- Is deleting a sync item from its collection reversible?
instructions:
- text: Delete sync item {document_id} from collection {collection_id}.
slots:
document_id: path.document_id
collection_id: path.collection_id
- text: Remove item {document_id} from sync collection {collection_id}.
slots:
document_id: path.document_id
collection_id: path.collection_id
method: generated
generated: '2026-09-26'
- target: $.paths['/sync-items/collections/{collection_id}/list'].post
update:
x-apievangelist-phrasing:
intent: List items in a sync collection
effect: read
questions:
- What items are in a given sync collection?
- Can I filter and page through the items of a sync collection?
instructions:
- text: List items in sync collection {collection_id}.
slots:
collection_id: path.collection_id
- text: List sync items in {collection_id} matching {query}.
slots:
collection_id: path.collection_id
query: requestBody.query
method: generated
generated: '2026-09-26'
- target: $.paths['/sync-items/collections/{collection_id}/items/{document_id}/upsert'].post
update:
x-apievangelist-phrasing:
intent: Create or update a sync item's data
effect: write
questions:
- How do I write data into a sync item?
- Can I increment or remove fields on a sync item while upserting it?
instructions:
- text: Upsert item {document_id} in collection {collection_id} with {data}.
slots:
document_id: path.document_id
collection_id: path.collection_id
data: requestBody.data
- text: Save {data} to sync item {document_id} in {collection_id}, creating it if missing.
slots:
data: requestBody.data
document_id: path.document_id
collection_id: path.collection_id
method: generated
generated: '2026-09-26'
- target: $.paths['/sync-items/collections/{collection_id}/items/{document_id}/trigger'].post
update:
x-apievangelist-phrasing:
intent: Run a sync for one item only
effect: write
questions:
- Can I re-run a sync for just one item rather than the whole collection?
- How do I retry a single failed sync item?
instructions:
- text: Trigger sync item {document_id} in collection {collection_id}.
slots:
document_id: path.document_id
collection_id: path.collection_id
- text: Run only item {document_id} of sync collection {collection_id} now.
slots:
document_id: path.document_id
collection_id: path.collection_id
method: generated
generated: '2026-09-26'
- target: $.paths['/sync-items/collections/{collection_id}/items/{document_id}/update_status'].post
update:
x-apievangelist-phrasing:
intent: Set a sync item's status
effect: write
questions:
- How do I mark a sync item as failed with an error message?
- Can I change the status of a sync item by hand?
instructions:
- text: Set the status of item {document_id} in {collection_id} to {status}.
slots:
document_id: path.document_id
collection_id: path.collection_id
status: requestBody.status
- text: Mark sync item {document_id} in {collection_id} as {status} with error {error}.
slots:
document_id: path.document_id
collection_id: path.collection_id
status: requestBody.status
error: requestBody.error
method: generated
generated: '2026-09-26'
- target: $.paths['/sync-items/collections/{collection_id}/items/{document_id}/fields/update'].put
update:
x-apievangelist-phrasing:
intent: Update selected fields of a sync item
effect: write
questions:
- How do I change just a few fields on a sync item without a full upsert?
- Is there a PUT for editing selected sync item fields?
instructions:
- text: Update the selected fields of sync item {document_id} in {collection_id}.
slots:
document_id: path.document_id
collection_id: path.collection_id
- text: Edit fields on item {document_id} of collection {collection_id}.
slots:
document_id: path.document_id
collection_id: path.collection_id
method: generated
generated: '2026-09-26'
- target: $.paths['/sync-items/collections/{collection_id}/bulk/postpone'].put
update:
x-apievangelist-phrasing:
intent: Postpone upcoming sync items in bulk
effect: write
questions:
- Can I push back every upcoming sync item in a collection at once?
- How do I delay scheduled syncs by a number of seconds?
instructions:
- text: Postpone upcoming {sync_type} items in collection {collection_id} by {postpone_by_seconds} seconds.
slots:
sync_type: requestBody.sync_type
collection_id: path.collection_id
postpone_by_seconds: requestBody.postpone_by_seconds
- text: Delay all scheduled items in {collection_id} by {postpone_by_seconds} seconds for sync type {sync_type}.
slots:
collection_id: path.collection_id
postpone_by_seconds: requestBody.postpone_by_seconds
sync_type: requestBody.sync_type
method: generated
generated: '2026-09-26'
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/relevance-ai-sync-items-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
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.