API Overview

Base URL

All API requests should be made to the following base URL:

https://api.getpronto.io/v1

The API is versioned through the URL path. The current version is v1.

Authentication

Get Pronto uses API keys to authenticate requests. You must include your API key in the headers of all API requests. For detailed information about obtaining and managing API keys, see our Authentication guide.

curl https://api.getpronto.io/v1/files \
  -H "ApiKey: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Request/Response Format

The API accepts and returns JSON data. Always include the following headers in your requests:

{
  "ApiKey": "YOUR_API_KEY",
  "Content-Type": "application/json",
  "Accept": "application/json"
}

Response Structure

Successful responses follow a standard format that includes the requested data and, where applicable, pagination information:

{
  "data": {
    // Resource-specific data
  },
  "status": 200,
  "headers": {
    // Response headers
  }
}

Pagination

For endpoints that return lists of items, the response includes pagination information:

{
  "files": [
    // Array of items
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "totalCount": 135,
    "totalPages": 7
  }
}

Error Handling

Get Pronto uses conventional HTTP response codes to indicate the success or failure of API requests. In general:

• 2xx indicates success
• 4xx indicates an error that failed given the information provided
• 5xx indicates an error with Get Pronto's servers

Error Response Format

When an error occurs, you'll receive a JSON response with an error message:

{
  "message": "Detailed error message",
  "status": 400,
  "headers": {
    // Response headers
  }
}

Common Error Codes

Rate Limiting

To ensure stability and fair usage, Get Pronto implements rate limiting on API requests. Rate limit information is included in the response headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1577836800

If you exceed the rate limit, you'll receive a 429 Too Many Requests response. The response will include a Retry-After header indicating when you can resume making requests.