Creates a new agent in your account. After creation, the response includes theDocumentation Index
Fetch the complete documentation index at: https://docs.masker.dev/llms.txt
Use this file to discover all available pages before exploring further.
proxy_url and webhook_url for the agent — these are the two URLs you configure in your voice platform (e.g. Vapi’s custom LLM URL and server URL fields). The agent is immediately active once created.
Endpoint
masker_session authentication.
Request body
Display name for the agent. Must be unique within your account. 1–64 characters.
Upstream LLM provider and model. Accepted values:
openai:gpt-4o-mini, openai:gpt-4o, stub (for testing).Tokenization scheme to use for PHI replacement tokens.
vault-deterministic produces consistent tokens for the same input value (useful for de-duplication and audit correlation). reversible-aead produces encrypted tokens that are reversible without a vault lookup.Name of an existing masking policy to apply. Mutually exclusive with
policy_yaml. Defaults to healthcare-default.Inline YAML definition of a custom masking policy. Mutually exclusive with
policy_name. The YAML is validated before the agent is created; an invalid policy returns 422.Response fields
On success the API returns201 Created with the full agent object.
The newly created agent.
Example
Response (201 Created)
Errors
| Status | Code | Meaning |
|---|---|---|
401 | unauthenticated | Missing or invalid masker_session cookie |
409 | name_taken | An agent with this name already exists in your account |
422 | validation_failed | Request body failed validation; see details in the error response |
422 | unknown_upstream | The upstream value does not match a configured provider |
422 | unknown_policy | The policy_name does not exist |
422 | policy_yaml_invalid | The inline policy_yaml failed schema validation |