Add work records with the Synapse ingest API

Available to organizations on Starter or higher.

With an API key you can add work records from anywhere with an HTTP request. Admins issue keys in Admin console › Security › API keys. A key has the permissions of its owner. Keep the key value private.

Add a record

curl -X POST https://arcgroup.kr/api/synapse/ingest \
  -H "x-synapse-key: <your API key>" \
  -H "Content-Type: application/json" \
  -d '{"title":"Ingest test","body":"Checking that the ingest API works","project":"Test","work_type":"docs","tags":["test"]}'
FieldMeaning
titleOne-line summary (required)
bodyContext, cause, attempts and results
projectProject path — use slashes for levels (service/module/detail)
work_typefeature · bugfix · infra · research · meeting · decision · ops · docs
tagsList of tags

A 201 response means success, 401 means a key problem, and 400 means the title is missing.

Check the project structure first

To avoid the same project under different names, check the current structure and reuse an existing path.

curl https://arcgroup.kr/api/synapse/projects/tree -H "x-synapse-key: <your API key>"

The projects list in the response has each path and its number of records.

Edit and delete

  • Search: GET https://arcgroup.kr/api/synapse/work-logs?q=keyword
  • Edit: PATCH https://arcgroup.kr/api/synapse/work-logs/<id> (send only the fields to change)
  • Delete: DELETE https://arcgroup.kr/api/synapse/work-logs/<id>

All use the same x-synapse-key header.

Give it to an AI tool as instructions

Tell your AI coding tool "when I say 'log this to Synapse', send it in the format above," and it can add a record whenever you finish a task. With Claude, connecting directly as in Use ARC from Claude is simpler.

Was this helpful?

Need more help?

ARC AI can find the answer in Help. If that doesn’t solve it, contact us.

Contact us

Related help