WalkPic documentation

API reference

Search the versioned contract. Supported integration reads are marked explicitly.

The API base is https://walkpic.com. OpenAPI contract 1.1.0 describes 203 operations; production runtime is 0.1.58. 8 v2 starter reads are enabled for personal SDK/CLI/MCP grants. Other operations have their own declared authentication and are not enabled CLI/MCP tools.

Find an operation

203 operations

POST/v1/publications/prepareAPI catalog

PreparePublication

contentPreparePublication

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful implemented response
400 INVALID_REQUEST: field/shape/cross-field violation; LIMIT_EXCEEDED: route/photos/pins/aggregate bytes validation bounds; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
409 IDEMPOTENCY_CONFLICT: actor/key content changed; RECIPIENT_CHANGED: recipient no longer approved/unblocked
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
422 CONTENT_NOT_ALLOWED: new title/date/story denied
429 LIMIT_EXCEEDED: 100 publications in previous day or >=5 pending
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

PUT/v1/uploads/{publicationId}/{photoId}API catalog

UploadPhoto

contentUploadPhoto

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string
`photoId` · required	path	string

Responses

200 Successful implemented response
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: unowned/missing publication or photo absent from approved manifest
409 UPLOAD_CLOSED: not pending, >=24h old, or post-processing/storage revalidation no longer pending/current; IMAGE_ASSESSMENT_REQUIRED: policy/proof changed during processing
413 LIMIT_EXCEEDED: read exceeds 12M
415 INVALID_REQUEST: not exact image/jpeg
422 ASSET_UNAVAILABLE: raw bytes/hash mismatch or invalid image; IMAGE_CONTENT_NOT_ALLOWED: enabled trusted assessor rejects
429 UPLOAD_BUSY: >=2 admitted HTTP uploads; IMAGE_SCREENING_BUSY: >=2 screening operations; IMAGE_PROCESSING_UNAVAILABLE: normalizer returns IMAGE_PROCESSING_BUSY; HTTP code intentionally differs internal busy code
500 INTERNAL_ERROR: unmapped internal failure; generic public message
503 IMAGE_PROCESSING_UNAVAILABLE: other non-ApiError processing failure; IMAGE_PROCESSING_ABORTED: request disconnected/processing canceled; IMAGE_SCREENING_UNAVAILABLE: missing configured policy/assessor/provider failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/publications/{publicationId}/statusAPI catalog

ReadPublicationStatus

contentReadPublicationStatus

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string

Responses

200 Successful implemented response
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: not owned/missing publication
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/publications/{publicationId}/commitAPI catalog

CommitPublication

contentCommitPublication

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string

Responses

200 Successful implemented response
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: not owned/missing publication
409 UPLOAD_CLOSED: pending >=24h, including SQL before-command expiry guard; ASSET_UNAVAILABLE: approved photo not uploaded; SQL error mapping409 differs upload mismatch422; RECIPIENT_CHANGED: recipient no longer approved/unblocked; IMAGE_SCREENING_PENDING: more than two legacy stored photos require current screening; retry advances persisted proofs; IMAGE_ASSESSMENT_REQUIRED: current policy/proof changed
410 REVISION_REVOKED: not pending/active
422 CONTENT_NOT_ALLOWED: pending title/date/story now denied
500 INTERNAL_ERROR: unmapped internal failure; generic public message
503 IMAGE_SCREENING_UNAVAILABLE: enabled policy lacks valid processor/proof

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/publications/{publicationId}/cancelAPI catalog

CancelPublication

contentCancelPublication

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: nonobject/invalid coerced key; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: not owned/missing
409 IDEMPOTENCY_CONFLICT: same actor/action/coerced key refers to different publication; ALREADY_COMMITTED: cancel of active publication
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/publications/{publicationId}/restrictAPI catalog

RestrictPublication

contentRestrictPublication

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: nonobject/invalid coerced key; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: not owned/missing
409 IDEMPOTENCY_CONFLICT: same actor/action/coerced key refers to different publication
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/publications/{publicationId}/link/rotateAPI catalog

RotatePublicationLink

contentRotatePublicationLink

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: invalid coerced key; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: not owned/missing
409 REVISION_REVOKED: initial owned publication not active; IDEMPOTENCY_CONFLICT: same actor/action/key targets changed publication
410 REVISION_REVOKED: state changes before atomic SQL link command; shared SQL mapping
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/publications/{publicationId}/link/revokeAPI catalog

RevokePublicationLink

contentRevokePublicationLink

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: invalid coerced key; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: not owned/missing
409 REVISION_REVOKED: initial owned publication not active; IDEMPOTENCY_CONFLICT: same actor/action/key targets changed publication
410 REVISION_REVOKED: state changes before atomic SQL link command; shared SQL mapping
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/publications/{publicationId}API catalog

ReadPublication

contentReadPublication

Security: Guest (subject to sharing policy) or BearerAuth or PublicationLink or LegacyPublicationLinkQuery or BearerAuth + PublicationLink or BearerAuth + LegacyPublicationLinkQuery. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string
`token`	query	string
`X-PhotoTracker-Link`	header	string

Responses

200 Successful implemented response
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: missing/restricted/cancelled/deleted owner/blocked/unauthorized/current session unavailable
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/publications/{publicationId}/accessAPI catalog

ReadPublicationAccess

contentReadPublicationAccess

Parameters

Name	Location	Type
`publicationId` · required	path	string
`token`	query	string
`X-PhotoTracker-Link`	header	string

Responses

200 Successful implemented response
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: missing/restricted/cancelled/deleted owner/blocked/unauthorized/current session unavailable
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/publications/{publicationId}/media/{photoId}API catalog

ReadPublicationPhoto

contentReadPublicationPhoto

Parameters

Name	Location	Type
`publicationId` · required	path	string
`photoId` · required	path	string
`token`	query	string
`X-PhotoTracker-Link`	header	string
`Range`	header	string

Responses

200 Selected approved JPEG bytes
206 Selected approved JPEG bytes
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: not current readable/photo missing/exact object changed after storage
416 INVALID_RANGE: invalid/multiple/out-of-bounds range; Content-Range:bytes */total
500 INTERNAL_ERROR: unmapped internal failure; generic public message
503 MEDIA_UNAVAILABLE: provider unavailable or current screening proof/hash does not match

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/v1/publications/{publicationId}/media/{photoId}API catalog

HeadPublicationPhoto

contentHeadPublicationPhoto

Parameters

Name	Location	Type
`publicationId` · required	path	string
`photoId` · required	path	string
`token`	query	string
`X-PhotoTracker-Link`	header	string
`Range`	header	string

Responses

200 Selected JPEG metadata; HEAD has no body and performs same storage/ACL work.
206 Selected JPEG metadata; HEAD has no body and performs same storage/ACL work.
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: not current readable/photo missing/exact object changed after storage
416 INVALID_RANGE: invalid/multiple/out-of-bounds range; Content-Range:bytes */total
500 INTERNAL_ERROR: unmapped internal failure; generic public message
503 MEDIA_UNAVAILABLE: provider unavailable or current screening proof/hash does not match

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/publications/{publicationId}/media/{photoId}/accessAPI catalog

ReadPhotoExportAccess

