Parseable

API Reference


This section provides detailed information about the available API endpoints for interacting with Parseable.

Getting Started

Before you begin, make sure you have:

  • A running instance of Parseable
  • The base URL of your Parseable server
  • Required authentication credentials (if authentication is enabled)

API Endpoints

Authentication

API reference endpoints require authentication. The OpenAPI reference uses HTTP Basic authentication by default:

Authorization: Basic <base64-encoded-credentials>

If you use Parseable API keys, send the key in the X-API-Key header as described in the API Keys guide.

Rate Limiting

API requests are subject to rate limiting. The default rate limit is 100 requests per minute per IP address.

Error Handling

All error responses follow a standard format:

{
  "error": {
    "code": "error_code",
    "message": "Human-readable error message"
  }
}

Need Help?

If you have any questions or run into issues, please refer to our GitHub repository or join our community.

Was this page helpful?

On this page