# Synthpop

> Build patient-journey automation — intake, coverage, and engagement — through one API.

## Docs

- [Exchange an API secret for a token](https://docs.synthpop.ai/api-reference/authentication/exchange-an-api-secret-for-a-token.md): Obtain a Bearer token for use with API endpoints that require authentication.
- [API reference](https://docs.synthpop.ai/api-reference/introduction.md): How to read and use the endpoint reference: base URL, authentication, the interactive playground, and errors.
- [Get a list of tasks.](https://docs.synthpop.ai/api-reference/task-list/get-a-list-of-tasks.md): Retrieve a paginated list of tasks filtered and sorted by criteria as specified in the query params for the request.
- [Add an event to the task's event log.](https://docs.synthpop.ai/api-reference/tasks/add-an-event-to-the-tasks-event-log.md)
- [Create a New Task.](https://docs.synthpop.ai/api-reference/tasks/create-a-new-task.md): **Create a new Task to process input. Upload one or more document(s) to process.**
- [Get File Download Link.](https://docs.synthpop.ai/api-reference/tasks/get-file-download-link.md): Retrieve an expiring pre-signed URL to download a file data item. The link must be used within 60 seconds and hence should not be used to store a persistent reference to a data item.
- [Retrieve a Task.](https://docs.synthpop.ai/api-reference/tasks/retrieve-a-task.md): Retrieve a task either using Synthpop's API or an external ID.
- [Update Task Metadata.](https://docs.synthpop.ai/api-reference/tasks/update-task-metadata.md): Update a task's metadata.  Only set properties you wish to change and omit others.
- [Upload additional data.](https://docs.synthpop.ai/api-reference/tasks/upload-additional-data.md): Upload additional data to an existing task. Note that the task must be in `waiting` state, to accept additional input.
- [Authentication](https://docs.synthpop.ai/authentication.md): Exchange your API secret for a bearer token, then authenticate every request with it.
- [Data Items](https://docs.synthpop.ai/concepts/data-items.md): Data Items are the payload of a Task: the files you upload, the outputs Synthpop produces, and the structured medical records it extracts.
- [The patient journey](https://docs.synthpop.ai/concepts/patient-journey.md): How Synthpop models the patient journey — intake, coverage, and engagement — through one uniform Task API.
- [Results](https://docs.synthpop.ai/concepts/results.md): How Synthpop reports what it found: per-code verdicts, the issues behind them, and a plain-English conclusion — all linked on the Task.
- [Tasks](https://docs.synthpop.ai/concepts/tasks.md): The Task is Synthpop's one first-class resource: create it, add data to it, read it back. This is its shape and lifecycle.
- [Working with async results](https://docs.synthpop.ai/guides/async-results.md): The Synthpop API is asynchronous. Choose polling or an opt-in callback to learn when a Task finishes.
- [Coverage & authorization](https://docs.synthpop.ai/guides/coverage/overview.md): Evaluate eligibility, benefits, and payer rules as part of a validation Task — coverage findings come back in the same result as the clinical verdict.
- [Voice agent capabilities](https://docs.synthpop.ai/guides/engagement/capabilities.md): What Synthpop's voice agent can do on a patient call — and the honest limits of each capability.
- [Patient engagement](https://docs.synthpop.ai/guides/engagement/overview.md): Reach patients through voice and digital outreach to gather missing information and move cases forward — delivered as Tasks, using the same API you already integrate.
- [Voice: trust & compliance](https://docs.synthpop.ai/guides/engagement/trust.md): Why you can rely on what the voice agent says and does — determinism, auditability, and PHI safety.
- [Voice agent](https://docs.synthpop.ai/guides/engagement/voice-agent.md): Place and handle patient phone calls through the API — the voice agent has the conversation and returns a structured outcome on the Task.
- [Errors](https://docs.synthpop.ai/guides/errors.md): HTTP status codes the Synthpop API returns, what causes each, and the JSON error bodies to expect.
- [Multi-patient submissions](https://docs.synthpop.ai/guides/intake/multi-patient.md): When one submission contains several patients, Synthpop can split it into child Tasks — one per patient — and route each to the right validation workflow.
- [Referral & order intake](https://docs.synthpop.ai/guides/intake/overview.md): Automate intake: submit the documents you already receive and get back a structured, per-code validation result.
- [Validate an order](https://docs.synthpop.ai/guides/intake/validate-an-order.md): End-to-end: create a validation Task, poll it to a terminal status, and interpret the verdict, summaries, and issues.
- [Listing tasks](https://docs.synthpop.ai/guides/listing-tasks.md): Page, filter, and sort your organization's Tasks with GET /task/list — the basis for dashboards and reconciliation.
- [Responding to waiting Tasks](https://docs.synthpop.ai/guides/responding-to-waiting-tasks.md): When a Task pauses at waiting it needs more input. Add files or data and resume it.
- [Synthpop for developers](https://docs.synthpop.ai/index.md): One API to orchestrate the patient journey: intake, coverage, and engagement.
- [Quickstart](https://docs.synthpop.ai/quickstart.md): From an API key to your first validated result — the full asynchronous path.
- [Changelog](https://docs.synthpop.ai/reference/changelog.md): Notable changes to the Synthpop Public API and its documentation, newest first.
- [SDKs & tools](https://docs.synthpop.ai/reference/sdks-and-tools.md): There are no official client SDKs yet. Use the OpenAPI spec to generate a client or drive the API from Postman, cURL, or Python today.
- [Security & compliance](https://docs.synthpop.ai/reference/security-compliance.md): How Synthpop protects protected health information (PHI): HIPAA and SOC 2 posture, the default-deny access model, org-scoped data isolation, and short-lived document links.
- [Versioning](https://docs.synthpop.ai/reference/versioning.md): The API version lives in the URL — the v1 in /public/v1. There is one version today, and breaking changes arrive as a new path segment.
- [Contact & support](https://docs.synthpop.ai/support/contact.md): How to get an api_secret, reach the Synthpop team, and report an API issue.
- [FAQ](https://docs.synthpop.ai/support/faq.md): Answers to the questions developers ask most when integrating with the Synthpop Public API.

## OpenAPI Specs

- [openapi](https://docs.synthpop.ai/api-reference/openapi.json)