contentReadPhotoExportAccess

Parameters

Name	Location	Type
`publicationId` · required	path	string
`photoId` · required	path	string
`token`	query	string
`X-PhotoTracker-Link`	header	string

Responses

200 Successful implemented response
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: exact uploaded photo/current readable ACL/live actor/session lost
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

PUT/v1/publications/{publicationId}/storyAPI catalog

UpdatePublicationStory

contentUpdatePublicationStory

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: fields/story/revision invalid; LIMIT_EXCEEDED: normalized story>256k; INVALID_INPUT: SQL moment reference invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: not active owner/access changed
409 VERSION_CHANGED: expected revision stale or story changed again after write
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
422 CONTENT_NOT_ALLOWED: story/checkin text denied
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/story-speechAPI catalog

PreviewStorySpeech

contentPreviewStorySpeech

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful implemented response
400 INVALID_REQUEST: text/voice/unknown key invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: owner/session changed or aborted after provider/save; AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
409 RECORDING_NOT_SAVED: access changed/cache500 entries or64MB per owner reached
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
429 RATE_LIMITED: >=2 active fresh generation, >=12 per scoped client/min, >=60 global/min, same persistent key in flight
500 INTERNAL_ERROR: unmapped internal failure; generic public message
503 SPEECH_UNAVAILABLE: not enabled/provider failure/wrong audio MIME/empty or >2M audio/recording JSON>2.8M

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/publications/{publicationId}/story-speechAPI catalog

RenderPublicationStorySpeech

contentRenderPublicationStorySpeech

Parameters

Name	Location	Type
`publicationId` · required	path	string
`token`	query	string
`X-PhotoTracker-Link`	header	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: text/voice/unknown key invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: missing unreadable publication or post-slow-work user/publication snapshot changed
409 RECORDING_NOT_SAVED: access changed/cache500 entries or64MB per owner reached
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
429 RATE_LIMITED: >=2 active fresh generation, >=12 per scoped client/min, >=60 global/min, same persistent key in flight
500 INTERNAL_ERROR: unmapped internal failure; generic public message
503 SPEECH_UNAVAILABLE: not enabled/provider failure/wrong audio MIME/empty or >2M audio/recording JSON>2.8M

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/photo-narrationAPI catalog

DescribePhoto

contentDescribePhoto

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful implemented response
400 INVALID_REQUEST: bounds/base64/JPEG/point/caption/purpose/unknown field invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: actor/session changed or aborted; AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
409 RECORDING_NOT_SAVED: current owner/recording limits refuse durable save
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
429 RATE_LIMITED: >=2 active, same scoped digest pending, >=12 per actor/min
500 INTERNAL_ERROR: unmapped internal failure; generic public message
503 PHOTO_NARRATION_UNAVAILABLE: not enabled/provider failure or malformed result

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/library/publicationsAPI catalog

ListOwnedPublications

contentListOwnedPublications

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`limit`	query	string
`cursor`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: unknown/duplicate query field or invalid limit/filter; INVALID_CURSOR: signature/scope/shape invalid
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
410 CURSOR_EXPIRED: older than15min or >60s in future
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/library/publications/{publicationId}/audienceAPI catalog

ReadOwnedAudience

contentReadOwnedAudience

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string

Responses

200 Successful implemented response
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: not current active owner
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/library/receivedAPI catalog

ListReceivedPublications

contentListReceivedPublications

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`limit`	query	string
`cursor`	query	string
`authors`	query	string
`saved`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: unknown/duplicate query field or invalid limit/filter; INVALID_CURSOR: signature/scope/shape invalid
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
410 CURSOR_EXPIRED: older than15min or >60s in future
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/library/peopleAPI catalog

ListReceivedAuthors

contentListReceivedAuthors

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`query`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: unknown/duplicate query or query length>100
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/library/received/accessAPI catalog

RevalidateReceivedPublications

contentRevalidateReceivedPublications

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful implemented response
400 INVALID_REQUEST: invalid IDs/duplicate/>500; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/savedAPI catalog

ListSavedPublications

contentListSavedPublications

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`limit`	query	string
`cursor`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: unknown/duplicate query field or invalid limit/filter; INVALID_CURSOR: signature/scope/shape invalid
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
410 CURSOR_EXPIRED: older than15min or >60s in future
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

PUT/v1/publications/{publicationId}/savedAPI catalog

SetPublicationSaved

contentSetPublicationSaved

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: query not empty/exact two fields invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: strict path UUID fails or Save target not saveable
409 IDEMPOTENCY_CONFLICT: same actor/request UUID with changed action/target
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

PUT/v1/publications/{publicationId}/likeAPI catalog

SetPublicationLike

contentSetPublicationLike

Security: BearerAuth or BearerAuth + PublicationLink or BearerAuth + LegacyPublicationLinkQuery. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string
`token`	query	string
`X-PhotoTracker-Link`	header	string

Responses

200 Successful implemented response
204 Successful withdrawal; current target inaccessible so no metrics/body.
400 INVALID_REQUEST: exact one boolean field invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: Like target not readable
409 SELF_LIKE: owner attempt via schema guard
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/exploreAPI catalog

ExplorePublications

contentExplorePublications

Security: Guest (subject to sharing policy) or BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`sort`	query	string
`limit`	query	string
`bbox`	query	string
`cursor`	query	string
`maxDistanceMeters`	query	string
`maxDurationSeconds`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: unknown/duplicate query field or invalid limit/filter; INVALID_CURSOR: signature/scope/shape invalid
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
410 CURSOR_EXPIRED: older than15min or >60s in future
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/discoverAPI catalog

DiscoverPublications

contentDiscoverPublications

Security: Guest (subject to sharing policy) or BearerAuth. Current domain permissions still apply.

Responses

200 Successful implemented response
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/feedAPI catalog

ReadFeed

contentReadFeed

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful implemented response
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/publicationsAPI catalog

ListManagedPublications

contentListManagedPublications

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful implemented response
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

PUT/v1/place-visits/{visitId}API catalog

SharePlaceVisit

contentSharePlaceVisit

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`visitId` · required	path	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: strict UUID/body/checkin invalid or private visibility on PUT; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: visit owned by another actor
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
422 CONTENT_NOT_ALLOWED: name/address/review denied
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

DELETE/v1/place-visits/{visitId}API catalog

RemovePlaceVisit

contentRemovePlaceVisit

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`visitId` · required	path	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: strict UUID/body/checkin invalid or private visibility on PUT
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: visit owned by another actor
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/placesAPI catalog

ListRatedPlaceVisits

contentListRatedPlaceVisits

Security: Guest (subject to sharing policy) or BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`scope`	query	string
`ownerId`	query	string
`cursor`	query	string
`standalone`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: unknown/duplicate scope/cursor/owner/standalone invalid
401 AUTH_REQUIRED: mine without actor; AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/discussions/place/{targetId}API catalog

ReadPlaceDiscussion

contentReadPlaceDiscussion

Security: Guest (subject to sharing policy) or BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`targetId` · required	path	string
`before`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: before/unknown/duplicate query
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: invalid target/photo access lost
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/discussions/place/{targetId}/commentAPI catalog

CommentOnPlaceDiscussion

