invalid_params
  1. Docs
  2. Errors
  3. invalid_params

invalid_params

A parameter is missing, unknown or has the wrong type.

Response

Every failure uses this envelope. credits_charged is 0. The message below is the default text for this code. Live messages can change, so branch on error.code.

SampleHTTP 400
1{2  "ok": false,3  "error": {4    "code": "invalid_params",5    "message": "A parameter is missing, unknown or has the wrong type.",6    "retryable": false7  },8  "credits_charged": 0,9  "request_id": "req_0123456789abcdef01234567"10}

error.retryable is false. The same request fails the same way.

When it happens

  • The message names the parameter.

What to do

  • Check that name against the parameters on the endpoint page, then send the request again.
  • Do not retry the same body. It fails the same way.

The response header x-request-id matches request_id. The full list is on errors.