Getting access
API access is switched on per account, so the keys that let your pipeline convert masters are issued to people we have set up, not to anyone who signs up. Once your account is enabled you can have a working integration in an afternoon: keys come from your account page in a minute, and the first conversion runs from the quickstart.
Ask for access
Write to [email protected], tell us which Esfera account to use, what you want to convert and roughly how much, and we set up API access on that account.
If you do not have an Esfera account yet, create one first. API access attaches to an account.
What you get
- API keys on your account page at
esfera.audio/account/api. You can hold up to five active keys at once, so one service can rotate while another keeps working. - Keys for the environment you are set up on. Design partners start with test keys (
esf_sk_test_…) on staging athttps://staging-api.esfera.audio; live keys (esf_sk_live_…) for production athttps://api.esfera.audioare issued when the integration goes live. See Environments. - Minutes from your plan. Every conversion is metered by the duration of the source audio against your plan's allowance, and
GET /v1/usageshows what is left. - Webhooks, with up to three active endpoints per account.
Your first key
- Sign in at esfera.audio and open API keys. On staging the same page is at staging.esfera.audio.
- Create a key and give it a name that says what uses it, such as
render-farm. - Copy the secret now. It is shown once, and Esfera keeps only a hash of it.
- Put it in your secret store and pass it to your code as
ESFERA_API_KEY.
The command-line tool can also mint a key for you: esfera login opens your browser, you approve the sign-in, and the key is stored on your machine and listed on the same page as a CLI key.
If the page says API access is not enabled
The keys page shows an explanation instead of a list when the account has not been set up for the API. That is expected until we have enabled it. Write to us at the address above.