contentCommentOnPlaceDiscussion

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`targetId` · required	path	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: request UUID/action fields invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: target lost or existing remove comment not owned/exact target
409 IDEMPOTENCY_CONFLICT: actor/request UUID reused for changed action/content
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
422 CONTENT_NOT_ALLOWED: comment text denied
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/discussions/place/{targetId}/reactionAPI catalog

ReactToPlaceDiscussion

contentReactToPlaceDiscussion

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`targetId` · required	path	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: request UUID/action fields invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: target lost or existing remove comment not owned/exact target
409 IDEMPOTENCY_CONFLICT: actor/request UUID reused for changed action/content
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/discussions/place/{targetId}/removeAPI catalog

RemoveCommentFromPlaceDiscussion

contentRemoveCommentFromPlaceDiscussion

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`targetId` · required	path	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: request UUID/action fields invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: target lost or existing remove comment not owned/exact target
409 IDEMPOTENCY_CONFLICT: actor/request UUID reused for changed action/content
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/discussions/place/{targetId}/reportAPI catalog

ReportCommentInPlaceDiscussion

contentReportCommentInPlaceDiscussion

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`targetId` · required	path	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: request UUID/action fields invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: target lost or existing remove comment not owned/exact target
409 IDEMPOTENCY_CONFLICT: actor/request UUID reused for changed action/content
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/discussions/photo/{targetId}API catalog

ReadPhotoDiscussion

contentReadPhotoDiscussion

Security: Guest (subject to sharing policy) or BearerAuth or PublicationLink or BearerAuth + PublicationLink. Current domain permissions still apply.

Parameters

Name	Location	Type
`targetId` · required	path	string
`before`	query	string
`X-PhotoTracker-Link`	header	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: before/unknown/duplicate query
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: invalid target/photo access lost
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/discussions/photo/{targetId}/commentAPI catalog

CommentOnPhotoDiscussion

contentCommentOnPhotoDiscussion

Security: BearerAuth or BearerAuth + PublicationLink or BearerAuth + LegacyPublicationLinkQuery. Current domain permissions still apply.

Parameters

Name	Location	Type
`targetId` · required	path	string
`X-PhotoTracker-Link`	header	string
`token`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: request UUID/action fields invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: target lost or existing remove comment not owned/exact target
409 IDEMPOTENCY_CONFLICT: actor/request UUID reused for changed action/content
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
422 CONTENT_NOT_ALLOWED: comment text denied
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/discussions/photo/{targetId}/reactionAPI catalog

ReactToPhotoDiscussion

contentReactToPhotoDiscussion

Security: BearerAuth or BearerAuth + PublicationLink or BearerAuth + LegacyPublicationLinkQuery. Current domain permissions still apply.

Parameters

Name	Location	Type
`targetId` · required	path	string
`X-PhotoTracker-Link`	header	string
`token`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: request UUID/action fields invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: target lost or existing remove comment not owned/exact target
409 IDEMPOTENCY_CONFLICT: actor/request UUID reused for changed action/content
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/discussions/photo/{targetId}/removeAPI catalog

RemoveCommentFromPhotoDiscussion

contentRemoveCommentFromPhotoDiscussion

Security: BearerAuth or BearerAuth + PublicationLink or BearerAuth + LegacyPublicationLinkQuery. Current domain permissions still apply.

Parameters

Name	Location	Type
`targetId` · required	path	string
`X-PhotoTracker-Link`	header	string
`token`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: request UUID/action fields invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: target lost or existing remove comment not owned/exact target
409 IDEMPOTENCY_CONFLICT: actor/request UUID reused for changed action/content
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/discussions/photo/{targetId}/reportAPI catalog

ReportCommentInPhotoDiscussion

contentReportCommentInPhotoDiscussion

Security: BearerAuth or BearerAuth + PublicationLink or BearerAuth + LegacyPublicationLinkQuery. Current domain permissions still apply.

Parameters

Name	Location	Type
`targetId` · required	path	string
`X-PhotoTracker-Link`	header	string
`token`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: request UUID/action fields invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: target lost or existing remove comment not owned/exact target
409 IDEMPOTENCY_CONFLICT: actor/request UUID reused for changed action/content
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/reportsAPI catalog

CreatePublicReport

contentCreatePublicReport

Parameters

Name	Location	Type
`token`	query	string
`X-PhotoTracker-Link`	header	string

Responses

200 Successful implemented response
201 Successful implemented response
400 INVALID_REQUEST: one strict UUID target+bounded reason+optional key invalid; INVALID_REQUEST: JSON malformed
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: target inaccessible/missing or receipt identity gone
409 IDEMPOTENCY_CONFLICT: same actor/key target/reason changed
413 LIMIT_EXCEEDED: body exceeds route byte limit
415 INVALID_REQUEST: Content-Type does not start application/json
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/reportsAPI catalog

ListPublicReports

contentListPublicReports

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful implemented response
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: detail not owned/missing; no anonymous read
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/reports/{reportId}API catalog

ReadPublicReport

contentReadPublicReport

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`reportId` · required	path	string

Responses

200 Successful implemented response
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: detail not owned/missing; no anonymous read
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/activityAPI catalog

List current authorized walk/photo activity

contentListActivity

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`before`	query	string

Responses

200 Up to20 current authorized activity items; plain row-sequence cursor
400 INVALID_INPUT: invalid Number-coerced before or unknown query key
401 AUTH_REQUIRED: current bearer required
500 INTERNAL_ERROR: unmapped failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/auth/apple/challengeAPI catalog

Issue a one-use Apple challenge valid for 300 seconds

identityCreateAppleChallenge

Security: Guest / no credential declared. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.
503 AUTH_NOT_CONFIGURED

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/auth/appleAPI catalog

Exchange native or web Apple authorization

identityExchangeApple

Security: Guest / no credential declared. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_REQUEST; VERIFIED_EMAIL_REQUIRED
401 AUTH_CHALLENGE_EXPIRED; APPLE_REJECTED
409 EMAIL_IN_USE; IDEMPOTENCY_CONFLICT
410 ACCOUNT_DELETED
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.
503 AUTH_NOT_CONFIGURED; APPLE_UNAVAILABLE

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/auth/email/requestAPI catalog

Send a six-digit, ten-minute, one-use email code

identityRequestEmailCode

Security: Guest / no credential declared. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_EMAIL
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
429 EMAIL_RATE_LIMIT
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.
503 EMAIL_UNAVAILABLE

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/auth/email/verifyAPI catalog

Verify the exact email challenge/code with at most five durable attempts

identityVerifyEmailCode

Security: Guest / no credential declared. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 JSON object/body parsing or media-type/byte-limit failure.
401 EMAIL_CODE_INVALID
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.
503 EMAIL_UNAVAILABLE

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/auth/reviewAPI catalog

Configured review account sign-in

identityReviewLogin

Security: Guest / no credential declared. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_REQUEST
401 INVALID_CREDENTIALS
404 NOT_FOUND
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
429 TOO_MANY_ATTEMPTS
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.
503 AUTH_NOT_CONFIGURED

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/auth/refreshAPI catalog

Rotate session using refresh token, with exact durable old-hash receipt replay

identityRefreshSession

