Skip to content
MoreVoiceDevelopers

Get the Postman collection

GET
/postman.json
import MoreVoice from "@morevoice/sdk";


const mv = new MoreVoice(); // MOREVOICE_API_KEY from the environment


const openapi = await mv.openapi.postman();
console.log(openapi);

This API as a Postman collection (v2.1): one folder per resource, example bodies, Bearer {{api_key}}. Import it, or use the Run in Postman button in the docs. No API key needed.

Try it in the API playground with a test-mode key.

Responses

Section titled “Responses”

200

Section titled “200”

The Postman collection.

Media typeapplication/json

A Postman collection (v2.1) of this API.

object
info
required
object
name
required
string
schema
required
string
key
additional properties
item
required
Array
key
additional properties
Example
{
  "info": {
    "name": "MoreVoice API",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "item": []
}

304

Section titled “304”

Not modified

500

Section titled “500”

Something went wrong on MoreVoice’s side. Retry with the same Idempotency-Key.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
  "error": {
    "code": "internal_error",
    "doc_url": "https://docs.morevoice.ai/api/errors#internal-error",
    "message": "Something went wrong on MoreVoice's side.",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "api_error"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.