OpenPost Voice Profiles API
The Voice Profiles API from OpenPost — 5 operation(s) for voice profiles.
The Voice Profiles API from OpenPost — 5 operation(s) for voice profiles.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/openpo-st:openpo-st-voice-profiles-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
contact:
email: hello@openpo.st
name: OpenPost support
url: https://openpo.st/contact
description: OpenPost HTTP API for workspace-scoped social publishing. Use it to inspect accounts and provider readiness, manage media and publications, schedule work, and read publishing results. Every operation still follows token scopes, workspace roles, plan limits, provider capabilities, and destination validation.
license:
identifier: AGPL-3.0-only
name: AGPL-3.0-only
termsOfService: https://openpo.st/terms
title: OpenPost Voice Profiles API
version: 1.0.0
servers:
- description: OpenPost Hosted service
url: https://app.openpo.st/api/v1
- description: The OpenPost instance serving this contract
url: /api/v1
security:
- bearerAuth: []
- sessionCookie: []
tags:
- name: Voice Profiles
paths:
/voice-profile-assignments/{account_id}:
put:
description: An empty profile ID restores Workspace inheritance.
operationId: assign-account-voice-profile
parameters:
- description: Connected social account ID
in: path
name: account_id
required: true
schema:
description: Connected social account ID
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssignVoiceProfileInputBody'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EffectiveProfile'
description: OK
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'403':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Forbidden
'404':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Not Found
'422':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Unprocessable Entity
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Internal Server Error
'503':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Service Unavailable
summary: Set an account Voice Profile override
tags:
- Voice Profiles
/voice-profiles:
get:
operationId: list-voice-profiles
parameters:
- description: Workspace ID
explode: false
in: query
name: workspace_id
required: true
schema:
description: Workspace ID
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/VoiceProfile'
type:
- array
- 'null'
description: OK
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'403':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Forbidden
'422':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Unprocessable Entity
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Internal Server Error
'503':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Service Unavailable
summary: List Voice Profiles
tags:
- Voice Profiles
x-openpost-automation:
access: read
effect: query
exposure: alpha
idempotency: none
retry: transient
selectors:
- label_path: name
operation_id: list-workspaces
parameter: workspace_id
value_path: id
post:
operationId: create-voice-profile
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVoiceProfileInputBody'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceProfile'
description: OK
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'403':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Forbidden
'409':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Conflict
'422':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Unprocessable Entity
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Internal Server Error
'503':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Service Unavailable
summary: Create a Voice Profile
tags:
- Voice Profiles
/voice-profiles/effective:
post:
description: Resolves Publication override, account override, then Workspace default in that order.
operationId: resolve-effective-voice-profiles
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResolveEffectiveVoiceProfilesInputBody'
required: true
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/EffectiveProfile'
type:
- array
- 'null'
description: OK
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'403':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Forbidden
'404':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Not Found
'409':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Conflict
'422':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Unprocessable Entity
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Internal Server Error
'503':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Service Unavailable
summary: Resolve effective Voice Profiles
tags:
- Voice Profiles
x-openpost-automation:
access: read
effect: query
exposure: alpha
idempotency: none
retry: transient
selectors:
- label_path: name
operation_id: list-workspaces
parameter: workspace_id
value_path: id
/voice-profiles/{id}:
delete:
description: The Workspace default cannot be deleted. Assigned accounts return to Workspace inheritance.
operationId: delete-voice-profile
parameters:
- description: Voice Profile ID
in: path
name: id
required: true
schema:
description: Voice Profile ID
type: string
- description: Workspace ID
explode: false
in: query
name: workspace_id
required: true
schema:
description: Workspace ID
type: string
- description: Revision loaded by the editor
explode: false
in: query
name: expected_revision
schema:
description: Revision loaded by the editor
format: int64
minimum: 1
type: integer
- description: Explicit deletion confirmation
explode: false
in: query
name: confirm
schema:
description: Explicit deletion confirmation
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteVoiceProfileOutputBody'
description: OK
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'403':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Forbidden
'404':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Not Found
'409':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Conflict
'422':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Unprocessable Entity
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Internal Server Error
'503':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Service Unavailable
summary: Delete a Voice Profile
tags:
- Voice Profiles
get:
operationId: get-voice-profile
parameters:
- description: Voice Profile ID
in: path
name: id
required: true
schema:
description: Voice Profile ID
type: string
- description: Workspace ID
explode: false
in: query
name: workspace_id
required: true
schema:
description: Workspace ID
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceProfile'
description: OK
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'403':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Forbidden
'404':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Not Found
'422':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Unprocessable Entity
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Internal Server Error
'503':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Service Unavailable
summary: Get a Voice Profile
tags:
- Voice Profiles
x-openpost-automation:
access: read
effect: query
exposure: alpha
idempotency: none
retry: transient
selectors:
- label_path: name
operation_id: list-workspaces
parameter: workspace_id
value_path: id
put:
operationId: update-voice-profile
parameters:
- description: Voice Profile ID
in: path
name: id
required: true
schema:
description: Voice Profile ID
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateVoiceProfileInputBody'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceProfile'
description: OK
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'403':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Forbidden
'404':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Not Found
'409':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Conflict
'422':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Unprocessable Entity
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Internal Server Error
'503':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Service Unavailable
summary: Replace a Voice Profile
tags:
- Voice Profiles
/voice-profiles/{id}/default:
post:
operationId: set-default-voice-profile
parameters:
- description: Voice Profile ID
in: path
name: id
required: true
schema:
description: Voice Profile ID
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SetDefaultVoiceProfileInputBody'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceProfile'
description: OK
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'403':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Forbidden
'404':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Not Found
'409':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Conflict
'422':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Unprocessable Entity
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Internal Server Error
'503':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Service Unavailable
summary: Set the Workspace default Voice Profile
tags:
- Voice Profiles
components:
schemas:
Example:
additionalProperties: false
properties:
platform:
description: Optional source platform, used as provenance rather than a style rule
type: string
text:
description: Representative text
type: string
why_it_fits:
description: Why this example represents the voice
type: string
required:
- text
type: object
AssignVoiceProfileInputBody:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/AssignVoiceProfileInputBody.json
format: uri
readOnly: true
type: string
voice_profile_id:
description: Voice Profile override; empty restores Workspace inheritance
type: string
workspace_id:
description: Workspace ID
type: string
required:
- workspace_id
type: object
ErrorModel:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/ErrorModel.json
format: uri
readOnly: true
type: string
detail:
description: A human-readable explanation specific to this occurrence of the problem.
examples:
- Property foo is required but is missing.
type: string
errors:
description: Optional list of individual error details
items:
$ref: '#/components/schemas/ErrorDetail'
type:
- array
- 'null'
instance:
description: A URI reference that identifies the specific occurrence of the problem.
examples:
- https://example.com/error-log/abc123
format: uri
type: string
status:
description: HTTP status code
examples:
- 400
format: int64
type: integer
title:
description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
examples:
- Bad Request
type: string
type:
default: about:blank
description: A URI reference to human-readable documentation for the error.
examples:
- https://example.com/errors/example
format: uri
type: string
type: object
CreateVoiceProfileInputBody:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/CreateVoiceProfileInputBody.json
format: uri
readOnly: true
type: string
definition:
$ref: '#/components/schemas/Definition'
description: Identity facts and representative writing
is_default:
description: Make this the Workspace default
type: boolean
name:
description: Reusable Voice Profile name
maxLength: 80
minLength: 1
type: string
workspace_id:
description: Workspace ID
type: string
required:
- workspace_id
- name
- definition
type: object
VoiceProfile:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/VoiceProfile.json
format: uri
readOnly: true
type: string
assigned_account_ids:
items:
type: string
type:
- array
- 'null'
created_at:
format: date-time
type: string
definition:
$ref: '#/components/schemas/Definition'
id:
type: string
is_default:
type: boolean
name:
type: string
revision:
format: int64
type: integer
schema_version:
format: int64
type: integer
updated_at:
format: date-time
type: string
workspace_id:
type: string
required:
- id
- workspace_id
- name
- is_default
- revision
- schema_version
- definition
- assigned_account_ids
- created_at
- updated_at
type: object
Correction:
additionalProperties: false
properties:
lesson:
description: Optional general lesson from the edit
type: string
original:
description: Generated or draft wording that did not fit
type: string
preferred:
description: Accepted replacement wording
type: string
required:
- original
- preferred
type: object
Definition:
additionalProperties: false
properties:
boundaries:
description: Tone or identity boundaries
items:
type: string
type:
- array
- 'null'
corrections:
description: Accepted edits that explain how the voice should change a draft
items:
$ref: '#/components/schemas/Correction'
type:
- array
- 'null'
disliked_patterns:
description: Writing patterns this voice avoids
items:
type: string
type:
- array
- 'null'
examples:
description: Representative writing examples
items:
$ref: '#/components/schemas/Example'
type:
- array
- 'null'
expertise:
description: Subjects the voice can discuss from experience
items:
type: string
type:
- array
- 'null'
forbidden_phrases:
description: Phrases this voice must not use
items:
type: string
type:
- array
- 'null'
formality:
description: Formality style and limits
type: string
humor:
description: Humor style and limits
type: string
identity_summary:
description: Short description of the person or brand behind the voice
type: string
interview_answers:
description: Optional answers used to learn opinions and phrasing
items:
$ref: '#/components/schemas/InterviewAnswer'
type:
- array
- 'null'
opinions:
description: Established views the builder may draw on
items:
type: string
type:
- array
- 'null'
preferred_language:
description: Language or locale this voice normally writes in
type: string
recurring_expressions:
description: Expressions that sound natural in this voice
items:
type: string
type:
- array
- 'null'
traits:
description: Stable voice traits
items:
type: string
type:
- array
- 'null'
vocabulary:
description: Words the voice naturally uses
items:
type: string
type:
- array
- 'null'
type: object
UpdateVoiceProfileInputBody:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/UpdateVoiceProfileInputBody.json
format: uri
readOnly: true
type: string
definition:
$ref: '#/components/schemas/Definition'
description: Replacement identity facts and representative writing
expected_revision:
description: Revision loaded by the editor
format: int64
minimum: 1
type: integer
name:
description: Reusable Voice Profile name
maxLength: 80
minLength: 1
type: string
workspace_id:
description: Workspace ID
type: string
required:
- workspace_id
- expected_revision
- name
- definition
type: object
ErrorDetail:
additionalProperties: false
properties:
location:
description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
type: string
message:
description: Error message text
type: string
value:
description: The value at the given location
type: object
InterviewAnswer:
additionalProperties: false
properties:
answer:
description: Answer in the profile owner's own words
type: string
question:
description: Interview question
type: string
required:
- question
- answer
type: object
DeleteVoiceProfileOutputBody:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/DeleteVoiceProfileOutputBody.json
format: uri
readOnly: true
type: string
deleted:
type: boolean
required:
- deleted
type: object
ResolveEffectiveVoiceProfilesInputBody:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/ResolveEffectiveVoiceProfilesInputBody.json
format: uri
readOnly: true
type: string
account_ids:
description: Connected account IDs in requested order
items:
type: string
maxItems: 100
minItems: 1
type:
- array
- 'null'
uniqueItems: true
publication_voice_profile_id:
description: Temporary Publication-level override
type: string
workspace_id:
description: Workspace ID
type: string
required:
- workspace_id
- account_ids
type: object
EffectiveProfile:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/EffectiveProfile.json
format: uri
readOnly: true
type: string
account_id:
type: string
profile:
$ref: '#/components/schemas/VoiceProfile'
source:
type: string
required:
- account_id
- source
- profile
type: object
SetDefaultVoiceProfileInputBody:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/SetDefaultVoiceProfileInputBody.json
format: uri
readOnly: true
type: string
expected_revision:
description: Revision loaded by the editor
format: int64
minimum: 1
type: integer
workspace_id:
description: Workspace ID
type: string
required:
- workspace_id
- expected_revision
type: object
securitySchemes:
bearerAuth:
bearerFormat: OpenPost API token or session JWT
scheme: bearer
type: http
sessionCookie:
in: cookie
name: openpost_session
type: apiKey