The SpeedCurve API is based on REST: it is comprised of resources with predictable urls and utilises standard HTTP features (like HTTP Basic Authentication, Response Codes and Methods). All requests, including errors, return JSON.
The base URI for the V1 API is:
Your API key is available on the Admin > Teams page. (Available for Org Admins only)
Please check our support doc for more details on managing API keys.
Basic Authentication over HTTPS is used to authenticate with the API. Your basic authentication username is your API key and the password can be set to anything. In our examples the API key is your-api-key and the password is x.
The easiest way to authenticate in the API is sending the following HTTP header with your request:
Authorization: Basic your-api-key-base-64-encoded
If you are getting status code 429 and error message
Too Many Attempts. it means you might have exceeded API limits, which are the following:
- for all API endpoints - maximum 3,000 requests per minute
- for trial accounts - total maximum 1,000 requests per day per account
- deploys - maximum 600 per 10 minutes per account
Error codes and troubleshooting
See Troubleshooting API page.