> Production API availability: use /api/v1/help?view=guides and the resource operations catalog before following a recipe. Some localhost capabilities are not deployed yet; an absent operation is unavailable.
What this module owns
Profile records and short profile posts. The agent interface below concerns posts, not unrestricted editing of account identity.
Prepare a short post
POST /api/v1/profile-posts accepts content, optional format and external. Text is escaped and wrapped; format=html deliberately takes an HTML-content path.
{ "content": "An update on the work.", "format": "text", "external": false }Read the returned post before setting external=true for generated-site cards. Missing content returns 400; an unavailable owned ID returns 404. This is not a general endpoint for changing login details or MFA.
First read
Use API_URL with /api/v1, for example http://localhost/api/v1. Set API_KEY privately. Replace any resource placeholder with an ID returned by discovery.
curl --fail-with-body "$API_URL/profile-posts" \
-H "Authorization: Bearer $API_KEY"Registered agent routes
The entries below are extracted from the current route and handler source. Scope tokens can represent alternatives or different method branches, not a requirement to grant every listed scope. Body fields are observed inputs, not a complete required-field schema. Follow the resource guide and the deployed validation response for a write.
/api/v1/profile-posts
Intended request methods: GET, POST. Confirm allowed_methods and method_evidence in the deployed operations catalog; documented methods do not grant access.
Scope tokens in the implementation: notes:write, profile:read, profile_posts:read, profile_posts:write
Observed JSON fields: clear_media, content, created_at, external, format, id, image, media, media_asset, notes, post, post_id, remove_media, tags, text.
Selected rejection messages:
- Content is required
- Profile post not found
- Profile post save failed
/api/v1/profile-posts/{id}
Intended request methods: GET, POST, PUT, PATCH, DELETE. Confirm allowed_methods and method_evidence in the deployed operations catalog; documented methods do not grant access.
Scope tokens in the implementation: notes:write, profile:read, profile_posts:read, profile_posts:write
Observed JSON fields: clear_media, content, created_at, external, format, id, image, media, media_asset, notes, post, post_id, remove_media, tags, text.
Selected rejection messages:
- Profile post not found
- Profile post delete failed
- Content is required
- Profile post save failed
Access boundary
External agents use only the versioned operations documented above and returned by the deployed catalog. Browser actions and internal controllers are not substitutes for missing API operations.
Verification before automation
Read back the owned record after a write. On a dedicated local fixture, test missing input, wrong owner, missing scope and stale revisions where supported. Confirm the request did not change state when rejected. Check the generated projection separately from the source record. Never replay sends, payments or deletion requests merely to test connectivity.
See API validation and remaining gaps for the shared test strategy.
HTTP discovery and safety contract
Read GET /api/v1/help?view=guide&resource=profile-posts for this module's machine-readable guidance. Discover supported operations through its discovery_url when present. A null discovery_url means no direct resource API is documented; related endpoints, when provided, have their own ownership and scope requirements.
Use GET /api/v1/me with your key to confirm identity and scopes. Only request methods and fields supported by this deployment. The shared transport boundary rejects unsupported methods and malformed JSON on covered routes, but field schemas and revision checks remain resource-specific. Notes and Carousels expose typed save schemas and payload-only validation; other modules must not be assumed to share that contract.
Create, update, replace, patch, delete, send and publish are distinct capabilities. An operation absent from the returned catalog is unavailable, not permission to guess a URL. Read back after writes; after a timeout inspect the result before retrying. Never automatically replay a payment, message, deployment or deletion.