Security: Guest / no credential declared. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_REQUEST
401 AUTH_REQUIRED
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.
503 AUTH_NOT_CONFIGURED

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/auth/logoutAPI catalog

Revoke the exact verified current session and optionally delete one owned notification device

identityLogout

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 JSON object/body parsing or media-type/byte-limit failure.
401 AUTH_REQUIRED
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.
503 AUTH_NOT_CONFIGURED

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/configAPI catalog

Read configuration and account-specific capabilities

identityConfiguration

Security: Guest (subject to sharing policy) or BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/maps/tokenAPI catalog

Return a thirty-minute ES256 MapKit token

identityMapToken

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.
503 MAP_UNAVAILABLE

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/meAPI catalog

Read the current public user profile, with legacy name/displayName fields and no email

identityMe

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

PATCH/v1/meAPI catalog

Update handle, display name and searchable setting

identityUpdateProfile

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_REQUEST
401 AUTH_REQUIRED
409 HANDLE_TAKEN
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
422 CONTENT_NOT_ALLOWED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/meAPI catalog

Update handle, display name and searchable setting

identityUpdateProfileLegacy

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_REQUEST
401 AUTH_REQUIRED
409 HANDLE_TAKEN
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
422 CONTENT_NOT_ALLOWED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

DELETE/v1/meAPI catalog

Accept irreversible account deletion with confirm DELETE and optional receipt capability

identityDeleteAccount

Security: BearerAuth. Current domain permissions still apply.

Responses

202 Deletion accepted; asynchronous cleanup remains pending.
400 CONFIRM_REQUIRED; INVALID_REQUEST
401 AUTH_REQUIRED
410 ACCOUNT_DELETED
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/account-deletion/statusAPI catalog

Read own deletion progress using Authorization: Deletion <43-character capability>

identityDeletionStatus

Security: DeletionReceipt. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/peopleAPI catalog

Search up to 25 searchable non-deleted other accounts, excluding either-direction blocks when an actor is present

identitySearchPeople

Security: Guest (subject to sharing policy) or BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`q`	query	string

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/people/{personId}API catalog

Read searchable profile or own profile and at most 100 currently readable publications

identityPersonProfile

Security: Guest (subject to sharing policy) or BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`personId` · required	path	string

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/follows/followersAPI catalog

List at most 500 non-deleted accounts ordered by handle, excluding self

identityListFollowers

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/follows/followingAPI catalog

List at most 500 non-deleted accounts ordered by handle, excluding self

identityListFollowing

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/follows/blockedAPI catalog

List at most 500 non-deleted accounts ordered by handle, excluding self

identityListBlocked

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/follows/requestsAPI catalog

List at most 500 non-deleted accounts ordered by handle, excluding self

identityListRequests

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/follows/{personId}/requestAPI catalog

Perform request on current social relationship

identityFollowRequest

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`personId` · required	path	IdentityUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/follows/{personId}/approveAPI catalog

Perform approve on current social relationship

identityFollowApprove

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`personId` · required	path	IdentityUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/follows/{personId}/declineAPI catalog

Perform decline on current social relationship

identityFollowDecline

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`personId` · required	path	IdentityUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/follows/{personId}/cancelAPI catalog

Perform cancel on current social relationship

identityFollowCancel

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`personId` · required	path	IdentityUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/follows/{personId}/removeAPI catalog

Perform remove on current social relationship

identityFollowRemove

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`personId` · required	path	IdentityUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/follows/{personId}/unfollowAPI catalog

Perform unfollow on current social relationship

identityFollowUnfollow

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`personId` · required	path	IdentityUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/follows/{personId}/blockAPI catalog

Perform block on current social relationship

identityFollowBlock

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`personId` · required	path	IdentityUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/follows/{personId}/unblockAPI catalog

Perform unblock on current social relationship

identityFollowUnblock

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`personId` · required	path	IdentityUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/messaging/countsAPI catalog

Current authorized unread messages/conversations and pending requests, optionally including trusted current plan counts

messagingCounts

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/messaging/peopleAPI catalog

Discover at most 50 eligible peers with current searchable/follow/block visibility, ranked approved follows first

messagingSearchPeople

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`q`	query	string
`limit`	query	string
`cursor`	query	schema

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT; INVALID_CURSOR
401 AUTH_REQUIRED
404 NOT_FOUND
410 CURSOR_EXPIRED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/messaging/people/{personId}API catalog

Read current eligible peer profile and server-computed open/send/request action

messagingPersonProfile

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`personId` · required	path	MessagingUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/conversationsAPI catalog

List current readable conversations plus own neutral outgoing requests

messagingListConversations

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`limit`	query	string
`cursor`	query	string

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT; INVALID_CURSOR
401 AUTH_REQUIRED
404 NOT_FOUND
410 CURSOR_EXPIRED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/message-requestsAPI catalog

List current visible, unexpired invitations, or select one with conversationId

messagingListRequests

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`limit`	query	string
`cursor`	query	string
`conversationId`	query	MessagingUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT; INVALID_CURSOR
401 AUTH_REQUIRED
404 NOT_FOUND
410 CURSOR_EXPIRED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/conversations/directAPI catalog

Create/open direct conversation and send introduction

messagingCreateDirect

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
201 New durable acknowledgment.
400 INVALID_INPUT
401 AUTH_REQUIRED
403 REQUEST_PENDING; CONTACT_NOT_ALLOWED
404 NOT_FOUND
409 IDEMPOTENCY_CONFLICT; CONVERSATION_CLOSED
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
422 CONTENT_NOT_ALLOWED
429 RATE_LIMITED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/conversations/groupAPI catalog

Create a group with one to nineteen distinct eligible invitees

messagingCreateGroup

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
201 New durable acknowledgment.
400 INVALID_INPUT
401 AUTH_REQUIRED
403 REQUEST_PENDING; CONTACT_NOT_ALLOWED
404 NOT_FOUND
409 IDEMPOTENCY_CONFLICT; GROUP_FULL; INVITATION_CHANGED
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
422 CONTENT_NOT_ALLOWED
429 RATE_LIMITED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/message-requests/{conversationId}/respondAPI catalog

Accept or decline own current invitation version

messagingRespondToRequest

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`conversationId` · required	path	MessagingUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND
409 IDEMPOTENCY_CONFLICT; INVITATION_CHANGED
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/conversations/{conversationId}API catalog

Read a current authorized detail snapshot

messagingConversationDetail

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`conversationId` · required	path	MessagingUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

PATCH/v1/conversations/{conversationId}API catalog

Rename an open group as its current owner with expectedVersion

messagingRenameGroup

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`conversationId` · required	path	MessagingUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND
409 VERSION_CHANGED; CONVERSATION_CLOSED; IDEMPOTENCY_CONFLICT
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
422 CONTENT_NOT_ALLOWED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/conversations/{conversationId}/viewAPI catalog

Read detail and newest history in one current identity/authorization snapshot

messagingConversationView

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`conversationId` · required	path	MessagingUuid
`limit`	query	string
`planCards`	query	string

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.
503 PLAN_CARDS_UNAVAILABLE

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/conversations/{conversationId}/messagesAPI catalog

Read older snapshot history or forward updates

