{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-apis/index.yaml","sidebar":"sidebar-sidebar.yaml__apis"},"props":{"definitionId":"apis/index.yaml","dynamicMarkdocComponents":[],"baseSlug":"/apis","seo":{"title":"Jeeves Public API"},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Jeeves Public API","description":"## Introduction\n\nThe Jeeves API is built around **REST** principles. Our API accepts **JSON-encoded** request bodies, returns **JSON-encoded** responses, and uses standard **HTTP** response codes.\n\n## Authentication\n\nThe Jeeves API uses **mTLS** and **OAuth 2.0** to authenticate requests. You can request your mTLS certificate and OAuth 2.0 credentials in both sandbox and production environments by reaching out to our support team.\n\n**All API requests will only work over HTTPS.** Calls made over plain HTTP will fail. API requests without authentication will also fail.\n\n## Errors\n\nThe Jeeves API uses standard **HTTP** response codes to indicate the success or failure of an API request. In general: codes in the **2XX** range indicate success; codes in the **4XX** range indicate an error in the information provided; codes in the **5XX** range indicate an internal error with Jeeves application/server.\n\nCurrently, the Jeeves API has the following HTTP responses:\n\n| Code | Response | Description |\n|:-----|:---------|:------------|\n| 200  | Ok       | Object was returned as expected. |\n| 201  | Ok       | Object was created as expected. |\n| 204  | Ok       | No return, but request was processed as expected. |\n| 400  | Bad request | At least one argument is wrong or missing. |\n| 401  | Unauthorized | No valid API token provided. |\n| 403  | Forbidden | The API token doesn't have permission to perform the request. |\n| 404  | Not found | The requested resource doesn't exist. |\n| 500  | Server error | An internal error at Jeeves. |\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"headers":{"accept":"*/*","accept-encoding":"br,gzip","host":"tryjeeves.redocly.app","user-agent":"Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)","via":"2.0 Caddy, 2.0 317e34db72356fbec872f4f5021e4c9c.cloudfront.net (CloudFront), 1.1 Caddy","x-amz-cf-id":"IyIo7J9r5kYHKWcO0DxlfATVxAMwN1PHzEG71ivLA8433wCrMoheIQ==","x-forwarded-for":"216.73.216.239, 54.156.60.142, 64.252.66.139","x-forwarded-host":"tryjeeves.redocly.app","x-forwarded-proto":"https","x-request-id":"cds-29f81322-ae3b-4e61-98de-301be012b5a2"},"remoteAddr":{"hostname":"::ffff:10.0.3.125","port":40096},"lang":"en"}},"pagePropGetterError":{"message":"","name":""}},"slug":"/apis","userData":{"isAuthenticated":false,"teams":["anonymous"]}}