# Blueprint Documentation > Documentation for the Blueprint Partner Platform ## Guides: documentation - [Getting Started with Blueprint](https://developer.blueprint.ai/docs/getting-started.md) - [Quickstart](https://developer.blueprint.ai/docs/quickstart.md) - [Concepts](https://developer.blueprint.ai/docs/concepts.md) - [Environments & Base URLs](https://developer.blueprint.ai/docs/environments.md) - [Design Your Integration](https://developer.blueprint.ai/docs/design-your-integration.md) - [UI Only Integrations](https://developer.blueprint.ai/docs/ui-only-integrations.md) - [UI + API Integrations](https://developer.blueprint.ai/docs/ui-api-integrations.md) - [API Only Integrations](https://developer.blueprint.ai/docs/api-only-integrations.md) - Using the API - [Authentication](https://developer.blueprint.ai/docs/authentication.md) - [Errors](https://developer.blueprint.ai/docs/errors.md) - [Pagination & Limits](https://developer.blueprint.ai/docs/pagination-and-limits.md) - [Rate Limiting & Throttling](https://developer.blueprint.ai/docs/rate-limiting-and-throttling.md) - [Listening to Webhooks](https://developer.blueprint.ai/docs/listening-to-webhooks.md) - [Webhook Events Reference](https://developer.blueprint.ai/docs/webhook-events.md) - Building the User Interface - [Customizing the Experience](https://developer.blueprint.ai/docs/customization-options.md) - [Controlling the UI](https://developer.blueprint.ai/docs/controlling-the-widget.md) - [Widget Reference](https://developer.blueprint.ai/docs/widget-reference.md) - [Widget Troubleshooting](https://developer.blueprint.ai/docs/widget-troubleshooting.md) ## API Reference: Blueprint: Partner API - partners - [Authenticate your application](https://developer.blueprint.ai/reference/authenticatepartner.md): Exchanges your clientId and clientSecret for a server-to-server access token valid for one hour. Send the token on every subsequent request in the Access-Token header — despite the Bearer tokenType,… - [Get your partner organization](https://developer.blueprint.ai/reference/getpartner.md): Returns your partner record, including the callbackUrl webhooks are delivered to. - [Update your partner organization](https://developer.blueprint.ai/reference/updatepartner.md): Sets the callbackUrl that all webhook events are delivered to. There is one callback URL per partner organization per environment, and every event type is sent to it. - organizations - [Create an organization](https://developer.blueprint.ai/reference/createorganization.md): Creates an organization representing one of your customers, such as a group practice. Every organization needs at least one clinic; if the practice has no locations to model, create a single clinic… - [List organizations](https://developer.blueprint.ai/reference/listorganizations.md): Returns your organizations, 10 per page. Pass page to paginate. - [Create a clinic](https://developer.blueprint.ai/reference/createclinic.md): Creates a location within an organization. Clinicians and clients are scoped to a clinic. - [List an organization's clinics](https://developer.blueprint.ai/reference/listclinics.md): Returns the clinics in an organization, 10 per page. - [Create a program](https://developer.blueprint.ai/reference/createprogram.md): Creates a program — a grouping used to organize clients within an organization, such as a care pathway or cohort. - [List an organization's programs](https://developer.blueprint.ai/reference/listprogramsfororganization.md): Returns the programs defined for an organization, 10 per page. - [Delete a program](https://developer.blueprint.ai/reference/deleteprogram.md): Removes a program from an organization. - [Update organization preferences](https://developer.blueprint.ai/reference/updateorganizationpreferences.md): Updates display preferences for an organization. Currently only copyNoteButtonText, which relabels the copy button in the embedded UI. - [List available progress note types](https://developer.blueprint.ai/reference/getprogressnotetypes.md): Returns the note types available to an organization, including the session type and clinician group each applies to. Call this rather than hardcoding note types — the available set varies by… - [Retrieve an organization](https://developer.blueprint.ai/reference/getorganization.md): Returns a single organization by ID. Use this to resolve an organization you have already stored, rather than paging the list endpoint to find it. - [List assignable clinician roles](https://developer.blueprint.ai/reference/listclinicianroles.md): Returns the roles you can assign in this organization. Pass their keys in the roles field of POST /clinics/{clinicId}/clinicians or PATCH /clinicians/{clinicianId}. Every clinician always holds the… - clinics - [Create a clinician](https://developer.blueprint.ai/reference/createclinician.md): Creates a clinician record for a user of your application. Set externalId to your own user identifier. Optionally pass roles (keys from GET /organizations/{organizationId}/clinician-roles); every… - [List a clinic's clinicians](https://developer.blueprint.ai/reference/listclinicians.md): Returns the clinicians in a clinic, 10 per page. Filter by id, firstName, lastName, email, or externalId. - [List a clinic's clients](https://developer.blueprint.ai/reference/listclientsforclinic.md): Returns the clients in a clinic, 10 per page. Filter by externalId, name, email, phoneNumber, dateOfBirth, status, or clinicianId. Filtering by externalId is the intended way to find a client you… - [List a clinic's assessments](https://developer.blueprint.ai/reference/listassessments.md): Returns the assessments available to a clinic, 10 per page. Pass defaultOnly to restrict the result to the clinic's default set. - [Retrieve a clinic](https://developer.blueprint.ai/reference/getclinic.md): Returns a single clinic by ID. Use this to resolve a clinic you have already stored, rather than paging the organization clinic list to find it. - clinicians - [Get a clinician](https://developer.blueprint.ai/reference/getclinician.md): Returns a single clinician by internal identifier, including the role keys it holds. - [Update a clinician](https://developer.blueprint.ai/reference/updateclinician.md): Updates a clinician's name, email, externalId, or roles. At least one field is required. roles replaces the clinician's assignable roles (keys from GET… - [Delete a clinician](https://developer.blueprint.ai/reference/deleteclinician.md): Archives a clinician. Their existing clients and sessions are retained. - [Create a client](https://developer.blueprint.ai/reference/createclient.md): Creates a client belonging to a clinician. Set externalId to your own identifier, such as a medical record number. phoneNumber must be a valid U.S., U.S. territory, or Canadian number in E.164 form,… - [List a clinician's clients](https://developer.blueprint.ai/reference/listclientsforclinician.md): Returns a clinician's clients, 10 per page. Filter by externalId, name, email, phoneNumber, dateOfBirth, or status. - [Get a clinician's note preferences](https://developer.blueprint.ai/reference/getnotepreferences.md): Returns the note generation preferences applied to this clinician's progress notes. - [Update a clinician's note preferences](https://developer.blueprint.ai/reference/updatenotepreferences.md): Sets note generation preferences — length, direct quotes, mental status exam components and similar — applied to this clinician's future progress notes. - [Mint a clinician token for the embedded UI](https://developer.blueprint.ai/reference/authenticateclinician.md): Issues a short-lived token pair scoped to one clinician, without their password, so the embedded UI can act on their behalf. Takes no request body. Return the response object to your front end… - [List a clinician's magic edits](https://developer.blueprint.ai/reference/listclinicianmagicedits.md): Returns the magic edit instructions this clinician has submitted, 10 per page. - clients - [Update a client](https://developer.blueprint.ai/reference/updateclient.md): Updates a client's details. phoneNumber must be a valid U.S., U.S. territory, or Canadian number in E.164 form, for example +15555550123. - [Delete a client](https://developer.blueprint.ai/reference/deleteclient.md): Deletes a client. Consider archiving instead if you need to retain their history. - [Get a client](https://developer.blueprint.ai/reference/getclient.md): Returns a single client by internal identifier. - [Create a session from an audio file](https://developer.blueprint.ai/reference/createsession.md): Creates a completed session from audio that Blueprint downloads from the supplied fileUrl, then generates documentation asynchronously. This is the API-only path — there is no endpoint that accepts… - [List a client's sessions](https://developer.blueprint.ai/reference/listsessions.md): Returns a client's sessions, 10 per page. - [Assign a client to a program](https://developer.blueprint.ai/reference/assignprogram.md): Adds a client to a program within their organization. - [List a client's programs](https://developer.blueprint.ai/reference/listprogramsforclient.md): Returns the programs a client is assigned to, 10 per page. - [Remove a client from a program](https://developer.blueprint.ai/reference/deleteprogramassignment.md): Removes a client's assignment to a program. The program itself is unaffected. - [Transfer a client to another clinician](https://developer.blueprint.ai/reference/transferclient.md): Reassigns a client to a different primary clinician in the same clinic. Transfers across clinics are rejected, even within the same organization. Returns 409 if the client is already assigned to the… - [Archive a client](https://developer.blueprint.ai/reference/archiveclient.md): Marks a client archived. Archived clients are retained but excluded from active workflows. - [Send assessments to a client now](https://developer.blueprint.ai/reference/administerassessments.md): Sends a client assessments to complete immediately and returns a URL they can use. Use assign-assessments instead to add assessments to their recurring schedule. Assessments must be assigned through… - [Assign assessments to a client](https://developer.blueprint.ai/reference/assignassessments.md): Adds assessments to a client's ongoing schedule. Use administer-assessments instead to send assessments to be completed now. Assessments must be assigned through assign-assessments before they can be… - [Submit assessment answers](https://developer.blueprint.ai/reference/submitassessments.md): Submits assessment answers you collected in your own interface, rather than having Blueprint deliver the assessment. Scores become available through the assessment_completed webhook. - [Add secondary clinicians to a client](https://developer.blueprint.ai/reference/assignsecondaryclinicians.md): Adds secondary clinicians to a client, skipping any who are already assigned. This makes the call safe to retry. To reconcile the full set instead, use POST… - [Set a client's secondary clinicians](https://developer.blueprint.ai/reference/assignsecondarycliniciansendpoint.md): Reconciles a client's secondary clinicians against the set you supply. To add clinicians without affecting existing assignments, use POST /clients/{clientId}/secondary-clinicians instead. - [Remove secondary clinicians from a client](https://developer.blueprint.ai/reference/removesecondaryclinicians.md): Removes the given secondary clinicians from a client. The client's primary clinician is unaffected. - [Unarchive a client](https://developer.blueprint.ai/reference/unarchiveclient.md): Restores an archived client to active status. Returns 409 if the client is not archived. - sessions - [Get a session](https://developer.blueprint.ai/reference/getsession.md): Returns a session, including the identifiers of any progress notes generated from it. - [Delete a session](https://developer.blueprint.ai/reference/deletesession.md): Deletes a session and the clinical artifacts generated from it. - [Update a session's external ID](https://developer.blueprint.ai/reference/updatesession.md): Sets your own identifier on a session. It is echoed back in webhook payloads as sessionExternalId, so you can attribute generated documentation to an appointment without a lookup. - [Get a session transcript](https://developer.blueprint.ai/reference/gettranscript.md): Returns the diarized transcript as timed items with a speaker number. Transcripts are generated asynchronously — prefer waiting for the transcript_ready webhook over polling. - [Delete a session transcript](https://developer.blueprint.ai/reference/deletetranscript.md): Deletes the transcript for a session. The session and any generated notes are retained. - [Get a session summary](https://developer.blueprint.ai/reference/getsummary.md): Returns the narrative summaries generated for a session. A session can have summaries aimed at different audiences. - [Get a session's progress note](https://developer.blueprint.ai/reference/getprogressnote.md): Returns the progress note for a session as an ordered array of sections, each with a machine-readable key, a title, and content — so you can render a note type without knowing its sections in… - [Get a session's medical decision making elements](https://developer.blueprint.ai/reference/getmdm.md): Returns the MDM elements identified for a session — problems addressed, risk of complications, and whether crisis intervention was identified. Generated asynchronously for prescriber note types; wait… - progress-notes - [Apply a natural-language edit to a progress note](https://developer.blueprint.ai/reference/magicedit.md): Rewrites a progress note according to free-text instructions, up to 5000 characters. The rewrite happens asynchronously — listen for the progress_note_regenerated webhook. Returns 403 once a… - [Get a progress note](https://developer.blueprint.ai/reference/getprogressnotebyid.md): Returns a progress note by its own identifier, in the same shape as GET /sessions/{sessionId}/progress-note. - [Delete a progress note](https://developer.blueprint.ai/reference/deleteprogressnotebyid.md): Deletes a progress note. The session and its transcript are retained. - [Edit a progress note section](https://developer.blueprint.ai/reference/updateprogressnote.md): Replaces the content of a single section of a progress note. The section key comes from the note's own template.sections[].key. Exactly one section may be updated per request; all others are left… - [Regenerate a progress note](https://developer.blueprint.ai/reference/regenerate.md): Regenerates a progress note, optionally in a different format or with different preferences. Happens asynchronously — listen for the progress_note_regenerated webhook. Returns 403 once a clinician… - summaries - [Delete a session summary](https://developer.blueprint.ai/reference/deletesessionsummary.md): Deletes a session summary. The session and its other artifacts are retained. - [Update a session summary](https://developer.blueprint.ai/reference/updatesessionsummary.md): Replaces the text of a session summary. - assessment-scores - [Get an assessment score](https://developer.blueprint.ai/reference/getassessmentscore.md): Returns a completed assessment's total score and per-question answers. The assessment_completed webhook supplies the URL for each score. ## API Reference: Blueprint Partner API Webhooks - progress_note_generated - [Progress note generated](https://developer.blueprint.ai/reference/post_progress-note-generated.md): Fires when a progress note has been created. - progress_note_regenerated - [Progress note regenerated](https://developer.blueprint.ai/reference/post_progress-note-regenerated.md): Fires when a progress note has been regenerated, after a Magic Edit or an explicit regenerate call. Replace any note content you have stored. - progress_note_finalized - [Progress note finalized](https://developer.blueprint.ai/reference/post_progress-note-finalized.md): Fires when a progress note is finalized and locked for edits. After this event, patch, magic-edit, and regenerate return 403. - transcript_ready - [Transcript ready](https://developer.blueprint.ai/reference/post_transcript-ready.md): Fires when the session transcript is available. - session_transcript_error - [Session transcript error](https://developer.blueprint.ai/reference/post_session-transcript-error.md): Fires when transcription fails. No transcript or progress note will be produced for this session. This payload contains no resource URL. - mdm_elements_identified - [MDM elements identified](https://developer.blueprint.ai/reference/post_mdm-elements-identified.md): Fires when medical decision making elements are available for a session. Prescriber note types only. - assessment_completed - [Assessment completed](https://developer.blueprint.ai/reference/post_assessment-completed.md): Fires when a client completes an assessment and scores are available. Note this payload is client-scoped and uses patientId rather than clientId.