messagingHistory

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`conversationId` · required	path	MessagingUuid
`limit`	query	string
`cursor`	query	string
`afterSeq`	query	string
`planCards`	query	string

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT; INVALID_CURSOR
401 AUTH_REQUIRED
404 NOT_FOUND
410 CURSOR_EXPIRED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.
503 PLAN_CARDS_UNAVAILABLE

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/conversations/{conversationId}/messagesAPI catalog

Send text or a currently accessible existing shared walk

messagingSendMessage

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`conversationId` · required	path	MessagingUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
201 New durable acknowledgment.
400 INVALID_INPUT
401 AUTH_REQUIRED
403 REQUEST_PENDING; CONTACT_NOT_ALLOWED
404 NOT_FOUND
409 IDEMPOTENCY_CONFLICT; CONVERSATION_CLOSED
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
422 CONTENT_NOT_ALLOWED
429 RATE_LIMITED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

PUT/v1/conversations/{conversationId}/readAPI catalog

Advance own read boundary monotonically to the actual message sequence no greater than throughSeq

messagingMarkRead

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`conversationId` · required	path	MessagingUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND
409 IDEMPOTENCY_CONFLICT
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/conversations/{conversationId}/invitationsAPI catalog

Invite eligible people as current group owner; expectedVersion and current reserved-member/contact limits apply

messagingInviteMembers

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`conversationId` · required	path	MessagingUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
403 CONTACT_NOT_ALLOWED
404 NOT_FOUND
409 VERSION_CHANGED; INVITATION_CHANGED; GROUP_FULL; CONVERSATION_CLOSED; IDEMPOTENCY_CONFLICT
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
429 RATE_LIMITED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/conversations/{conversationId}/members/{memberId}/removeAPI catalog

Remove another active/invited group member as current owner, with expectedVersion; return removed true and current version

messagingRemoveMember

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`conversationId` · required	path	MessagingUuid
`memberId` · required	path	MessagingUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND
409 VERSION_CHANGED; INVITATION_CHANGED; CONVERSATION_CLOSED; IDEMPOTENCY_CONFLICT
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/conversations/{conversationId}/leaveAPI catalog

Leave a group as a current non-owner member

messagingLeaveGroup

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`conversationId` · required	path	MessagingUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND
409 OWNER_MUST_END_GROUP; IDEMPOTENCY_CONFLICT
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/conversations/{conversationId}/closeAPI catalog

Close a group as current owner with expectedVersion; revoke pending invites and return closed state/current version

messagingCloseGroup

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`conversationId` · required	path	MessagingUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND
409 VERSION_CHANGED; CONVERSATION_CLOSED; IDEMPOTENCY_CONFLICT
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/message-reports/previewAPI catalog

Build exact current server-selected message or group-invitation evidence

messagingPreviewReport

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/message-reportsAPI catalog

Submit exact preview target, normalized reason, request UUID and preview token

messagingSubmitReport

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
201 New durable acknowledgment.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND
409 IDEMPOTENCY_CONFLICT; REPORT_CHANGED
410 REPORT_PREVIEW_EXPIRED
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
429 RATE_LIMITED
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/message-reports/{reportId}API catalog

Recover only own immutable content-free report acknowledgment

messagingReportReceipt

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`reportId` · required	path	MessagingUuid

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/notifications/followsAPI catalog

Read at most fifty current incoming follow requests and total pending count with configured delivery availability

identityFollowNotifications

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
404 NOT_FOUND when notification handler or requested device operation is unavailable.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/notifications/seenAPI catalog

Mark only current recipient notification IDs seen

identityMarkNotificationsSeen

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND when notification handler or requested device operation is unavailable.
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/notifications/settingsAPI catalog

Read notification settings; missing row defaults both settings true

identityNotificationSettings

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
404 NOT_FOUND when notification handler or requested device operation is unavailable.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

PUT/v1/notifications/settingsAPI catalog

Set both boolean email/push settings; unknown properties rejected

identityUpdateNotificationSettings

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND when notification handler or requested device operation is unavailable.
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/notifications/devicesAPI catalog

Register/reassign one physical push token atomically to current account; token normalized lowercase and configured push/environment required

identityRegisterNotificationDevice

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
400 INVALID_INPUT
401 AUTH_REQUIRED
404 NOT_FOUND when notification handler or requested device operation is unavailable.
413 JSON object/body parsing or media-type/byte-limit failure.
415 JSON object/body parsing or media-type/byte-limit failure.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.
503 PUSH_UNAVAILABLE

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

DELETE/v1/notifications/devices/{deviceId}API catalog

Idempotently remove only own device ID; body and query ignored

identityRemoveNotificationDevice

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`deviceId` · required	path	string

Responses

200 Successful response; for creation/send/report this includes the identical acknowledged replay.
401 AUTH_REQUIRED
404 NOT_FOUND when notification handler or requested device operation is unavailable.
500 Unexpected provider/runtime failure; sanitized INTERNAL_ERROR envelope.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/integrations/clientsAPI catalog

identityListIntegrationClients

identityListIntegrationClients

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Implemented response
400 Static error; credential and provider details are never returned
401 Static error; credential and provider details are never returned
500 Static error; credential and provider details are never returned
503 Static error; credential and provider details are never returned

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/integrations/grantsAPI catalog

identityListIntegrationGrants

identityListIntegrationGrants

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`limit`	query	string
`cursor`	query	string

Responses

200 Implemented response
400 Static error; credential and provider details are never returned
401 Static error; credential and provider details are never returned
500 Static error; credential and provider details are never returned
503 Static error; credential and provider details are never returned

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/integrations/grantsAPI catalog

identityCreateIntegrationGrant

identityCreateIntegrationGrant

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Implemented response
201 Implemented response
400 Static error; credential and provider details are never returned
401 Static error; credential and provider details are never returned
409 Static error; credential and provider details are never returned
413 Static error; credential and provider details are never returned
415 Static error; credential and provider details are never returned
429 Static error; credential and provider details are never returned
500 Static error; credential and provider details are never returned
503 Static error; credential and provider details are never returned

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/integrations/grants/{grantId}/revokeAPI catalog

identityRevokeIntegrationGrant

identityRevokeIntegrationGrant

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`grantId` · required	path	string

Responses

200 Implemented response
400 Static error; credential and provider details are never returned
401 Static error; credential and provider details are never returned
404 Concrete revocation path outside admitted UUID-shaped route; authority is checked before this fallback
409 Static error; credential and provider details are never returned
413 Static error; credential and provider details are never returned
415 Static error; credential and provider details are never returned
500 Static error; credential and provider details are never returned
503 Static error; credential and provider details are never returned

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/integrations/grants/revoke-allAPI catalog

identityRevokeAllIntegrationGrants

identityRevokeAllIntegrationGrants

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Implemented response
400 Static error; credential and provider details are never returned
401 Static error; credential and provider details are never returned
409 Static error; credential and provider details are never returned
413 Static error; credential and provider details are never returned
415 Static error; credential and provider details are never returned
500 Static error; credential and provider details are never returned
503 Static error; credential and provider details are never returned

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/integrations/refreshAPI catalog

integrationRefreshPersonalGrant

integrationRefreshPersonalGrant

Security: IntegrationRefresh. Current domain permissions still apply.

