guide
POST/v1/tools/guide
Return the client guide in full, as Markdown: what the corpus is and what it cannot tell, how to read every field and band, what each call costs and spends, the recommended order of work, recipes for common questions and how to report results to your user. Free. Read it before you write code against the API, and whenever you are unsure how to read a field or what a call will cost.
Request
Responses
- 200
- 400
- 401
- 413
- 415
- 429
- 500
- 503
The tool's answer
Response Headers
The request's id: quote it when you write to Megido support
The request cannot be served as sent: bad_request, invalid_params
Response Headers
The request's id: quote it when you write to Megido support
No key, or a key the API does not take: unauthorised
Response Headers
The request's id: quote it when you write to Megido support
Bearer realm="megido": send an API key of your organization as a Bearer token
The body is larger than the API takes: bad_request
Response Headers
The request's id: quote it when you write to Megido support
The body is not sent as application/json: bad_request
Response Headers
The request's id: quote it when you write to Megido support
Too many calls: rate_limited
Response Headers
The request's id: quote it when you write to Megido support
Seconds to wait before calling again; sent with rate_limited and lock_timeout only
The call failed on Megido's side: internal_error
Response Headers
The request's id: quote it when you write to Megido support
Not available just now: service_unavailable, lock_timeout
Response Headers
The request's id: quote it when you write to Megido support
Seconds to wait before calling again; sent with rate_limited and lock_timeout only