Requests and responses

Requests

Every endpoint lives at:

https://api.perceptlayer.com/v1/{api}/{endpoint}

GET endpoints take parameters in the query string. List parameters repeat, as in ?ids[]=1&ids[]=2.
POST endpoints take a JSON body. Send Content-Type: application/json.
Unknown parameters are ignored. Invalid ones are rejected with 422 invalid_parameters before anything is charged.
Some sources are slower than others. Allow up to 60 seconds per call; after that the call fails with 504 timeout, free.

Each endpoint’s page in the API reference lists its parameters, which are required, and their limits.

Successful calls return the data as JSON with no wrapper. Metadata travels in headers, and the credit and rate-limit headers are on errors too.

Header	Meaning
`X-Request-Id`	Unique ID for the call. Quote it when you contact support.
`X-Credits-Used`	Credits this call cost. Always 0 for errors.
`X-Credits-Remaining`	Your balance after the call. Errors report it too.
`RateLimit-Limit`	Requests your account can make per minute.
`RateLimit-Remaining`	Requests left in the current minute.
`RateLimit-Reset`	Seconds until the current minute’s count resets.
`RateLimit-Policy`	The limit and its window, as in `300;w=60`.

Errors have their own shape. See Errors.