Responses

200 Implemented response
400 Static error; credential and provider details are never returned
401 Static error; credential and provider details are never returned
409 Static error; credential and provider details are never returned
413 Static error; credential and provider details are never returned
415 Static error; credential and provider details are never returned
429 Static error; credential and provider details are never returned
500 Static error; credential and provider details are never returned
503 Integration schema unavailable

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v2/publications/{publicationId}CLI · MCP read

Integration ReadPublication

integrationReadPublication

Security: IntegrationBearer. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string

Responses

200 Successful implemented response
400 Invalid versioned integration path or query metadata.
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: missing/restricted/cancelled/deleted owner/blocked/unauthorized/current session unavailable
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v2/publications/{publicationId}/accessCLI · MCP read

Integration ReadPublicationAccess

integrationReadPublicationAccess

Security: IntegrationBearer. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string

Responses

200 Successful implemented response
400 Invalid versioned integration path or query metadata.
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
404 NOT_FOUND: missing/restricted/cancelled/deleted owner/blocked/unauthorized/current session unavailable
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v2/library/publicationsCLI · MCP read

Integration ListOwnedPublications

integrationListOwnedPublications

Security: IntegrationBearer. Current domain permissions still apply.

Parameters

Name	Location	Type
`limit`	query	string
`cursor`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: unknown/duplicate query field or invalid limit/filter; INVALID_CURSOR: signature/scope/shape invalid
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
410 CURSOR_EXPIRED: older than15min or >60s in future
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v2/library/receivedCLI · MCP read

Integration ListReceivedPublications

integrationListReceivedPublications

Security: IntegrationBearer. Current domain permissions still apply.

Parameters

Name	Location	Type
`limit`	query	string
`cursor`	query	string
`authors`	query	string
`saved`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: unknown/duplicate query field or invalid limit/filter; INVALID_CURSOR: signature/scope/shape invalid
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
410 CURSOR_EXPIRED: older than15min or >60s in future
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v2/library/peopleCLI · MCP read

Integration ListReceivedAuthors

integrationListReceivedAuthors

Security: IntegrationBearer. Current domain permissions still apply.

Parameters

Name	Location	Type
`query`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: unknown/duplicate query or query length>100
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v2/savedCLI · MCP read

Integration ListSavedPublications

integrationListSavedPublications

Security: IntegrationBearer. Current domain permissions still apply.

Parameters

Name	Location	Type
`limit`	query	string
`cursor`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: unknown/duplicate query field or invalid limit/filter; INVALID_CURSOR: signature/scope/shape invalid
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
410 CURSOR_EXPIRED: older than15min or >60s in future
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v2/exploreCLI · MCP read

Integration ExplorePublications

integrationExplorePublications

Security: IntegrationBearer. Current domain permissions still apply.

Parameters

Name	Location	Type
`sort`	query	string
`limit`	query	string
`bbox`	query	string
`cursor`	query	string
`maxDistanceMeters`	query	string
`maxDurationSeconds`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: unknown/duplicate query field or invalid limit/filter; INVALID_CURSOR: signature/scope/shape invalid
401 AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
410 CURSOR_EXPIRED: older than15min or >60s in future
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v2/placesCLI · MCP read

Integration ListRatedPlaceVisits

integrationListRatedPlaceVisits

Security: IntegrationBearer. Current domain permissions still apply.

Parameters

Name	Location	Type
`scope`	query	string
`ownerId`	query	string
`cursor`	query	string
`standalone`	query	string

Responses

200 Successful implemented response
400 INVALID_REQUEST: unknown/duplicate scope/cursor/owner/standalone invalid
401 AUTH_REQUIRED: mine without actor; AUTH_REQUIRED: required bearer absent, or optional/required supplied bearer malformed/expired/revoked; production authenticate hook
500 INTERNAL_ERROR: unmapped internal failure; generic public message

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/planning/sources/features.jsonAPI catalog

GetFeatureSourceAlias

planningGetFeatureSourceAlias

Security: Guest / no credential declared. Current domain permissions still apply.

Responses

307 Empty redirect to current immutable content-addressed catalog
404 Empty body for any query or unsupported/current-hash mismatch path

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/v1/planning/sources/features.jsonAPI catalog

HeadFeatureSourceAlias

planningHeadFeatureSourceAlias

Security: Guest / no credential declared. Current domain permissions still apply.

Responses

307 Empty redirect to current immutable content-addressed catalog
404 Empty body for any query or unsupported/current-hash mismatch path

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/planning/sources/{sha256}.jsonAPI catalog

GetFeatureSource

planningGetFeatureSource

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`sha256` · required	path	string
`If-None-Match`	header	string

Responses

200 Exact immutable public derivative catalog
304 Empty body; exact If-None-Match match
404 Empty body for any query or unsupported/current-hash mismatch path

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/v1/planning/sources/{sha256}.jsonAPI catalog

HeadFeatureSource

planningHeadFeatureSource

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`sha256` · required	path	string
`If-None-Match`	header	string

Responses

200 Exact immutable public derivative catalog; HEAD has no body
304 Empty body; exact If-None-Match match
404 Empty body for any query or unsupported/current-hash mismatch path

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/eventsAPI catalog

OpenChangeEvents

planningOpenChangeEvents

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`liveId`	query	array

Responses

200 Successful EventStream
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.
503 Empty body; maximum stream clients reached

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/live-walksAPI catalog

StartLiveWalk

planningStartLiveWalk

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful LiveStartReceipt
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
413 Actual domain errors or finite shared global provider/DB exception classifier.
415 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/live-walksAPI catalog

ListLiveWalks

planningListLiveWalks

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`ownerId`	query	string

Responses

200 Successful LivePage
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/live-walks/{liveId}API catalog

GetLiveWalk

planningGetLiveWalk

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`liveId` · required	path	PlanningUUID

Responses

200 Successful LiveDetail
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/live-walks/{liveId}/pointsAPI catalog

AppendLivePoints

planningAppendLivePoints

Security: BearerAuth or LiveWriter. Current domain permissions still apply.

Parameters

Name	Location	Type
`liveId` · required	path	PlanningUUID

Responses

200 Successful LivePointsReceipt
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
413 Actual domain errors or finite shared global provider/DB exception classifier.
415 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/live-walks/{liveId}/endAPI catalog

EndLiveWalk

planningEndLiveWalk

Security: BearerAuth or LiveWriter. Current domain permissions still apply.

Parameters

Name	Location	Type
`liveId` · required	path	PlanningUUID

Responses

200 Successful LiveEndReceipt
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
413 Actual domain errors or finite shared global provider/DB exception classifier.
415 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

PUT/v1/live-walks/{liveId}/photos/{photoId}API catalog

UploadLivePhoto

planningUploadLivePhoto

Security: BearerAuth or LiveWriter. Current domain permissions still apply.

Parameters

Name	Location	Type
`liveId` · required	path	PlanningUUID
`photoId` · required	path	PlanningStopId
`takenAt`	query	string
`lat`	query	string
`lng`	query	string

Responses

200 Successful LivePhotoReceipt
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
413 Actual domain errors or finite shared global provider/DB exception classifier.
422 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.
503 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/live-walks/{liveId}/photos/{photoId}API catalog

