Preview: SendMock has no stable release yet. These docs follow develop.

API reference

Seed

GET/api/v1/seed/export

The current configuration as sendmock.seed.toml.

CLI
sendmock seed export
MCP tool
sendmock_seed_export
In the app
Settings > Seed > Export sendmock.seed.toml

Answer

200 string (application/toml)

Try it in Demo mode

POST/api/v1/seed/validate

Check a seed file without applying it.

CLI
sendmock seed validate <file>
MCP tool
sendmock_seed_validate
In the app
Settings > Seed > Validate

Request body (application/json)

SeedFileRequest : Body of POST /api/v1/seed/validate and /seed/apply.

FieldTypeDescription
seed_tomlstring
The seed file's text (sendmock.seed.toml).Example: [[numbers]] number = "+15550001111" label = "Support line"

Answer

200 SeedValidation

Try it in Demo mode

POST/api/v1/seed/apply

Apply a seed file; 422 with the errors when it is invalid.

CLI
sendmock seed apply <file>
MCP tool
sendmock_seed_apply
In the app
Settings > Seed > Apply a seed file

Request body (application/json)

SeedFileRequest : Body of POST /api/v1/seed/validate and /seed/apply.

FieldTypeDescription
seed_tomlstring
The seed file's text (sendmock.seed.toml).Example: [[numbers]] number = "+15550001111" label = "Support line"

Answer

200 SeedValidation

Errors: 422, as { error: { code, message } }

Try it in Demo mode