---
id: sync
slug: /apis/sync
title: 'Sync & Connect'
description: 'Agility Sync / Agility Connect - the ancillary integration product and the shape of its API'
sidebar_label: 'Sync & Connect'
sidebar_position: 15
tags: ['sync', 'connect', 'integrations']
---

**Agility Sync** (also appearing as **Agility Connect**) is an ancillary
product for organizations that need to synchronize Digital.ai Agility with
similar or competing tools — Jira, Azure DevOps and others. It is a
**separate platform with its own API**, and that API resembles the Agility
asset API in almost nothing: different host, different authentication
scheme, different request style.

This page summarizes the API's shape so you can recognize it and get
oriented; the authoritative reference is the product's own documentation —
start from
[Getting started with the Agility Sync API](https://docs.digital.ai/agility/docs/get-started/getting-started-with-agility-sync-api).

## How Its API Differs from the Agility API

| Aspect          | Agility API                          | Sync / Connect API                                    |
| --------------- | ------------------------------------- | ------------------------------------------------------ |
| Host            | Your Agility instance                 | The Connect service's own host and port                |
| Style           | Asset/query documents                 | **Command-style REST**: `GET /api/<command>`           |
| Authentication  | `Authorization: Bearer <token>`       | `Authorization: Token <token>` (note: *Token*, not *Bearer*) |
| Default output  | XML or JSON by endpoint               | **XML** — send `Accept: application/json` for JSON     |

## Getting Oriented on a Connect Instance

- `GET /api/version` — verify the API is reachable and see its version
- `GET /api` — list every command the API supports; the command list is
  the real index of capability

## Authentication

- **Token** (recommended): `Authorization: Token <token>`, where the token
  comes from the Connect UI (**My Account**) — or programmatically from
  `GET /api/get_token` using Basic credentials, if an administrator has
  enabled Basic authentication.
- **Basic**: standard HTTP Basic, only if enabled by an administrator.
- A `?token=` query-string argument also works but is the least secure
  option and may be deprecated — avoid it.

## Request and Response Conventions

- Commands that take data are `POST`s with a JSON body and
  `Content-Type: application/json`.
- Response format is negotiated with `Accept`
  (`application/json`, `application/xml`, `text/plain`) or an
  `output_format` query argument (`json`, `xml`, `text`). **The default is
  XML.**
- **Immediate vs eventual results**: listing commands return immediately;
  commands that initiate automation (pipelines, sync runs) return
  immediately *with an identifier*, and the client polls a corresponding
  `get_…` command for progress. Plan for polling in any automation client.

## What to Take Away

If you are integrating with Agility itself, everything else on this site
applies and Sync/Connect is irrelevant. Reach for Sync/Connect when the
problem is *keeping Agility and another ALM tool aligned* — and then work
from its own documentation rather than assuming Agility API conventions
carry over. In particular: the `Token` (not `Bearer`) header and the XML
default response have surprised many first requests.

## Related Topics

- [Getting started with the Agility Sync API](https://docs.digital.ai/agility/docs/get-started/getting-started-with-agility-sync-api) — the product's public entry point
- [Choosing an API](/getting-started/choosing-an-api) — where Sync/Connect fits among the surfaces