GetLivePhoto

planningGetLivePhoto

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`liveId` · required	path	PlanningUUID
`photoId` · required	path	PlanningStopId

Responses

200 Successful LivePhoto
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.
503 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/route-requestAPI catalog

InterpretRouteRequest

planningInterpretRouteRequest

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful Interpretation
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
413 Actual domain errors or finite shared global provider/DB exception classifier.
415 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.
503 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/planning/intakesAPI catalog

AdmitWalkingIntent

planningAdmitWalkingIntent

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful Intake
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.
504 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/planning/snapsAPI catalog

SnapWalkingStops

planningSnapWalkingStops

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful Snaps
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.
504 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/planning/routesAPI catalog

CalculateWalkingRoute

planningCalculateWalkingRoute

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`X-WalkPic-Route-Profiles`	header	string

Responses

200 Successful Preparation
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.
504 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/planning/routes/cancelAPI catalog

CancelWalkingCalculation

planningCancelWalkingCalculation

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful Cancelled
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.
504 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/planning/preparations/{preparationId}API catalog

GetWalkingPreparation

planningGetWalkingPreparation

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`preparationId` · required	path	PlanningUUID
`X-WalkPic-Route-Profiles`	header	string

Responses

200 Successful Preparation
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.
504 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/route-plansAPI catalog

ListReusableRoutes

planningListReusableRoutes

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`scope`	query	string
`limit`	query	string
`cursor`	query	string

Responses

200 Successful RoutePlanPage
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/route-plansAPI catalog

CreateReusableRoute

planningCreateReusableRoute

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful RoutePlanReceipt
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
413 Actual domain errors or finite shared global provider/DB exception classifier.
415 Actual domain errors or finite shared global provider/DB exception classifier.
422 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/route-plans/{routePlanId}API catalog

GetReusableRoute

planningGetReusableRoute

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`routePlanId` · required	path	PlanningUUID

Responses

200 Successful RoutePlanDetail
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/route-plans/{routePlanId}/accessAPI catalog

GetReusableRouteAccess

planningGetReusableRouteAccess

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`routePlanId` · required	path	PlanningUUID

Responses

200 Successful RoutePlanAccess
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/route-plans/{routePlanId}/restrictAPI catalog

RestrictReusableRoute

planningRestrictReusableRoute

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`routePlanId` · required	path	PlanningUUID

Responses

200 Successful RoutePlanReceipt
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
413 Actual domain errors or finite shared global provider/DB exception classifier.
415 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/plansAPI catalog

ListOutings

planningListOutings

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`scope`	query	string
`limit`	query	string
`cursor`	query	string
`bbox`	query	string
`window`	query	string
`from`	query	PlanningUtcInstant
`until`	query	PlanningUtcInstant

Responses

200 Successful PlanPage
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/plansAPI catalog

CreateOuting

planningCreateOuting

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful PlanRevisionReceipt
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/plans/{planId}API catalog

GetOuting

planningGetOuting

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID
`revisionId`	query	PlanningUUID

Responses

200 Successful PlanDetail
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

PATCH/v1/plans/{planId}API catalog

PatchOuting

planningPatchOuting

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID

Responses

200 Successful PlanRevisionReceipt
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

PATCH/v1/plans/{planId}/metadataAPI catalog

EditOutingMetadata

planningEditOutingMetadata

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID

Responses

200 Successful PlanRevisionReceipt
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

PATCH/v1/plans/{planId}/rescheduleAPI catalog

RescheduleOuting

planningRescheduleOuting

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID

Responses

200 Successful PlanRevisionReceipt
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/plans/{planId}/closeAPI catalog

CloseOuting

planningCloseOuting

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID

Responses

200 Successful PlanCloseReceipt
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/plans/{planId}/join-requestsAPI catalog

ListOutingJoinRequests

planningListOutingJoinRequests

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID
`limit`	query	string
`cursor`	query	string

Responses

200 Successful JoinRequestPage
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/plans/{planId}/join-requestsAPI catalog

RequestOutingJoin

planningRequestOutingJoin

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID

Responses

200 Successful AttendanceReceipt
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/plans/{planId}/join-requests/{requesterId}/respondAPI catalog

RespondOutingJoin

planningRespondOutingJoin

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID
`requesterId` · required	path	PlanningUUID

Responses

200 Successful AttendanceReceipt
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/plans/{planId}/attendanceAPI catalog

UpdateOutingAttendance

planningUpdateOutingAttendance

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID

Responses

200 Successful AttendanceReceipt
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/plans/{planId}/attendees/{attendeeId}/removeAPI catalog

RemoveOutingAttendee

planningRemoveOutingAttendee

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID
`attendeeId` · required	path	PlanningUUID

Responses

200 Successful AttendanceReceipt
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/plan-chatsAPI catalog

ListOutingChats

planningListOutingChats

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`limit`	query	string
`cursor`	query	string

Responses

200 Successful InboxPage
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/plan-chats/countsAPI catalog

GetOutingChatCounts

planningGetOutingChatCounts

Security: BearerAuth. Current domain permissions still apply.

Responses

200 Successful InboxCounts
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/plans/{planId}/chat/viewAPI catalog

GetOutingChatView

planningGetOutingChatView

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID
`limit`	query	string
`cursor`	query	string
`planCards`	query	string

Responses

200 Successful ChatView
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/plans/{planId}/chatAPI catalog

GetOutingChat

planningGetOutingChat

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID

Responses

200 Successful ChatDetail
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/plans/{planId}/chat/messagesAPI catalog

GetOutingChatMessages

planningGetOutingChatMessages

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID
`limit`	query	string
`cursor`	query	string
`afterSeq`	query	string
`planCards`	query	string

Responses

200 Successful ChatHistory
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/plans/{planId}/chat/messagesAPI catalog

SendOutingMessage

planningSendOutingMessage

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID

Responses

200 Successful MessageReceipt
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

PUT/v1/plans/{planId}/chat/readAPI catalog

ReadOutingMessages

planningReadOutingMessages

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID

Responses

200 Successful ChatReadReceipt
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/plans/{planId}/message-reportsAPI catalog

ReportOutingMessages

planningReportOutingMessages

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID

Responses

200 Successful ReportReceipt
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/plans/{planId}/message-reports/previewAPI catalog

PreviewOutingMessageReport

planningPreviewOutingMessageReport

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID

Responses

200 Successful ReportPreview
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/plans/{planId}/chat/plan-cardsAPI catalog

SendCardToOuting

planningSendCardToOuting

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID

Responses

200 Successful CardReceipt
201 Successful CardReceipt
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/plans/{planId}/chat/plan-cards/{messageId}API catalog

GetOutingCard

planningGetOutingCard

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID
`messageId` · required	path	PlanningUUID

Responses

200 Successful CardReference
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/plans/{planId}/chat/plan-cards/{messageId}/previewAPI catalog

PreviewOutingCard

planningPreviewOutingCard

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`planId` · required	path	PlanningUUID
`messageId` · required	path	PlanningUUID
`revisionId`	query	PlanningUUID
`review`	query	string

Responses

