canonical: https://jentic.com/apis/twilio.com/twilio---sync

# Twilio - Sync

This is the public Twilio REST API. The API exposes 48 endpoints secured with basic authentication.

## For AI agents

Programmatically update an identity's access to a specific sync document., fetch a specific sync document permission.. Covers 48 operations with basic authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Update an identity's access to a specific Sync Document.
- Fetch a specific Sync Document Permission.
- Delete a specific Sync Document Permission.
- Retrieve a list of all Permissions applying to a Sync Document.
- Create a new Stream Message.

## Use cases

### Developer Tools Operations

Use the Twilio - Sync to perform developer tools operations programmatically. The API provides 48 endpoints covering core functionality including update an identity's access to a specific sync document., fetch a specific sync document permission., delete a specific sync document permission..

Example prompt: Call POST /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity} to update an identity's access to a specific sync document.

### Automated SyncV1Document Management

Automate syncv1document operations by combining multiple Twilio - Sync endpoints. Agents can fetch a specific sync document permission. and then delete a specific sync document permission. in a single workflow.

Example prompt: Call GET /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity} to fetch a specific sync document permission., then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Twilio - Sync endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.

Example prompt: Search Jentic for 'update an identity's access to a specific sync document.', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity} | Update an identity's access to a specific Sync Document. |
| GET | /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity} | Fetch a specific Sync Document Permission. |
| DELETE | /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity} | Delete a specific Sync Document Permission. |
| GET | /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions | Retrieve a list of all Permissions applying to a Sync Document. |
| POST | /v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages | Create a new Stream Message. |
| POST | /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity} | Update an identity's access to a specific Sync List. |
| GET | /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity} | Fetch a specific Sync List Permission. |
| DELETE | /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity} | Delete a specific Sync List Permission. |

## Key resources

- **SyncV1Document** — Operations related to SyncV1Document
- **SyncV1DocumentPermission** — Operations related to SyncV1DocumentPermission
- **SyncV1Service** — Operations related to SyncV1Service
- **SyncV1StreamMessage** — Operations related to SyncV1StreamMessage
- **SyncV1SyncList** — Operations related to SyncV1SyncList

## Why Jentic

- **Setup:** Wiring Twilio Sync by hand means setting up HTTP basic auth with your account SID and auth token against the sync.twilio.com host and handling retries yourself. Through Jentic you install once, import Twilio Sync from the API Directory, store the account SID and auth token once, and your agent calls it.
- **Permission scoping:** Twilio Sync puts the service, document, list, and identity in the URL path (/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}), so a rule can pin your agent to one service or document. You choose the operations it may call, so destructive ones like deleting a permission are not included unless you add them.
- **Credential handling:** Your Twilio account SID and auth token are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'update an identity's access to a document' or 'post a message to a stream', and Jentic returns the matching Twilio Sync operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Twilio - Sync use?

The Twilio - Sync uses HTTP Basic authentication with username and password. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I update an identity's access to a specific sync document. with the Twilio - Sync?

Yes. Use the POST /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity} endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Twilio - Sync?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I update an identity's access to a specific sync document. through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'update an identity's access to a specific sync document.'. Jentic returns the matching Twilio - Sync operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Twilio - Sync have?

The Twilio - Sync exposes 48 endpoints covering syncv1document, syncv1documentpermission, syncv1service operations.

### Can I limit what my agent is allowed to do with the Twilio Sync API?

Yes. Because you run Jentic One yourself, your own rules decide which Twilio Sync operations and credentials the agent may use, and you pick the exact endpoints it can call, so a destructive operation like DELETE on a Sync Document or Sync List permission is excluded unless you add it. Twilio Sync puts the service, document, list, and identity in the URL path, such as /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}, so a rule can pin the agent to a single service or document. You can allow only read operations like fetching or listing permissions while blocking updates, or let it post a Stream Message without touching permissions at all. Your stored account SID and auth token are injected at execution time and never enter the agent's prompt or logs.