200 Successful CardPreview
400 Walking/planned static sanitized errors.
401 Walking/planned static sanitized errors.
404 Walking/planned static sanitized errors.
409 Walking/planned static sanitized errors.
410 Walking/planned static sanitized errors.
413 Walking/planned static sanitized errors.
415 Walking/planned static sanitized errors.
422 Walking/planned static sanitized errors.
429 Walking/planned static sanitized errors.
503 Walking/planned static sanitized errors.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

POST/v1/conversations/{conversationId}/plan-cardsAPI catalog

SendCardToConversation

planningSendCardToConversation

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`conversationId` · required	path	PlanningUUID

Responses

200 Successful CardReceipt
201 Successful CardReceipt
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
413 Actual domain errors or finite shared global provider/DB exception classifier.
415 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.
503 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/conversations/{conversationId}/plan-cards/{messageId}API catalog

GetConversationCard

planningGetConversationCard

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`conversationId` · required	path	PlanningUUID
`messageId` · required	path	PlanningUUID

Responses

200 Successful CardReference
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.
503 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/v1/conversations/{conversationId}/plan-cards/{messageId}/previewAPI catalog

PreviewConversationCard

planningPreviewConversationCard

Security: BearerAuth. Current domain permissions still apply.

Parameters

Name	Location	Type
`conversationId` · required	path	PlanningUUID
`messageId` · required	path	PlanningUUID
`revisionId`	query	PlanningUUID
`review`	query	string

Responses

200 Successful CardPreview
400 Actual domain errors or finite shared global provider/DB exception classifier.
401 Actual domain errors or finite shared global provider/DB exception classifier.
403 Actual domain errors or finite shared global provider/DB exception classifier.
404 Actual domain errors or finite shared global provider/DB exception classifier.
409 Actual domain errors or finite shared global provider/DB exception classifier.
410 Actual domain errors or finite shared global provider/DB exception classifier.
429 Actual domain errors or finite shared global provider/DB exception classifier.
500 Actual domain errors or finite shared global provider/DB exception classifier.
503 Actual domain errors or finite shared global provider/DB exception classifier.

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/healthzAPI catalog

ReadHealth

transportReadHealth

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string

Responses

200 Successful transport response
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/API catalog

ReadRootViewer

transportReadRootViewer

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/API catalog

HeadRootViewer

transportHeadRootViewer

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/p/{publicationId}API catalog

ReadPublicationViewer

transportReadPublicationViewer

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/p/{publicationId}API catalog

HeadPublicationViewer

transportHeadPublicationViewer

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`publicationId` · required	path	string
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/main.dart.jsAPI catalog

ReadMainDartJs

transportReadMainDartJs

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/main.dart.jsAPI catalog

HeadMainDartJs

transportHeadMainDartJs

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/flutter.jsAPI catalog

ReadFlutterJs

transportReadFlutterJs

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/flutter.jsAPI catalog

HeadFlutterJs

transportHeadFlutterJs

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/flutter_bootstrap.jsAPI catalog

ReadFlutterBootstrapJs

transportReadFlutterBootstrapJs

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/flutter_bootstrap.jsAPI catalog

HeadFlutterBootstrapJs

transportHeadFlutterBootstrapJs

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/walkpic_map.jsAPI catalog

ReadWalkpicMapJs

transportReadWalkpicMapJs

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/walkpic_map.jsAPI catalog

HeadWalkpicMapJs

transportHeadWalkpicMapJs

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/phototracker_map.jsAPI catalog

ReadPhototrackerMapJs

transportReadPhototrackerMapJs

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/phototracker_map.jsAPI catalog

HeadPhototrackerMapJs

transportHeadPhototrackerMapJs

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/manifest.jsonAPI catalog

ReadManifestJson

transportReadManifestJson

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/manifest.jsonAPI catalog

HeadManifestJson

transportHeadManifestJson

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/favicon.pngAPI catalog

ReadFaviconPng

transportReadFaviconPng

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/favicon.pngAPI catalog

HeadFaviconPng

transportHeadFaviconPng

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/favicon.svgAPI catalog

ReadFaviconSvg

transportReadFaviconSvg

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/favicon.svgAPI catalog

HeadFaviconSvg

transportHeadFaviconSvg

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/assets/{assetPath}API catalog

ReadAssetsAsset

transportReadAssetsAsset

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`assetPath` · required	path	string
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/assets/{assetPath}API catalog

HeadAssetsAsset

transportHeadAssetsAsset

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`assetPath` · required	path	string
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/canvaskit/{assetPath}API catalog

ReadCanvaskitAsset

transportReadCanvaskitAsset

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`assetPath` · required	path	string
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/canvaskit/{assetPath}API catalog

HeadCanvaskitAsset

transportHeadCanvaskitAsset

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`assetPath` · required	path	string
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/icons/{assetPath}API catalog

ReadIconsAsset

transportReadIconsAsset

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`assetPath` · required	path	string
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/icons/{assetPath}API catalog

HeadIconsAsset

transportHeadIconsAsset

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`assetPath` · required	path	string
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/packages/{assetPath}API catalog

ReadPackagesAsset

transportReadPackagesAsset

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`assetPath` · required	path	string
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/packages/{assetPath}API catalog

HeadPackagesAsset

transportHeadPackagesAsset

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`assetPath` · required	path	string
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/supportAPI catalog

Redirect public support document

transportReadSupportRedirect

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string

Responses

308 Permanent public-document redirect

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/supportAPI catalog

Redirect public support document

transportHeadSupportRedirect

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string

Responses

308 Permanent public-document redirect

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/privacyAPI catalog

Redirect public privacy document

transportReadPrivacyRedirect

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string

Responses

308 Permanent public-document redirect

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/privacyAPI catalog

Redirect public privacy document

transportHeadPrivacyRedirect

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string

Responses

308 Permanent public-document redirect

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/delete-accountAPI catalog

Redirect public delete-account document

transportReadDeleteAccountRedirect

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string

Responses

308 Permanent public-document redirect

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/delete-accountAPI catalog

Redirect public delete-account document

transportHeadDeleteAccountRedirect

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`Origin`	header	string

Responses

308 Permanent public-document redirect

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

OPTIONS/{path}API catalog

Global HTTP OPTIONS

transportPreflightAnyPath

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`path` · required	path	string
`Origin`	header	string
`Access-Control-Request-Method`	header	string
`Access-Control-Request-Headers`	header	string

Responses

204 No content; preflight returned before authentication or route dispatch

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

GET/viewer-assets/{assetPath}API catalog

Read opt-in TypeScript viewer asset

transportReadViewerAsset

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`assetPath` · required	path	string
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.

HEAD/viewer-assets/{assetPath}API catalog

Read opt-in TypeScript viewer asset metadata

transportHeadViewerAsset

Security: Guest / no credential declared. Current domain permissions still apply.

Parameters

Name	Location	Type
`assetPath` · required	path	string
`Origin`	header	string
`Range`	header	string
`If-None-Match`	header	string
`If-Modified-Since`	header	string

Responses

200 Successful transport response
404 NOT_FOUND: File not found for resolved path outside webRoot; Web viewer unavailable when readFile fails. Error contains no filesystem path.
500 Internal service failure

Complete request bodies, schema constraints and transport headers are in the versioned OpenAPI document.